Modules#
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.
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#
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.
71
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.
77
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.
85
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.
94
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.
103
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#
emAfZllNetwork#
EmberZllNetwork emAfZllNetwork
170
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
emAfZllFlags#
uint16_t emAfZllFlags
171
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
emAfInitiatorRejoinRetryCount#
uint8_t emAfInitiatorRejoinRetryCount
172
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
Macro Definition Documentation#
touchLinkInProgress#
#define touchLinkInProgressValue:
207
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
scanForTouchLink#
#define scanForTouchLinkValue:
()
213
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
scanForDeviceInformation#
#define scanForDeviceInformationValue:
()
214
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
scanForIdentify#
#define scanForIdentifyValue:
()
215
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
scanForReset#
#define scanForResetValue:
()
216
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
targetNetworkFound#
#define targetNetworkFoundValue:
()
217
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
abortingTouchLink#
#define abortingTouchLinkValue:
()
218
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
scanComplete#
#define scanCompleteValue:
()
219
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
touchLinkTarget#
#define touchLinkTargetValue:
()
220
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
formingNetwork#
#define formingNetworkValue:
()
221
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
resettingToFactoryNew#
#define resettingToFactoryNewValue:
()
222
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
ZLL_FRAME_CONTROL_LEGACY#
#define ZLL_FRAME_CONTROL_LEGACYValue:
0x00
228
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
229
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
230
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
ZLL_HEADER_FRAME_CONTROL_OFFSET#
#define ZLL_HEADER_FRAME_CONTROL_OFFSETValue:
0
232
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
ZLL_HEADER_SEQUENCE_NUMBER_OFFSET#
#define ZLL_HEADER_SEQUENCE_NUMBER_OFFSETValue:
1
233
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
ZLL_HEADER_COMMAND_ID_OFFSET#
#define ZLL_HEADER_COMMAND_ID_OFFSETValue:
2
234
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
ZLL_HEADER_TRANSACTION_ID_OFFSET#
#define ZLL_HEADER_TRANSACTION_ID_OFFSETValue:
3
235
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
ZLL_HEADER_OVERHEAD#
#define ZLL_HEADER_OVERHEADValue:
7
236
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
debugPrintln#
#define debugPrintln
245
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
debugPrint#
#define debugPrint
246
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
debugExec#
#define debugExec
247
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
emberAfPluginZllCommissioningInitialSecurityStateCallback#
#define emberAfPluginZllCommissioningInitialSecurityStateCallbackValue:
emberAfPluginZllCommissioningCommonInitialSecurityStateCallback
251
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
emberAfPluginZllCommissioningTouchLinkCompleteCallback#
#define emberAfPluginZllCommissioningTouchLinkCompleteCallbackValue:
emberAfPluginZllCommissioningCommonTouchLinkCompleteCallback
253
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h
emberAfPluginZllCommissioningResetToFactoryNewCallback#
#define emberAfPluginZllCommissioningResetToFactoryNewCallbackValue:
emberAfPluginZllCommissioningCommonResetToFactoryNewCallback
255
of file app/framework/plugin/zll-commissioning-common/zll-commissioning-common.h