Ember ZigBee Light Link (ZLL) APIs and Handlers#

sl_zigbee_zll_form_network#

sl_status_t sl_zigbee_zll_form_network (sl_zigbee_zll_network_t * networkInfo, int8_t radioTxPower)

Set the device type as a router or end device (depending on the passed nodeType) and set up a distributed commissioning network with the passed parameters. If panId is 0xFFFF, a random PAN ID will be generated. If extendedPanId is set to all F's, a random extended PAN ID will be generated. If channel is 0xFF, channel 11 will be used. If all F values are passed for PAN ID or Extended PAN ID, the randomly generated values will be returned in the passed structure.

Returns

• An ::sl_status_t value indicating whether the operation succeeded or why it failed.

sl_zigbee_zll_join_target#

sl_status_t sl_zigbee_zll_join_target (const sl_zigbee_zll_network_t * targetNetworkInfo)

Cause the device to send a NWK start or join to the target device, which causes the remote AND local device to start operating on a network together. If the local device is a factory new end device, it will send a touchlink NWK start to the target requesting that the target generate new network parameters. If the local device is a router, it will form a new touchlink network itself. If the device is not factory new, the local device will send a NWK join request using the current network parameters.

Returns

• An ::sl_status_t value indicating whether the operation succeeded or why it failed.

sl_zigbee_zll_set_security_state_without_key#

sl_status_t sl_zigbee_zll_set_security_state_without_key (const sl_zigbee_zll_initial_security_state_t * securityState)

Update the touchlink security token information. Unlike sl_zigbee_zll_set_initial_security_state, this can be called while a network is already established.

Returns

• An ::sl_status_t value indicating whether the operation succeeded or why it failed.

sl_zigbee_zll_set_initial_security_state#

sl_status_t sl_zigbee_zll_set_initial_security_state (const sl_zigbee_key_data_t * networkKey, const sl_zigbee_zll_initial_security_state_t * securityState)

Cause the device to set up the security information used in its network. Must be called prior to forming, starting, or joining a network.

Returns

• An ::sl_status_t value indicating whether the operation succeeded or why it failed.

sl_zigbee_zll_start_scan#

sl_status_t sl_zigbee_zll_start_scan (uint32_t channelMask, int8_t radioPowerForScan, sl_zigbee_node_type_t nodeType)

Initiate a touchlink network scan on all the specified channels. Results will be returned in sl_zigbee_zll_network_found_handler().

Returns

• An ::sl_status_t value indicating whether the operation succeeded or why it failed.

sl_zigbee_zll_set_rx_on_when_idle#

sl_status_t sl_zigbee_zll_set_rx_on_when_idle (uint32_t durationMs)

Change the mode of the radio so that the receiver is on when the device is idle. This permits a touchlink target to receive incoming scan requests and an initiator to communicate with a target before the network is established. The idle mode will be set to 'Rx On' until either the duration expires or is set to zero, or unless sl_zigbee_zll_cancel_rx_on_when_idle is called.

Note that, if the device joins or attempts to join a network during this period, then the Stack will suspend the special touchlink radio idle mode, and the Stack's radio idle mode will revert to the joined default appropriate to the node type. If, however, the device leaves, or the join fails, then the touchlink radio idle mode will be resumed, provided that the duration timer has not expired.

Also note that a subsequent call to sl_zigbee_zll_set_rx_on_when_idle may only extend the (currently outstanding) 'Rx On' duration. If a shorter duration is required, (or if an indefinite duration is currently set) then sl_zigbee_zll_set_rx_on_when_idle must be called first with a duration of 0, in order to cancel the current touchlink radio idle mode.

Returns

• An ::sl_status_t value indicating whether the operation succeeded or why it failed. A return value of SL_STATUS_INVALID_STATE indicates that the special touchlink radio idle mode is active, but has been suspended by the Stack, because the device has joined a network, or is in the process of joining, or that an attempt was made to reduce the 'Rx On' duration without canceling the existing touchlink radio idle mode.

sl_zigbee_zll_cancel_rx_on_when_idle#

void sl_zigbee_zll_cancel_rx_on_when_idle (void )

Cancel the special touchlink radio idle mode immediately, without reverting the Stack's radio idle mode to its original setting.

sl_zigbee_zll_set_radio_idle_mode#

void sl_zigbee_zll_set_radio_idle_mode (sl_zigbee_radio_power_mode_t mode)

Set the default radio power mode directly (This is the radio state when the device is not actively transmitting, and may be either SL_ZIGBEE_RADIO_POWER_MODE_RX_ON or SL_ZIGBEE_RADIO_POWER_MODE_RX_OFF.)

sl_zigbee_zll_get_radio_idle_mode#

uint8_t sl_zigbee_zll_get_radio_idle_mode (void )

Get the default radio power mode.

Returns

• The current default radio power mode

