Z-Wave Protocol Controller Reference
zwave_association_toolbox.h File Reference
#include "attribute_store.h"
#include "sl_status.h"
#include "zwave_command_class_association_types.h"
#include "zwave_node_id_definitions.h"
Include dependency graph for zwave_association_toolbox.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

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)
 Get the Attribute store node of a certain type under an association Group ID. More...
 
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)
 Finds the Attribute Store Node for the group content. More...
 
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)
 Checks if an association is legal or if we will get in trouble with cert if we establish it :-) More...
 
association_group_count_t get_number_of_groups (zwave_node_id_t node_id, zwave_endpoint_id_t endpoint_id)
 Returns how many groups are supported by an endpoint. More...
 
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)
 Checks in the attribute store the maximum number of associations for a group. More...
 
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)
 Adds a desired association in a group in the Attribute Store. More...
 
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)
 Adds a reported association in a group in the Attribute Store. More...
 
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)
 Adds a desired association in a group in the Attribute Store and remove an existing association if needed. More...
 
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)
 Removes a desired association in a group in the Attribute Store. More...
 
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)
 Removes a reported association in a group in the Attribute Store. More...
 
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)
 Removes all desired association in a group in the Attribute Store. It will set the attribute to an ASSOCIATION_MARKER byte. More...
 
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)
 Removes all reported association in a group in the Attribute Store. It will set the attribute to an ASSOCIATION_MARKER byte. More...
 
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)
 Removes all reported NodeID associations in a group in the Attribute Store. More...
 
bool is_reported_group_full (zwave_node_id_t node_id, zwave_endpoint_id_t endpoint_id, association_group_id_t group_id)
 Checks if the reported value of an association group is full. More...
 
bool is_desired_group_full (zwave_node_id_t node_id, zwave_endpoint_id_t endpoint_id, association_group_id_t group_id)
 Checks if the desired value of an association group is full. More...
 
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)
 Checks if an association is already part of a group. More...
 
void remove_desired_node_id_from_all_associations_in_network (zwave_node_id_t node_id)
 Attempts to remove a NodeID for all associations groups in the current network. More...
 
void add_desired_association_in_all_groups (zwave_node_id_t node_id, zwave_endpoint_id_t endpoint_id, association_t association)
 Attempts to add an Association for all associations groups for a given NodeID/Ep. More...
 
void remove_desired_association_in_all_groups (zwave_node_id_t node_id, zwave_endpoint_id_t endpoint_id, association_t association)
 Attempts to remove an Association for all associations groups for a given NodeID/Ep. More...
 
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)
 Attempts to remove a NodeID for all associations groups for a given NodeID/Ep. More...