tr_groups_server.h File Reference

ZCL Groups cluster server implementation. More...

#include "tr_af.h"

Include dependency graph for tr_groups_server.h:

Go to the source code of this file.

Macros
#define	TR_GROUPS_SERVER_GROUP_NAME_MAX_LEN   16
#define	tr_groups_server_printf(...)
#define	tr_groups_server_println(...)

Typedefs
struct {
zb_uint8_t   status
zb_uint16_t   group_id
zb_uint8_t   group_name [TR_GROUPS_SERVER_GROUP_NAME_MAX_LEN+1]
}	tr_groups_view_group_response_arg_t
struct {
zb_uint8_t   capacity
zb_uint8_t   group_count
zb_uint16_t   group_list [ZB_APS_GROUP_TABLE_SIZE]
}	tr_groups_get_group_membership_response_arg_t

Functions
void	tr_groups_server_init_cb (zb_uint8_t endpoint)
	Callback fires when the Groups server cluster plugin is initialized.
zb_bool_t	tr_groups_server_command_received_cb (zb_zcl_parsed_hdr_t *cmd_info)
	Callback that user can declare to handle any Groups server commands.
void	tr_groups_server_write_attr_cb (zb_uint8_t endpoint, zb_uint16_t attr_id, zb_uint8_t *new_value, zb_uint16_t manuf_code)
	Callback fires when an Groups server attribute is about to be written.
zb_bool_t	tr_groups_server_add_group_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t group_id, zb_uint8_t *group_name)
	Callback that user can declare to handle groups cluster add group command.
zb_bool_t	tr_groups_server_view_group_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t group_id, zb_uint8_t *group_name)
	Callback that user can declare to handle groups cluster view group command.
zb_bool_t	tr_groups_server_get_group_membership_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint8_t group_count, zb_uint16_t *group_list)
	Callback that user can declare to handle groups cluster get group membership command.
zb_bool_t	tr_groups_server_remove_group_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t group_id)
	Callback that user can declare to handle groups cluster remove group command.
zb_bool_t	tr_groups_server_remove_all_groups_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint)
	Callback that user can declare to handle groups cluster remove all groups command.
zb_bool_t	tr_groups_server_add_group_if_identifying_cb (zb_zcl_parsed_hdr_t *cmd_info, zb_uint8_t endpoint, zb_uint16_t group_id, zb_uint8_t *group_name)
	Callback that user can declare to handle groups cluster add group if identifying command.
void	tr_groups_server_resp_sent_cb (zb_bufid_t param)
	Callback fires when groups server response completes.
void	tr_groups_server_init (void)
zb_bool_t	tr_groups_server_is_group_id_present (zb_uint16_t group_id, zb_uint8_t endpoint)

Detailed Description

ZCL Groups cluster server implementation.

---

SPDX-License-Identifier: LicenseRef-TridentMSLA SPDX-FileCopyrightText: 2025 Trident IoT, LLC https://www.tridentiot.com

---

Macro Definition Documentation

TR_GROUPS_SERVER_GROUP_NAME_MAX_LEN

#define TR_GROUPS_SERVER_GROUP_NAME_MAX_LEN   16

tr_groups_server_printf

#define tr_groups_server_printf

(

...

)

---

debug prints

---

tr_groups_server_println

#define tr_groups_server_println

(

...

)

Typedef Documentation

[struct]

typedef ZB_PACKED_PRE struct { ... } tr_groups_get_group_membership_response_arg_t

[struct]

typedef ZB_PACKED_PRE struct { ... } tr_groups_view_group_response_arg_t

Function Documentation

tr_groups_server_init()

void tr_groups_server_init

(

void

)

---

function prototypes consumed by framework

---

tr_groups_server_is_group_id_present()

zb_bool_t tr_groups_server_is_group_id_present	(	zb_uint16_t	group_id,
		zb_uint8_t	endpoint )

Variable Documentation

capacity

zb_uint8_t capacity

group_count

zb_uint8_t group_count

group_id

zb_uint16_t group_id

group_list

zb_uint16_t group_list[ZB_APS_GROUP_TABLE_SIZE]

group_name

zb_uint8_t group_name[TR_GROUPS_SERVER_GROUP_NAME_MAX_LEN+1]

status

zb_uint8_t status