Module mapping bindable cluster to association group properties. More...

Collaboration diagram for Binding Cluster Mapping Helper:

Macros
#define	MAXIMUM_NUMBER_OF_BINDABLE_CLUSTERS 30

#define	MAXIMUM_NUMBER_OF_ASSOCIATION_GROUPS 255

Functions
bool	is_command_class_and_command_mapped_to_bindings (zwave_command_class_t command_class, zwave_command_t command)
	Checks if the Command Class / Command combination is mapped to a cluster binding. More...

void	binding_mapper_helper_get_association_group_list_from_cluster (dotdot_unid_t unid, dotdot_endpoint_id_t endpoint, dotdot_cluster_id_t cluster_id, association_group_id_t group_id_list, uint8_t number_of_groups)
	Finds the list of Association Groups to associate under a UNID/Endpoint that sends command that belong to the Cluster ID. More...

void	binding_mapper_helper_get_cluster_list_from_association_group (dotdot_unid_t unid, dotdot_endpoint_id_t endpoint, association_group_id_t group_id, dotdot_cluster_id_t cluster_id_list, uint8_t number_of_clusters)
	Finds the list of Clusters that an association group id covers with the commands it sends. More...

void	binding_mapper_helper_get_bindable_cluster_list_from_node (dotdot_unid_t unid, dotdot_endpoint_id_t endpoint, dotdot_cluster_id_t cluster_id_list, uint8_t number_of_clusters)
	Finds the list of bindable Clusters that the association groups of a node covers with commands it sends. More...

Detailed Description

Module mapping bindable cluster to association group properties.

This module helps to translates before association groups data and bindings

Macro Definition Documentation

#define MAXIMUM_NUMBER_OF_ASSOCIATION_GROUPS 255

#define MAXIMUM_NUMBER_OF_BINDABLE_CLUSTERS 30

void binding_mapper_helper_get_association_group_list_from_cluster	(	dotdot_unid_t	unid,
		dotdot_endpoint_id_t	endpoint,
		dotdot_cluster_id_t	cluster_id,
		association_group_id_t *	group_id_list,
		uint8_t *	number_of_groups
	)

Finds the list of Association Groups to associate under a UNID/Endpoint that sends command that belong to the Cluster ID.

Parameters

	unid	Node UNID
	endpoint	Node's EndpointID
	cluster_id	The Cluster ID to match association groups from
[out]	group_id_list	The list of Groups to associate. MUST be able to contain up to MAXIMUM_NUMBER_OF_ASSOCIATION_GROUPS elements
[out]	number_of_groups	Number of Group IDs to association (number of elements to read from the group_id_list)

void binding_mapper_helper_get_bindable_cluster_list_from_node	(	dotdot_unid_t	unid,
		dotdot_endpoint_id_t	endpoint,
		dotdot_cluster_id_t *	cluster_id_list,
		uint8_t *	number_of_clusters
	)

Finds the list of bindable Clusters that the association groups of a node covers with commands it sends.

Parameters

	unid	Node UNID
	endpoint	Node's EndpointID
[out]	cluster_id_list	The list of bindable clusters. MUST be able to contain up to MAXIMUM_NUMBER_OF_BINDABLE_CLUSTERS elements
[out]	number_of_clusters	Number of bindable clusters

void binding_mapper_helper_get_cluster_list_from_association_group	(	dotdot_unid_t	unid,
		dotdot_endpoint_id_t	endpoint,
		association_group_id_t	group_id,
		dotdot_cluster_id_t *	cluster_id_list,
		uint8_t *	number_of_clusters
	)

Finds the list of Clusters that an association group id covers with the commands it sends.

Parameters

	unid	Node UNID
	endpoint	Node's EndpointID
	group_id	The Group ID to check for matching Cluster IDs
[out]	cluster_id_list	The list of bindable clusters. MUST be able to contain up to MAXIMUM_NUMBER_OF_BINDABLE_CLUSTERS elements
[out]	number_of_clusters	Number of bindable clusters

bool is_command_class_and_command_mapped_to_bindings	(	zwave_command_class_t	command_class,
		zwave_command_t	command
	)

Checks if the Command Class / Command combination is mapped to a cluster binding.

Parameters

command_class	The Command Class
command	The Command

Returns: true if this combination is mapped to a cluster in the bindings, false otherwise