ZLL commissioning Server#

Callbacks for ZLL commissioning Server Component.

Callbacks#

uint8_t
emberAfPluginZllCommissioningServerGroupIdentifierCountCallback(uint8_t endpoint)

Determine the number of group identifiers in use by a specific endpoint on the device.

bool
emberAfPluginZllCommissioningServerGroupIdentifierCallback(uint8_t endpoint, uint8_t index, EmberAfPluginZllCommissioningGroupInformationRecord *record)

Obtain information about the group identifiers in use by a specific endpoint on the device.

uint8_t
emberAfPluginZllCommissioningServerEndpointInformationCountCallback(uint8_t endpoint)

Determine the number of remote endpoints controlled by a specific endpoint on the local device.

bool
emberAfPluginZllCommissioningServerEndpointInformationCallback(uint8_t endpoint, uint8_t index, EmberAfPluginZllCommissioningEndpointInformationRecord *record)

Obtain information about the remote endpoints controlled by a specific endpoint on the local device.

void
emberAfPluginZllCommissioningServerIdentifyCallback(uint16_t durationS)

Notify the application that it should take an action to identify itself.

#define
emberAfPluginZllCommissioningGroupIdentifierCountCallback (endpoint)

Determine the number of group identifiers in use by a specific endpoint on the device.

#define
emberAfPluginZllCommissioningGroupIdentifierCallback (endpoint)

Determine the number of group identifiers in use by a specific endpoint on the device.

#define
emberAfPluginZllCommissioningEndpointInformationCountCallback (endpoint)

Determine the number of group identifiers in use by a specific endpoint on the device.

#define
emberAfPluginZllCommissioningEndpointInformationCallback (endpoint)

Determine the number of group identifiers in use by a specific endpoint on the device.

#define
emberAfPluginZllCommissioningIdentifyCallback (endpoint)

Determine the number of group identifiers in use by a specific endpoint on the device.

Callbacks Documentation#

emberAfPluginZllCommissioningServerGroupIdentifierCountCallback#

uint8_t emberAfPluginZllCommissioningServerGroupIdentifierCountCallback (uint8_t endpoint)

Determine the number of group identifiers in use by a specific endpoint on the device.

Parameters
N/Aendpoint

The endpoint for which the group identifier count is requested. Ver.: always

This function is called by the ZLL Commissioning Server plugin. The total number of group identifiers on the device, which are shared by all endpoints, is defined by ::EMBER_ZLL_GROUP_ADDRESSES.


Definition at line 95 of file app/framework/plugin/zll-commissioning-server/zll-commissioning-server.h

emberAfPluginZllCommissioningServerGroupIdentifierCallback#

bool emberAfPluginZllCommissioningServerGroupIdentifierCallback (uint8_t endpoint, uint8_t index, EmberAfPluginZllCommissioningGroupInformationRecord *record)

Obtain information about the group identifiers in use by a specific endpoint on the device.

Parameters
N/Aendpoint

The endpoint for which the group identifier is requested. Ver.: always

N/Aindex

The index of the group on the endpoint. Ver.: always

N/Arecord

The group information record. Ver.: always

This function is called by the ZLL Commissioning Server plugin. The application should populate the record with information about the group identifier and return true. If no information is available for the given endpoint and index, the application should return false.


Definition at line 111 of file app/framework/plugin/zll-commissioning-server/zll-commissioning-server.h

emberAfPluginZllCommissioningServerEndpointInformationCountCallback#

uint8_t emberAfPluginZllCommissioningServerEndpointInformationCountCallback (uint8_t endpoint)

Determine the number of remote endpoints controlled by a specific endpoint on the local device.

Parameters
N/Aendpoint

The local endpoint for which the remote endpoint information count is requested. Ver.: always

This function is called by the ZLL Commissioning Server plugin.


Definition at line 124 of file app/framework/plugin/zll-commissioning-server/zll-commissioning-server.h

emberAfPluginZllCommissioningServerEndpointInformationCallback#

