Groups Server#
Callbacks for Groups Server Component.
Callbacks#
void
emberAfPluginGroupsServerGetGroupNameCallback(uint8_t endpoint, uint16_t groupId, uint8_t *groupName)
Get a group name.
void
emberAfPluginGroupsServerSetGroupNameCallback(uint8_t endpoint, uint16_t groupId, uint8_t *groupName)
Set a group name.
bool
emberAfPluginGroupsServerGroupNamesSupportedCallback(uint8_t endpoint)
Return supported group names.
void
emberAfGroupsClusterClearGroupTableCallback(uint8_t endpoint)
Clear the group table.
Callbacks Documentation#
emberAfPluginGroupsServerGetGroupNameCallback#
void emberAfPluginGroupsServerGetGroupNameCallback (uint8_t endpoint, uint16_t groupId, uint8_t * groupName)
Get a group name.
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | Endpoint Ver.: always |
| uint16_t | N/A | groupId | Group ID Ver.: always |
| uint8_t * | N/A | groupName | Group Name Ver.: always |
This function returns the name of a group with the provided group ID, if it exists.
emberAfPluginGroupsServerSetGroupNameCallback#
void emberAfPluginGroupsServerSetGroupNameCallback (uint8_t endpoint, uint16_t groupId, uint8_t * groupName)
Set a group name.
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | Endpoint Ver.: always |
| uint16_t | N/A | groupId | Group ID Ver.: always |
| uint8_t * | N/A | groupName | Group Name Ver.: always |
This function sets the name of a group with the provided group ID.
emberAfPluginGroupsServerGroupNamesSupportedCallback#
bool emberAfPluginGroupsServerGroupNamesSupportedCallback (uint8_t endpoint)
Return supported group names.
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | Endpoint Ver.: always |
This function returns whether or not group names are supported.
emberAfGroupsClusterClearGroupTableCallback#
void emberAfGroupsClusterClearGroupTableCallback (uint8_t endpoint)
Clear the group table.
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t | N/A | endpoint | The endpoint. Ver.: always |
This function is called by the framework when the application should clear the group table.