ZLL Commissioning Common#
API and Callbacks for the ZLL Commissioning Common Component.
Common code for the ZigBee 3.0 touchlink commissioning mechanism. This component is required for both server and client side implementations.
Modules#
API#
Generate a random network key and initializes the security state of the device.
Indicate whether a touch link procedure is currently in progress.
Reset the local device to a factory new state.
Unsets the factory new status for a Zigbee device.
Disable touchlink processing.
Enable touchlink processing.
Enumerations#
Variables#
Macros#
API Documentation#
sl_zigbee_af_zll_set_initial_security_state#
sl_status_t sl_zigbee_af_zll_set_initial_security_state (void )
Generate a random network key and initializes the security state of the device.
N/A |
This function is a convenience wrapper for sl_zigbee_zll_set_initial_security_state, which must be called before starting or joining a network. The plugin initializes the security state for the initiator during touch linking. The target must initialize its own security state prior to forming a network either by using this function or by calling sl_zigbee_zll_set_initial_security_state directly.
Returns
An ::sl_status_t value that indicates the success or failure of the command.
66
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
sl_zigbee_af_zll_touch_link_in_progress#
bool sl_zigbee_af_zll_touch_link_in_progress (void )
Indicate whether a touch link procedure is currently in progress.
N/A |
Returns
True if a touch link is in progress or false otherwise.
72
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
sl_zigbee_af_zll_reset_to_factory_new#
void sl_zigbee_af_zll_reset_to_factory_new (void )
Reset the local device to a factory new state.
N/A |
This function causes the device to leave the network and clear its network parameters, resets its attributes to their default values, and clears the group and scene tables.
80
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
sl_zigbee_af_zll_unset_factory_new#
void sl_zigbee_af_zll_unset_factory_new (void )
Unsets the factory new status for a Zigbee device.
N/A |
This function is used to clear the factory new status of a Zigbee device, indicating that the device has been previously commissioned and is no longer in its factory default state.
89
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
sl_zigbee_af_zll_disable#
sl_status_t sl_zigbee_af_zll_disable (void )
Disable touchlink processing.
N/A |
This function will cause the device to refuse network start/join requests if it receives them and will not allow touchlinking. Note that this will have the effect of overriding the sl_zigbee_af_zll_no_touchlink_for_nfn function.
98
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
sl_zigbee_af_zll_enable#
sl_status_t sl_zigbee_af_zll_enable (void )
Enable touchlink processing.
N/A |
This function will cause the device to accept network start/join requests if it receives them and will not allow touchlinking. Note that this will have the effect of overriding the sl_zigbee_af_zll_no_touchlink_for_nfn function.
107
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
Enumeration Documentation#
StateEnum#
StateEnum
Enumerator | |
---|---|
INITIAL | |
SCAN_FOR_TOUCH_LINK | |
SCAN_FOR_DEVICE_INFORMATION | |
SCAN_FOR_IDENTIFY | |
SCAN_FOR_RESET | |
TARGET_NETWORK_FOUND | |
ABORTING_TOUCH_LINK | |
SCAN_COMPLETE | |
TOUCH_LINK_TARGET | |
FORMING_NETWORK | |
RESETTING_TO_FACTORY_NEW |
193
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
Variable Documentation#
sli_zigbee_af_zll_network#
sl_zigbee_zll_network_t sli_zigbee_af_zll_network
174
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
sli_zigbee_af_zll_flags#
uint16_t sli_zigbee_af_zll_flags
175
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
sli_zigbee_af_initiator_rejoin_retry_count#
uint8_t sli_zigbee_af_initiator_rejoin_retry_count
176
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h