bool emberAfPluginZllCommissioningServerEndpointInformationCallback (uint8_t endpoint, uint8_t index, EmberAfPluginZllCommissioningEndpointInformationRecord *record)

Obtain information about the remote endpoints controlled by a specific endpoint on the local device.

Parameters
N/Aendpoint

The local endpoint for which the remote endpoint information is requested. Ver.: always

N/Aindex

The index of the remote endpoint information on the local endpoint. Ver.: always

N/Arecord

The endpoint information record. Ver.: always

This function is called by the ZLL Commissioning Server plugin. The application should populate the record with information about the remote endpoint and return true. If no information is available for the given endpoint and index, the application should return false.


Definition at line 142 of file app/framework/plugin/zll-commissioning-server/zll-commissioning-server.h

emberAfPluginZllCommissioningServerIdentifyCallback#

void emberAfPluginZllCommissioningServerIdentifyCallback (uint16_t durationS)

Notify the application that it should take an action to identify itself.

Parameters
N/AdurationS

If the duration is zero, the device should exit identify mode. If the duration is 0xFFFF, the device should remain in identify mode for the default time. Otherwise, the duration specifies the length of time in seconds that the device should remain in identify mode. Ver.: always

This function is called by the ZLL Commissioning Server plugin. This typically occurs when an Identify Request is received via inter-PAN messaging.


Definition at line 157 of file app/framework/plugin/zll-commissioning-server/zll-commissioning-server.h

emberAfPluginZllCommissioningGroupIdentifierCountCallback#

#define emberAfPluginZllCommissioningGroupIdentifierCountCallback
Value:
(endpoint)

Determine the number of group identifiers in use by a specific endpoint on the device.

This function is called by the ZLL Commissioning Server plugin. The total number of group identifiers on the device, which are shared by all endpoints, is defined by ::EMBER_ZLL_GROUP_ADDRESSES.


Definition at line 74 of file app/framework/plugin/zll-commissioning-server/zll-commissioning-server.h

emberAfPluginZllCommissioningGroupIdentifierCallback#

#define emberAfPluginZllCommissioningGroupIdentifierCallback
Value:
(endpoint)

Determine the number of group identifiers in use by a specific endpoint on the device.

This function is called by the ZLL Commissioning Server plugin. The total number of group identifiers on the device, which are shared by all endpoints, is defined by ::EMBER_ZLL_GROUP_ADDRESSES.


Definition at line 76 of file app/framework/plugin/zll-commissioning-server/zll-commissioning-server.h

emberAfPluginZllCommissioningEndpointInformationCountCallback#

#define emberAfPluginZllCommissioningEndpointInformationCountCallback
Value:
(endpoint)

Determine the number of group identifiers in use by a specific endpoint on the device.

This function is called by the ZLL Commissioning Server plugin. The total number of group identifiers on the device, which are shared by all endpoints, is defined by ::EMBER_ZLL_GROUP_ADDRESSES.


Definition at line 78 of file app/framework/plugin/zll-commissioning-server/zll-commissioning-server.h

emberAfPluginZllCommissioningEndpointInformationCallback#

#define emberAfPluginZllCommissioningEndpointInformationCallback
Value:
(endpoint)

Determine the number of group identifiers in use by a specific endpoint on the device.

This function is called by the ZLL Commissioning Server plugin. The total number of group identifiers on the device, which are shared by all endpoints, is defined by ::EMBER_ZLL_GROUP_ADDRESSES.


Definition at line 80 of file app/framework/plugin/zll-commissioning-server/zll-commissioning-server.h

emberAfPluginZllCommissioningIdentifyCallback#

#define emberAfPluginZllCommissioningIdentifyCallback
Value:
(endpoint)

Determine the number of group identifiers in use by a specific endpoint on the device.

This function is called by the ZLL Commissioning Server plugin. The total number of group identifiers on the device, which are shared by all endpoints, is defined by ::EMBER_ZLL_GROUP_ADDRESSES.


Definition at line 82 of file app/framework/plugin/zll-commissioning-server/zll-commissioning-server.h