sl_zigbee_zll_network_found_handler#

void sl_zigbee_zll_network_found_handler (sl_zigbee_zll_network_t * networkInfo, bool isDeviceInfoNull, sl_zigbee_zll_device_info_record_t * deviceInfo, sl_zigbee_rx_packet_info_t * packetInfo)

Called when a touchlink network scan finds a touchlinkable device, which may be joined on either a centralized or a distributed network, or may not be joined at all. The network information will be returned to the application for processing.

sl_zigbee_zll_scan_complete_handler#

void sl_zigbee_zll_scan_complete_handler (sl_status_t status)

Called when a touchlink network scan is complete.

sl_zigbee_zll_address_assignment_handler#

void sl_zigbee_zll_address_assignment_handler (sl_zigbee_zll_address_assignment_t * addressInfo, sl_zigbee_rx_packet_info_t * packetInfo)

Called when network and group addresses are assigned to a remote mode in a network start or network join request.

sl_zigbee_zll_touch_link_target_handler#

void sl_zigbee_zll_touch_link_target_handler (const sl_zigbee_zll_network_t * networkInfo)

Called when the device is a target of a touch link.

sl_zigbee_zll_get_token_stack_zll_data#

void sl_zigbee_zll_get_token_stack_zll_data (sl_zigbee_tok_type_stack_zll_data_t * token)

Read the touchlink stack data token.

sl_zigbee_zll_get_token_stack_zll_security#

void sl_zigbee_zll_get_token_stack_zll_security (sl_zigbee_tok_type_stack_zll_security_t * token)

Read the touchlink stack security token.

sl_zigbee_zll_get_tokens_stack_zll#

void sl_zigbee_zll_get_tokens_stack_zll (sl_zigbee_tok_type_stack_zll_data_t * data, sl_zigbee_tok_type_stack_zll_security_t * security)

Read both the touchlink stack data and security tokens.

sl_zigbee_zll_set_token_stack_zll_data#

void sl_zigbee_zll_set_token_stack_zll_data (sl_zigbee_tok_type_stack_zll_data_t * token)

Set the touchlink stack data token.

sl_zigbee_is_zll_network#

bool sl_zigbee_is_zll_network (void )

Return whether or not the network is a touchlink network, that is, a distributed network formed by touchlink commissioning, and supporting touchlink-compliant address and group id assignment.

sl_zigbee_zll_set_non_zll_network#

void sl_zigbee_zll_set_non_zll_network (void )

Alter the touchlink data token to reflect the fact that the network is non-touchlink-compliant.

sl_zigbee_zll_get_policy#

sl_zigbee_zll_policy_t sl_zigbee_zll_get_policy (void )

Get the policy that enables or disables touchlink processing and enable or disable stealing a non-factory-new device.

sl_zigbee_zll_set_policy#

sl_status_t sl_zigbee_zll_set_policy (sl_zigbee_zll_policy_t policy)

Set the policy to enable or disable touchlink processing, and enable or disable stealing a non-factory-new device.

sl_zigbee_set_zll_node_type#

void sl_zigbee_set_zll_node_type (sl_zigbee_node_type_t nodeType)

Set the default node type for a factory new device.

sl_zigbee_set_zll_additional_state#

void sl_zigbee_set_zll_additional_state (uint16_t mask)

Set additional capability bits in the touchlink state.

sl_zigbee_zll_operation_in_progress#

bool sl_zigbee_zll_operation_in_progress (void )

Indicate that a touchlink network operation is in progress, that is, a network start or a network join.

sl_zigbee_zll_rx_on_when_idle_get_active#

bool sl_zigbee_zll_rx_on_when_idle_get_active (void )

Indicate whether the special touchlink radio idle mode is active, i.e., whether the radio receiver will remain on when the device is not transmitting and when the device is not on a network.

sl_zigbee_get_zll_primary_channel_mask#

uint32_t sl_zigbee_get_zll_primary_channel_mask (void )

Get the primary touchlink channel mask.

Returns

• The touchlink primary channel mask.

sl_zigbee_get_zll_secondary_channel_mask#

uint32_t sl_zigbee_get_zll_secondary_channel_mask (void )

Get the secondary touchlink channel mask.

Returns

• The touchlink secondary channel mask.

sl_zigbee_set_zll_primary_channel_mask#

void sl_zigbee_set_zll_primary_channel_mask (uint32_t mask)

Set the primary touchlink channel mask.

sl_zigbee_set_zll_secondary_channel_mask#

void sl_zigbee_set_zll_secondary_channel_mask (uint32_t mask)

Set the secondary touchlink channel mask.

sl_zigbee_zll_clear_tokens#

void sl_zigbee_zll_clear_tokens (void )

Clear the ZLL stack tokens.

sl_zigbee_zll_scanning_complete#

void sl_zigbee_zll_scanning_complete (void )

Inform the API that all scanning is complete.