Zigbee Protocol Controller 1.6.0
zigpc_group_map.h
Go to the documentation of this file.
1/******************************************************************************
2 * # License
3 * <b>Copyright 2020 Silicon Laboratories Inc. www.silabs.com</b>
4 ******************************************************************************
5 * The licensor of this software is Silicon Laboratories Inc. Your use of this
6 * software is governed by the terms of Silicon Labs Master Software License
7 * Agreement (MSLA) available at
8 * www.silabs.com/about-us/legal/master-software-license-agreement. This
9 * software is distributed to you in Source Code format and is governed by the
10 * sections of the MSLA applicable to Source Code.
11 *
12 *****************************************************************************/
13
25#ifndef ZIGPC_GROUP_MAP_H
26#define ZIGPC_GROUP_MAP_H
27
28#include "sl_status.h"
29#include "zigpc_common_zigbee.h"
30#include "zigpc_group_mgmt.h"
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
48 bool is_reported);
49
62 const char *group_name,
64 bool is_reported);
65
78 bool is_reported);
79
93 zigbee_group_id_t *group_list,
94 unsigned int num_groups,
95 bool is_reported);
96
111 bool is_reported);
112
122
132
146 zigpc_group_member_t *const member_list,
147 size_t member_list_count);
148
156
176 zigbee_group_id_t group_id,
177 bool is_reported,
178 char *const group_name,
179 size_t *const group_name_size);
180
195 zigbee_group_id_t group_id,
196 bool is_reported,
197 const char *group_name);
198
201#ifdef __cplusplus
202}
203#endif
204#endif //ZIGPC_GROUP_MGMT_H
uint32_t sl_status_t
Definition: sl_status.h:139
uint16_t zigbee_group_id_t
Zigbee Group Id The internal representation of a group_id.
Definition: zigpc_common_zigbee.h:230
sl_status_t zigpc_group_map_retrieve_group_name(zigpc_group_member_t member, zigbee_group_id_t group_id, bool is_reported, char *const group_name, size_t *const group_name_size)
zigpc_group_map_retrieve_group_name Retrieve the name of a group on a given endpoint
sl_status_t zigpc_group_map_clear(void)
zigpc_group_map_clear NOTE: DEPRECATED. Note used anymore.
sl_status_t zigpc_group_map_retrieve_grouplist(zigpc_group_member_t member, zigbee_group_id_t *group_list, unsigned int num_groups, bool is_reported)
zigpc_group_map_retrieve_grouplist Retrieve the group list of a given member
sl_status_t zigpc_group_map_remove_group(zigbee_group_id_t group, zigpc_group_member_t member, bool is_reported)
zigpc_group_map_remove_group Remove the given member from its associated group
sl_status_t zigpc_group_map_set_group_name(zigpc_group_member_t member, zigbee_group_id_t group_id, bool is_reported, const char *group_name)
zigpc_group_map_set_group_name Set the name of a group on a given endpoint
sl_status_t zigpc_group_map_add_new_with_name(zigbee_group_id_t group, const char *group_name, zigpc_group_member_t member, bool is_reported)
zigpc_group_map_add_new_with_name Add a member to a zigbee group in the map, with a name.
size_t zigpc_group_map_get_memberlist_count(zigbee_group_id_t group_id)
Retrieve the size of the member(EUI64/EP pair) list corresponding to a group_id.
sl_status_t zigpc_group_map_get_memberlist_items(zigbee_group_id_t group_id, zigpc_group_member_t *const member_list, size_t member_list_count)
Retrieve the member(EUI64/EP pair) list corresponding to a group_id via the provided list pointer.
sl_status_t zigpc_group_map_remove_all(zigpc_group_member_t member)
zigpc_group_map_remove_all Remove all associated groups from a given member
sl_status_t zigpc_group_map_add_new(zigbee_group_id_t group, zigpc_group_member_t member, bool is_reported)
zigpc_group_map_add_new Add a member to a zigbee group in the map.
unsigned int zigpc_group_map_retrieve_num(zigpc_group_member_t member, bool is_reported)
zigpc_group_map_retrieve_num Retrieve the number of groups associated with a member
SL Status Codes.
zigpc_group_member_t A structure representing the member of a zigbee group
Definition: zigpc_group_mgmt.h:41