zwave_association_toolbox.h

Go to the documentation of this file.

/******************************************************************************
 * # License
 * <b>Copyright 2022 Silicon Laboratories Inc. www.silabs.com</b>
 ******************************************************************************
 * The licensor of this software is Silicon Laboratories Inc. Your use of this
 * software is governed by the terms of Silicon Labs Master Software License
 * Agreement (MSLA) available at
 * www.silabs.com/about-us/legal/master-software-license-agreement. This
 * software is distributed to you in Source Code format and is governed by the
 * sections of the MSLA applicable to Source Code.
 *
 *****************************************************************************/
 
#ifndef ZWAVE_ASSOCIATION_TOOLBOX_H
#define ZWAVE_ASSOCIATION_TOOLBOX_H
 
#include "attribute_store.h"
#include "sl_status.h"
#include "zwave_command_class_association_types.h"
#include "zwave_node_id_definitions.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
attribute_store_node_t get_group_child_node(zwave_node_id_t node_id,
                                            zwave_endpoint_id_t endpoint_id,
                                            association_group_id_t group_id,
                                            attribute_store_type_t type);
 
attribute_store_node_t get_group_content_node(zwave_node_id_t node_id,
                                              zwave_endpoint_id_t endpoint_id,
                                              association_group_id_t group_id);
 
bool is_association_legal(zwave_node_id_t node_id,
                          zwave_endpoint_id_t endpoint_id,
                          association_group_id_t group_id,
                          association_t association);
 
association_group_count_t get_number_of_groups(zwave_node_id_t node_id,
                                               zwave_endpoint_id_t endpoint_id);
 
association_group_capacity_t
  get_group_capacity(zwave_node_id_t node_id,
                     zwave_endpoint_id_t endpoint_id,
                     association_group_id_t group_id);
 
sl_status_t add_desired_association(zwave_node_id_t node_id,
                                    zwave_endpoint_id_t endpoint_id,
                                    association_group_id_t group_id,
                                    association_t association);
 
sl_status_t add_reported_association(zwave_node_id_t node_id,
                                     zwave_endpoint_id_t endpoint_id,
                                     association_group_id_t group_id,
                                     association_t association);
 
sl_status_t force_add_desired_association(zwave_node_id_t node_id,
                                          zwave_endpoint_id_t endpoint_id,
                                          association_group_id_t group_id,
                                          association_t new_association);
 
sl_status_t remove_desired_association(zwave_node_id_t node_id,
                                       zwave_endpoint_id_t endpoint_id,
                                       association_group_id_t group_id,
                                       association_t association);
 
sl_status_t remove_reported_association(zwave_node_id_t node_id,
                                        zwave_endpoint_id_t endpoint_id,
                                        association_group_id_t group_id,
                                        association_t association);
 
sl_status_t remove_all_desired_associations(zwave_node_id_t node_id,
                                            zwave_endpoint_id_t endpoint_id,
                                            association_group_id_t group_id);
 
sl_status_t remove_all_reported_associations(zwave_node_id_t node_id,
                                             zwave_endpoint_id_t endpoint_id,
                                             association_group_id_t group_id);
 
sl_status_t
  remove_all_reported_node_id_associations(zwave_node_id_t node_id,
                                           zwave_endpoint_id_t endpoint_id,
                                           association_group_id_t group_id);
 
bool is_reported_group_full(zwave_node_id_t node_id,
                            zwave_endpoint_id_t endpoint_id,
                            association_group_id_t group_id);
 
bool is_desired_group_full(zwave_node_id_t node_id,
                           zwave_endpoint_id_t endpoint_id,
                           association_group_id_t group_id);
 
bool is_association_in_group(zwave_node_id_t node_id,
                             zwave_endpoint_id_t endpoint_id,
                             association_group_id_t group_id,
                             association_t association);
 
void remove_desired_node_id_from_all_associations_in_network(
  zwave_node_id_t node_id);
 
void add_desired_association_in_all_groups(zwave_node_id_t node_id,
                                           zwave_endpoint_id_t endpoint_id,
                                           association_t association);
 
void remove_desired_association_in_all_groups(zwave_node_id_t node_id,
                                              zwave_endpoint_id_t endpoint_id,
                                              association_t association);
 
void remove_desired_node_id_from_all_associations(
  zwave_node_id_t node_id_to_remove,
  zwave_node_id_t node_id,
  zwave_endpoint_id_t endpoint_id);
 
#ifdef __cplusplus
}
#endif
 
#endif  //ZWAVE_ASSOCIATION_TOOLBOX_H