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.
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_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.
89
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.
98
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 |
184
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
165
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
sli_zigbee_af_zll_flags#
uint16_t sli_zigbee_af_zll_flags
166
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
167
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
Macro Definition Documentation#
touchLinkInProgress#
#define touchLinkInProgressValue:
202
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
scanForTouchLink#
#define scanForTouchLinkValue:
()
208
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
scanForDeviceInformation#
#define scanForDeviceInformationValue:
()
209
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
scanForIdentify#
#define scanForIdentifyValue:
()
210
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
scanForReset#
#define scanForResetValue:
()
211
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
targetNetworkFound#
#define targetNetworkFoundValue:
()
212
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
abortingTouchLink#
#define abortingTouchLinkValue:
()
213
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
scanComplete#
#define scanCompleteValue:
()
214
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
touchLinkTarget#
#define touchLinkTargetValue:
()
215
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
formingNetwork#
#define formingNetworkValue:
()
216
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
resettingToFactoryNew#
#define resettingToFactoryNewValue:
()
217
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
ZLL_FRAME_CONTROL_LEGACY#
#define ZLL_FRAME_CONTROL_LEGACYValue:
0x00
223
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
ZLL_FRAME_CONTROL_CLIENT_TO_SERVER#
#define ZLL_FRAME_CONTROL_CLIENT_TO_SERVERValue:
0x11
224
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
ZLL_FRAME_CONTROL_SERVER_TO_CLIENT#
#define ZLL_FRAME_CONTROL_SERVER_TO_CLIENTValue:
0x19
225
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
ZLL_HEADER_FRAME_CONTROL_OFFSET#
#define ZLL_HEADER_FRAME_CONTROL_OFFSETValue:
0
227
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
ZLL_HEADER_SEQUENCE_NUMBER_OFFSET#
#define ZLL_HEADER_SEQUENCE_NUMBER_OFFSETValue:
1
228
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
ZLL_HEADER_COMMAND_ID_OFFSET#
#define ZLL_HEADER_COMMAND_ID_OFFSETValue:
2
229
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
ZLL_HEADER_TRANSACTION_ID_OFFSET#
#define ZLL_HEADER_TRANSACTION_ID_OFFSETValue:
3
230
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
ZLL_HEADER_OVERHEAD#
#define ZLL_HEADER_OVERHEADValue:
7
231
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
debugPrintln#
#define debugPrintln
240
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
debugPrint#
#define debugPrint
241
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
debugExec#
#define debugExec
242
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
sl_zigbee_af_zll_commissioning_initial_security_state_cb#
#define sl_zigbee_af_zll_commissioning_initial_security_state_cbValue:
sl_zigbee_af_zll_commissioning_common_initial_security_state_cb
246
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
sl_zigbee_af_zll_commissioning_touch_link_complete_cb#
#define sl_zigbee_af_zll_commissioning_touch_link_complete_cbValue:
sl_zigbee_af_zll_commissioning_common_touch_link_complete_cb
248
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
sl_zigbee_af_zll_commissioning_reset_to_factory_new_cb#
#define sl_zigbee_af_zll_commissioning_reset_to_factory_new_cbValue:
sl_zigbee_af_zll_commissioning_common_reset_to_factory_new_cb
250
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h