Z-Wave Protocol Controller Reference
zwave_tx_groups.h
Go to the documentation of this file.
1/******************************************************************************
2 * # License
3 * <b>Copyright 2021 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 ZWAVE_TX_GROUPS_H
26#define ZWAVE_TX_GROUPS_H
27
28#include "sl_status.h"
29
31
33#define ZWAVE_TX_INVALID_GROUP ((zwave_multicast_group_id_t)0)
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
53
72
84
99
114
124
131
132#ifdef __cplusplus
133}
134#endif
135
136#endif //ZWAVE_TX_GROUPS_H
uint32_t sl_status_t
Definition: sl_status.h:139
uint8_t zwave_multicast_group_id_t
Definition: zwave_controller_types.h:43
uint8_t zwave_nodemask_t[ZW_LR_MAX_NODEMASK_LENGTH]
Node mask.
Definition: zwave_node_id_definitions.h:81
uint16_t zwave_node_id_t
Z-Wave NodeID type.
Definition: zwave_node_id_definitions.h:84
sl_status_t zwave_tx_get_nodes(zwave_nodemask_t nodes, zwave_multicast_group_id_t group_id)
Returns the list of NodeIDs part of a group.
sl_status_t zwave_tx_unlock_group(zwave_multicast_group_id_t group_id)
Instructs the Z-Wave TX Group that the list of NodeIDs part of a group can be modified.
bool zwave_tx_is_group_locked(zwave_multicast_group_id_t group_id)
Verifies if a group is locked.
void zwave_tx_group_log(zwave_multicast_group_id_t group_id)
Logs the content / state of the group using sl_log.
sl_status_t zwave_tx_add_node_to_group(zwave_node_id_t node_id, zwave_multicast_group_id_t group_id)
Adds a NodeID to a Group ID.
sl_status_t zwave_tx_lock_group(zwave_multicast_group_id_t group_id)
Instructs the Z-Wave TX Group not to alter the list of NodeIDs part of a group, until the group is un...
sl_status_t zwave_tx_assign_group(const zwave_nodemask_t nodes, zwave_multicast_group_id_t *group_id)
Assigns/returns a Group ID to the list of NodeIDs.
SL Status Codes.
const zwave_node_id_t node_id