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#
emberAfZllSetInitialSecurityState#
EmberStatus emberAfZllSetInitialSecurityState (void )
Generate a random network key and initializes the security state of the device.
N/A |
This function is a convenience wrapper for emberZllSetInitialSecurityState, 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 emberZllSetInitialSecurityState directly.
Returns
An EmberStatus value that indicates the success or failure of the command.
62
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
emberAfZllTouchLinkInProgress#
bool emberAfZllTouchLinkInProgress (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.
68
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
emberAfZllResetToFactoryNew#
void emberAfZllResetToFactoryNew (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.
76
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
emberAfZllDisable#
EmberStatus emberAfZllDisable (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 emberAfZllNoTouchlinkForNFN function.
85
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
emberAfZllEnable#
EmberStatus emberAfZllEnable (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 emberAfZllNoTouchlinkForNFN function.
94
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 |
180
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
Variable Documentation#
sli_zigbee_af_zll_network#
EmberZllNetwork sli_zigbee_af_zll_network
161
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
sli_zigbee_af_zll_flags#
uint16_t sli_zigbee_af_zll_flags
162
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
sli_zigbee_af_initiatorRejoinRetryCount#
uint8_t sli_zigbee_af_initiatorRejoinRetryCount
163
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
Macro Definition Documentation#
touchLinkInProgress#
#define touchLinkInProgressValue:
198
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
scanForTouchLink#
#define scanForTouchLinkValue:
()
204
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
scanForDeviceInformation#
#define scanForDeviceInformationValue:
()
205
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
scanForIdentify#
#define scanForIdentifyValue:
()
206
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
scanForReset#
#define scanForResetValue:
()
207
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
targetNetworkFound#
#define targetNetworkFoundValue:
()
208
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
abortingTouchLink#
#define abortingTouchLinkValue:
()
209
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
scanComplete#
#define scanCompleteValue:
()
210
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
touchLinkTarget#
#define touchLinkTargetValue:
()
211
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
formingNetwork#
#define formingNetworkValue:
()
212
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
resettingToFactoryNew#
#define resettingToFactoryNewValue:
()
213
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
ZLL_FRAME_CONTROL_LEGACY#
#define ZLL_FRAME_CONTROL_LEGACYValue:
0x00
219
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
220
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
221
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
ZLL_HEADER_FRAME_CONTROL_OFFSET#
#define ZLL_HEADER_FRAME_CONTROL_OFFSETValue:
0
223
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
ZLL_HEADER_SEQUENCE_NUMBER_OFFSET#
#define ZLL_HEADER_SEQUENCE_NUMBER_OFFSETValue:
1
224
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
ZLL_HEADER_COMMAND_ID_OFFSET#
#define ZLL_HEADER_COMMAND_ID_OFFSETValue:
2
225
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
ZLL_HEADER_TRANSACTION_ID_OFFSET#
#define ZLL_HEADER_TRANSACTION_ID_OFFSETValue:
3
226
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
ZLL_HEADER_OVERHEAD#
#define ZLL_HEADER_OVERHEADValue:
7
227
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
debugPrintln#
#define debugPrintln
236
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
debugPrint#
#define debugPrint
237
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
debugExec#
#define debugExec
238
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
emberAfPluginZllCommissioningInitialSecurityStateCallback#
#define emberAfPluginZllCommissioningInitialSecurityStateCallbackValue:
emberAfPluginZllCommissioningCommonInitialSecurityStateCallback
242
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
emberAfPluginZllCommissioningTouchLinkCompleteCallback#
#define emberAfPluginZllCommissioningTouchLinkCompleteCallbackValue:
emberAfPluginZllCommissioningCommonTouchLinkCompleteCallback
244
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
emberAfPluginZllCommissioningResetToFactoryNewCallback#
#define emberAfPluginZllCommissioningResetToFactoryNewCallbackValue:
emberAfPluginZllCommissioningCommonResetToFactoryNewCallback
246
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h