Groups Server#

Callbacks for Groups Server Component.

Callbacks#

void
sl_zigbee_af_groups_server_get_group_name_cb(uint8_t endpoint, uint16_t groupId, uint8_t *groupName)

Get a group name.

void
sl_zigbee_af_groups_server_set_group_name_cb(uint8_t endpoint, uint16_t groupId, uint8_t *groupName)

Set a group name.

bool
sl_zigbee_af_groups_server_group_names_supported_cb(uint8_t endpoint)

Return supported group names.

void
sl_zigbee_af_groups_cluster_clear_group_table_cb(uint8_t endpoint)

Clear the group table.

Callbacks Documentation#

sl_zigbee_af_groups_server_get_group_name_cb#

void sl_zigbee_af_groups_server_get_group_name_cb (uint8_t endpoint, uint16_t groupId, uint8_t * groupName)

Get a group name.

Parameters
N/Aendpoint

Endpoint Ver.: always

N/AgroupId

Group ID Ver.: always

N/AgroupName

Group Name Ver.: always

This function returns the name of a group with the provided group ID, if it exists.


Definition at line 66 of file app/framework/plugin/groups-server/groups-server.h

sl_zigbee_af_groups_server_set_group_name_cb#

void sl_zigbee_af_groups_server_set_group_name_cb (uint8_t endpoint, uint16_t groupId, uint8_t * groupName)

Set a group name.

Parameters
N/Aendpoint

Endpoint Ver.: always

N/AgroupId

Group ID Ver.: always

N/AgroupName

Group Name Ver.: always

This function sets the name of a group with the provided group ID.


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

sl_zigbee_af_groups_server_group_names_supported_cb#

bool sl_zigbee_af_groups_server_group_names_supported_cb (uint8_t endpoint)

Return supported group names.

Parameters
N/Aendpoint

Endpoint Ver.: always

This function returns whether or not group names are supported.


Definition at line 88 of file app/framework/plugin/groups-server/groups-server.h

sl_zigbee_af_groups_cluster_clear_group_table_cb#

void sl_zigbee_af_groups_cluster_clear_group_table_cb (uint8_t endpoint)

Clear the group table.

Parameters
N/Aendpoint

The endpoint. Ver.: always

This function is called by the framework when the application should clear the group table.


Definition at line 97 of file app/framework/plugin/groups-server/groups-server.h