Definitions for the ZLL Commissioning Client plugin.
License#
Copyright 2018 Silicon Laboratories Inc. www.silabs.com
The licensor of this software is Silicon Laboratories Inc. Your use of this software is governed by the terms of Silicon Labs Master Software License Agreement (MSLA) available at www.silabs.com/about-us/legal/master-software-license-agreement. This software is distributed to you in Source Code format and is governed by the sections of the MSLA applicable to Source Code.
/***************************************************************************/
// *******************************************************************
// * zll-commissioning-client.h
// *
// *
// Copyright 2010-2018 Silicon Laboratories, Inc.
// *******************************************************************
EmberStatus emberAfZllInitiateTouchLink(void);
EmberStatus emberAfZllDeviceInformationRequest(void);
EmberStatus emberAfZllIdentifyRequest(void);
EmberStatus emberAfZllResetToFactoryNewRequest(void);
void emberAfZllAbortTouchLink(void);
// END addtogroup
// For legacy code
#define emberAfPluginZllCommissioningTouchLinkFailedCallback \
emberAfPluginZllCommissioningClientTouchLinkFailedCallback
Macros#
Functions#
Initiates the touch link procedure.
Initiates a touch link to retrieve information about a target device.
Initiates a touch link to cause a target device to identify itself.
Initiates a touch link for the purpose of resetting a target device.
Aborts the touch link procedure.
Macro Definition Documentation#
emberAfPluginZllCommissioningTouchLinkFailedCallback#
#define emberAfPluginZllCommissioningTouchLinkFailedCallbackValue:
emberAfPluginZllCommissioningClientTouchLinkFailedCallback
105 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/plugin/zll-commissioning-client/zll-commissioning-client.hFunction Documentation#
emberAfZllInitiateTouchLink#
EmberStatus emberAfZllInitiateTouchLink (void )
Initiates the touch link procedure.
| N/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 will call emberAfPluginZllCommissioningTouchLinkCompleteCallback with information about the network and the target. If touch linking fails, the plugin will call emberAfPluginZllCommissioningTouchLinkFailedCallback.
Returns
An EmberStatus value that indicates the success or failure of the command.
43 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/plugin/zll-commissioning-client/zll-commissioning-client.hemberAfZllDeviceInformationRequest#
EmberStatus emberAfZllDeviceInformationRequest (void )
Initiates a touch link to retrieve information about a target device.
| N/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 will call emberAfPluginZllCommissioningTouchLinkCompleteCallback with information about the target. If touch linking fails, the plugin will call emberAfPluginZllCommissioningTouchLinkFailedCallback.
Returns
An EmberStatus value that indicates the success or failure of the command.
60 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/plugin/zll-commissioning-client/zll-commissioning-client.hemberAfZllIdentifyRequest#
EmberStatus emberAfZllIdentifyRequest (void )
Initiates a touch link to cause a target device to identify itself.
| N/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 will call emberAfPluginZllCommissioningTouchLinkCompleteCallback with information about the target. If touch linking fails, the plugin will call emberAfPluginZllCommissioningTouchLinkFailedCallback.
Returns
An EmberStatus value that indicates the success or failure of the command.
77 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/plugin/zll-commissioning-client/zll-commissioning-client.hemberAfZllResetToFactoryNewRequest#
EmberStatus emberAfZllResetToFactoryNewRequest (void )
Initiates a touch link for the purpose of resetting a target device.
| N/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 will call emberAfPluginZllCommissioningTouchLinkCompleteCallback with information about the target. If touch linking fails, the plugin will call emberAfPluginZllCommissioningTouchLinkFailedCallback.
Returns
An EmberStatus value that indicates the success or failure of the command.
93 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/plugin/zll-commissioning-client/zll-commissioning-client.hemberAfZllAbortTouchLink#
void emberAfZllAbortTouchLink (void )
Aborts the touch link procedure.
| N/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.
100 of file /Users/vihuszar/Git/EmbeddedSoftware/super/protocol/zigbee/app/framework/plugin/zll-commissioning-client/zll-commissioning-client.h