ZLL Commissioning Client#

API and Callbacks for the ZLL Commissioning Cluster Client Component.

Client side implementation of the ZigBee 3.0 touchlink commissioning mechanism.

Modules#

ZLL Commissioning

API#

sl_status_t

Initiate the touch link procedure.

sl_status_t

Initiate a touch link to retrieve information about a target device.

sl_status_t

Initiate a touch link to cause a target device to identify itself.

sl_status_t

Initiate a touch link for the purpose of resetting a target device.

void

Abort the touch link procedure.

API Documentation#

sl_zigbee_af_zll_initiate_touch_link#

sl_status_t sl_zigbee_af_zll_initiate_touch_link (void )

Initiate the touch link procedure.

Parameters
TypeDirectionArgument NameDescription
voidN/A

This function causes the stack to broadcast a series of ScanRequest commands via inter-PAN messaging. The plugin selects the target that sent a ScanResponse command with the strongest RSSI and attempts to link with it. If touch linking completes successfully, the plugin calls sl_zigbee_af_zll_commissioning_touch_link_complete_cb with information about the network and the target. If touch linking fails, the plugin calls sl_zigbee_af_zll_commissioning_touch_link_failed_cb.

Returns

  • An ::sl_status_t value that indicates the success or failure of the command.


sl_zigbee_af_zll_device_information_request#

sl_status_t sl_zigbee_af_zll_device_information_request (void )

Initiate a touch link to retrieve information about a target device.

Parameters
TypeDirectionArgument NameDescription
voidN/A

As with a traditional touch link, this function causes the stack to broadcast messages to discover a target device. When the target is selected (based on RSSI), the plugin will retrieve information about it by unicasting a series of DeviceInformationRequest commands via inter-PAN messaging. If the process completes successfully, the plugin calls sl_zigbee_af_zll_commissioning_touch_link_complete_cb with information about the target. If touch linking fails, the plugin calls sl_zigbee_af_zll_commissioning_touch_link_failed_cb.

Returns

  • An ::sl_status_t value that indicates the success or failure of the command.


sl_zigbee_af_zll_identify_request#

sl_status_t sl_zigbee_af_zll_identify_request (void )

Initiate a touch link to cause a target device to identify itself.

Parameters
TypeDirectionArgument NameDescription
voidN/A

As with a traditional touch link, this function causes the stack to broadcast messages to discover a target device. When the target is selected (based on RSSI), the plugin will cause it to identify itself by unicasting an IdentifyRequest command via inter-PAN messaging. If the process completes successfully, the plugin calls sl_zigbee_af_zll_commissioning_touch_link_complete_cb with information about the target. If touch linking fails, the plugin calls sl_zigbee_af_zll_commissioning_touch_link_failed_cb.

Returns

  • An ::sl_status_t value that indicates the success or failure of the command.


sl_zigbee_af_zll_reset_to_factory_new_request#

sl_status_t sl_zigbee_af_zll_reset_to_factory_new_request (void )

Initiate a touch link for the purpose of resetting a target device.

Parameters
TypeDirectionArgument NameDescription
voidN/A

As with a traditional touch link, this function causes the stack to broadcast messages to discover a target device. When the target is selected (based on RSSI), the plugin will reset it by unicasting a ResetToFactoryNewRequest command via inter-PAN messaging. If the process completes successfully, the plugin calls sl_zigbee_af_zll_commissioning_touch_link_complete_cb with information about the target. If touch linking fails, the plugin calls sl_zigbee_af_zll_commissioning_touch_link_failed_cb.

Returns

  • An ::sl_status_t value that indicates the success or failure of the command.


sl_zigbee_af_zll_abort_touch_link#

void sl_zigbee_af_zll_abort_touch_link (void )

Abort the touch link procedure.

Parameters
TypeDirectionArgument NameDescription
voidN/A

This function can be called to cancel the touch link procedure. This can be useful, for example, if the touch link target is incorrect.