ZLL Frames#
Name: zllNetworkOps | ID: 0x00B2 |
|---|---|
Description: A consolidation of ZLL network operations with similar signatures; specifically, forming and joining networks or touch-linking. | |
Command Parameters: | |
sl_zigbee_zll_network_t networkInfo | Information about the network. |
sl_zigbee_ezsp_zll_network_operation_t op | Operation indicator. |
int8_t radioTxPower | Radio transmission power. |
Response Parameters: | |
sl_status_t status | An sl_status_t value indicating success or the reason for failure. |
Name: zllSetInitialSecurityState | ID: 0x00B3 |
|---|---|
Description: This call will cause the device to setup the security information used in its network. It must be called prior to forming, starting, or joining a network. | |
Command Parameters: | |
sl_zigbee_key_data_t networkKey | ZLL Network key. |
sl_zigbee_zll_initial_security_state_t securityState | Initial security state of the network. |
Response Parameters: | |
sl_status_t status | An sl_status_t value indicating success or the reason for failure. |
Name: zllSetSecurityStateWithoutKey | ID: 0x00CF |
|---|---|
Description: This call will update ZLL security token information. Unlike sli_zigbee_stack_zll_set_initial_security_state, this can be called while a network is already established. | |
Command Parameters: | |
sl_zigbee_zll_initial_security_state_t securityState | Security state of the network. |
Response Parameters: | |
sl_status_t status | An sl_status_t value indicating success or the reason for failure. |
Name: zllStartScan | ID: 0x00B4 |
|---|---|
Description: This call will initiate a ZLL network scan on all the specified channels. | |
Command Parameters: | |
uint32_t channelMask | The range of channels to scan. |
int8_t radioPowerForScan | The radio output power used for the scan requests. |
sl_zigbee_node_type_t nodeType | The node type of the local device. |
Response Parameters: | |
sl_status_t status | An sl_status_t value indicating success or the reason for failure. |
Name: zllSetRxOnWhenIdle | ID: 0x00B5 |
|---|---|
Description: This call will change the mode of the radio so that the receiver is on for a specified amount of time when the device is idle. | |
Command Parameters: | |
uint32_t durationMs | The duration in milliseconds to leave the radio on. |
Response Parameters: | |
sl_status_t status | An sl_status_t value indicating success or the reason for failure. |
Name: zllNetworkFoundHandler | ID: 0x00B6 |
|---|---|
Description: This call is fired when a ZLL network scan finds a ZLL network. | |
This frame is a response to the callback command. | |
Response Parameters: | |
sl_zigbee_zll_network_t networkInfo | Information about the network. |
bool isDeviceInfoNull | Used to interpret deviceInfo field. |
sl_zigbee_zll_device_info_record_t deviceInfo | Device specific information. |
sl_zigbee_rx_packet_info_t packetInfo | Information about the incoming packet received from this network. |
Name: zllScanCompleteHandler | ID: 0x00B7 |
|---|---|
Description: This call is fired when a ZLL network scan is complete. | |
This frame is a response to the callback command. | |
Response Parameters: | |
sl_status_t status | Status of the operation. |
Name: zllAddressAssignmentHandler | ID: 0x00B8 |
|---|---|
Description: This call is fired when network and group addresses are assigned to a remote mode in a network start or network join request. This frame is a response to the callback command. | |
Response Parameters: | |
sl_zigbee_zll_address_assignment_t addressInfo | Address assignment information. |
sl_zigbee_rx_packet_info_t packetInfo | Information about the incoming packet. |
Name: zllTouchLinkTargetHandler | ID: 0x00BB |
|---|---|
Description: This call is fired when the device is a target of a touch link. | |
This frame is a response to the callback command. | |
Response Parameters: | |
sl_zigbee_zll_network_t networkInfo | Information about the network. |
Name: zllGetTokens | ID: 0x00BC |
|---|---|
Description: Get the ZLL tokens. | |
Command Parameters: None | |
Response Parameters: | |
sl_zigbee_tok_type_stack_zll_data_t data | Data token return value. |
sl_zigbee_tok_type_stack_zll_security_t security | Security token return value. |
Name: zllSetDataToken | ID: 0x00BD |
|---|---|
Description: Set the ZLL data token. | |
Command Parameters: | |
sl_zigbee_tok_type_stack_zll_data_t data | Data token to be set. |
Response Parameters: None | |
Name: zllSetNonZllNetwork | ID: 0x00BF |
|---|---|
Description: Set the ZLL data token bitmask to reflect the ZLL network state. | |
Command Parameters: None | |
Response Parameters: None | |
Name: isZllNetwork | ID: 0x00BE |
|---|---|
Description: Is this a ZLL network? | |
Command Parameters: None | |
Response Parameters: | |
bool isZllNetwork | ZLL network? |
Name: zllSetRadioIdleMode | ID: 0x00D4 |
|---|---|
Description: This call sets the radio's default idle power mode. | |
Command Parameters: | |
sl_zigbee_radio_power_mode_t mode | The power mode to be set. |
Response Parameters: None | |
Name: zllGetRadioIdleMode | ID: 0x00BA |
|---|---|
Description: This call gets the radio's default idle power mode. | |
Command Parameters: None | |
Response Parameters: | |
uint8_t radioIdleMode | The current power mode. |
Name: setZllNodeType | ID: 0x00D5 |
|---|---|
Description: This call sets the default node type for a factory new ZLL device. | |
Command Parameters: | |
sl_zigbee_node_type_t nodeType | The node type to be set. |
Response Parameters: None | |
Name: setZllAdditionalState | ID: 0x00D6 |
|---|---|
Description: This call sets additional capability bits in the ZLL state. | |
Command Parameters: | |
uint16_t state | A mask with the bits to be set or cleared. |
Response Parameters: None | |
Name: zllOperationInProgress | ID: 0x00D7 |
|---|---|
Description: Is there a ZLL (Touchlink) operation in progress? | |
Command Parameters: None | |
Response Parameters: | |
bool zllOperationInProgress | ZLL operation in progress? |
Name: zllRxOnWhenIdleGetActive | ID: 0x00D8 |
|---|---|
Description: Is the ZLL radio on when idle mode is active? | |
Command Parameters: None | |
Response Parameters: | |
bool zllRxOnWhenIdleGetActive | ZLL radio on when idle mode is active? |
Name: zllScanningComplete | ID: 0x00F6 |
|---|---|
Description: Informs the ZLL API that application scanning is complete. | |
Command Parameters: None | |
Response Parameters: None | |
Name: getZllPrimaryChannelMask | ID: 0x00D9 |
|---|---|
Description: Get the primary ZLL (touchlink) channel mask. | |
Command Parameters: None | |
Response Parameters: | |
uint32_t zllPrimaryChannelMask | The primary ZLL channel mask |
Name: getZllSecondaryChannelMask | ID: 0x00DA |
|---|---|
? | Description: Get the secondary ZLL (touchlink) channel mask. |
Command Parameters: None | |
Response Parameters: | |
uint32_t zllSecondaryChannelMask | The secondary ZLL channel mask |
Name: setZllPrimaryChannelMask | ID: 0x00DB |
|---|---|
Description: Set the primary ZLL (touchlink) channel mask. | |
Command Parameters: | |
uint32_t zllPrimaryChannelMask | The primary ZLL channel mask |
Response Parameters: None | |
Name: setZllSecondaryChannelMask | ID: 0x00DC |
|---|---|
Description: Set the secondary ZLL (touchlink) channel mask. | |
Command Parameters: | |
uint32_t zllSecondaryChannelMask | The secondary ZLL channel mask |
Response Parameters: None | |
Name: zllClearTokens | ID: 0x0025 |
|---|---|
Description: Clear ZLL stack tokens. | |
Command Parameters: None | |
Response Parameters: None | |