ZPC Attribute Store Z-Wave Network Helpers

Helper functions to read find out HomeID / NodeID / Endpoints nodes in the attribute_store. More...

Collaboration diagram for ZPC Attribute Store Z-Wave Network Helpers:

Functions
attribute_store_node_t	attribute_store_network_helper_create_home_id_node (const unid_t node_unid)
	Take a UNID and return its attribute store node representing the HomeID. More...
attribute_store_node_t	attribute_store_network_helper_create_node_id_node (const unid_t node_unid)
	Take a UNID and return its attribute store node representing the NodeID. More...
attribute_store_node_t	attribute_store_network_helper_create_endpoint_node (const unid_t node_unid, zwave_endpoint_id_t endpoint_id)
	Take a UNID/endpoint combination and returns its attribute store node. More...
attribute_store_node_t	attribute_store_network_helper_get_home_id_node (const unid_t node_unid)
	Take a UNID and return its attribute store node representing the HomeID. More...
attribute_store_node_t	attribute_store_network_helper_get_node_id_node (const unid_t node_unid)
	Take a UNID and return its attribute store node representing the NodeID. More...
attribute_store_node_t	attribute_store_network_helper_get_zwave_node_id_node (zwave_node_id_t node_id)
	Take a Z-Wave NodeID and return its Attribute Store node representing the NodeID. More...
attribute_store_node_t	attribute_store_network_helper_get_endpoint_node (const unid_t node_unid, zwave_endpoint_id_t endpoint_id)
	Take a UNID/endpoint combination and returns its attribute store node. More...
attribute_store_node_t	attribute_store_get_endpoint_0_node (attribute_store_node_t node_id_node)
	Returns the Attribute Store node for Endpoint 0, under a NodeID node. More...
sl_status_t	attribute_store_network_helper_get_unid_endpoint_from_node (attribute_store_node_t node, unid_t unid, zwave_endpoint_id_t *endpoint_id)
	Traverse the tree up from a node and find under which UNID/endpoints it is. More...
sl_status_t	attribute_store_network_helper_get_unid_from_node (attribute_store_node_t node, unid_t unid)
	Traverse up the tree from a node and finds under which UNID it is. More...
sl_status_t	attribute_store_network_helper_get_node_id_from_node (attribute_store_node_t node, zwave_node_id_t *zwave_node_id)
	Traverse up the tree from a node and finds under which Z-Wave NodeID it is. More...
sl_status_t	attribute_store_network_helper_get_endpoint_id_from_node (attribute_store_node_t node, zwave_endpoint_id_t *zwave_endpoint_id)
	Traverse up the tree from a node and finds under which Z-Wave endpoint id it is located. More...
sl_status_t	attribute_store_network_helper_get_zwave_ids_from_node (attribute_store_node_t node, zwave_node_id_t *zwave_node_id, zwave_endpoint_id_t *zwave_endpoint_id)
	Traverse up the tree from a node and finds under which Z-Wave NodeID/endpoint id it is located. More...
attribute_store_node_t	zwave_command_class_get_endpoint_id_node (zwave_node_id_t node_id, zwave_endpoint_id_t endpoint_id)
	Gets the Attribute Store Endpoint ID node for a given Z-Wave NodeID / Endpoint ID in our network. More...

Detailed Description

Helper functions to read find out HomeID / NodeID / Endpoints nodes in the attribute_store.

These helper functions return the attribute store nodes for a given UNID. Note that if requested node does not exist in the attribute_store, they will be created and their newly created node will be returned.

Function Documentation

attribute_store_get_endpoint_0_node()

attribute_store_node_t attribute_store_get_endpoint_0_node

(

attribute_store_node_t

node_id_node

)

Returns the Attribute Store node for Endpoint 0, under a NodeID node.

Parameters

node_id_node

The attribute store node for the NodeID.

Returns

attribute_store_node_t representing Endpoint ID 0 under the NodeID

Here is the caller graph for this function:

attribute_store_network_helper_create_endpoint_node()

attribute_store_node_t attribute_store_network_helper_create_endpoint_node	(	const unid_t	node_unid,
		zwave_endpoint_id_t	endpoint_id
	)

Take a UNID/endpoint combination and returns its attribute store node.

Note: If the UNID/endpoint does not exist in the attribute store, this function will create it.

Parameters

node_unid	The unid_t value to parse and search in the tree.
endpoint_id	The zwave_endpoint_id_t to search under the UNID in the attribute_store tree.

Returns

attribute_store_node_t representing the UNID/endpoint in the attribute store

Here is the call graph for this function:

attribute_store_network_helper_create_home_id_node()

attribute_store_node_t attribute_store_network_helper_create_home_id_node

(

const unid_t

node_unid

)

Take a UNID and return its attribute store node representing the HomeID.

Note: If the HomeID of that UNID does not exist in the attribute store, this function will create it.

Parameters

node_unid

The unid_t value to parse and search in the tree.

Returns

attribute_store_node_t representing the HomeID for the UNID in the attribute store

Here is the call graph for this function:

Here is the caller graph for this function:

attribute_store_network_helper_create_node_id_node()

attribute_store_node_t attribute_store_network_helper_create_node_id_node

(

const unid_t

node_unid

)

Take a UNID and return its attribute store node representing the NodeID.

Note: If the NodeID of that UNID does not exist in the attribute store, this function will create it.

Parameters

node_unid

The unid_t value to parse and search in the tree.

Returns

attribute_store_node_t representing the NodeID for the UNID in the attribute store

Here is the call graph for this function:

Here is the caller graph for this function:

attribute_store_network_helper_get_endpoint_id_from_node()

sl_status_t attribute_store_network_helper_get_endpoint_id_from_node	(	attribute_store_node_t	node,
		zwave_endpoint_id_t *	zwave_endpoint_id
	)

Traverse up the tree from a node and finds under which Z-Wave endpoint id it is located.

Parameters

node	The Attribute store node for which the parent endpoint will be searched for
zwave_endpoint_id	A pointer where to write the found Z-Wave endpoint id

Returns

SL_STATUS_OK If an endpoint type of parents node was found and its value was copied in the zwave_endpoint_id variable

SL_STATUS_NOT_FOUND If the function went all the way up to the tree root and did not find any endpoint type of attribute

SL_STATUS_FAIL If some error occurred reading values in the tree.

Here is the caller graph for this function:

attribute_store_network_helper_get_endpoint_node()

attribute_store_node_t attribute_store_network_helper_get_endpoint_node	(	const unid_t	node_unid,
		zwave_endpoint_id_t	endpoint_id
	)

Take a UNID/endpoint combination and returns its attribute store node.

Parameters

node_unid	The unid_t value to parse and search in the tree.
endpoint_id	The zwave_endpoint_id_t to search under the UNID in the attribute_store tree.

Returns

attribute_store_node_t representing the UNID/endpoint in the attribute store

ATTRIBUTE_STORE_INVALID_NODE if no matching UNID node exists

Here is the call graph for this function:

Here is the caller graph for this function:

attribute_store_network_helper_get_home_id_node()

attribute_store_node_t attribute_store_network_helper_get_home_id_node

(

const unid_t

node_unid

)

Take a UNID and return its attribute store node representing the HomeID.

Parameters

node_unid

The unid_t value to parse and search in the tree.

Returns

attribute_store_node_t representing the HomeID for the UNID in the attribute store.

ATTRIBUTE_STORE_INVALID_NODE if no matching UNID node exists

Here is the call graph for this function:

Here is the caller graph for this function:

attribute_store_network_helper_get_node_id_from_node()

sl_status_t attribute_store_network_helper_get_node_id_from_node	(	attribute_store_node_t	node,
		zwave_node_id_t *	zwave_node_id
	)

Traverse up the tree from a node and finds under which Z-Wave NodeID it is.

Parameters

node	The Attribute store node for which the parent NodeID will be search for
zwave_node_id	A pointer where to write the found Z-Wave NodeID

Returns

SL_STATUS_OK If a NodeID type of parents node was found and its reported value was copied in the zwave_node_id variable

SL_STATUS_NOT_FOUND If the function went all the way up to the tree root and did not find NodeID type of node

SL_STATUS_FAIL If some error occurred reading values in the tree.

Here is the caller graph for this function:

attribute_store_network_helper_get_node_id_node()

attribute_store_node_t attribute_store_network_helper_get_node_id_node

(

const unid_t

node_unid

)

Take a UNID and return its attribute store node representing the NodeID.

Parameters

node_unid

The unid_t value to parse and search in the tree.

Returns

attribute_store_node_t representing the NodeID for the UNID in the attribute store.

ATTRIBUTE_STORE_INVALID_NODE if no matching UNID node exists

Here is the call graph for this function:

Here is the caller graph for this function:

attribute_store_network_helper_get_unid_endpoint_from_node()

sl_status_t attribute_store_network_helper_get_unid_endpoint_from_node	(	attribute_store_node_t	node,
		unid_t	unid,
		zwave_endpoint_id_t *	endpoint_id
	)

Traverse the tree up from a node and find under which UNID/endpoints it is.

Parameters

node	The Attribute store node for which the parent UNID/endpoint will be search for
unid	A pointer where to write the found UNID
endpoint_id	A pointer where to write the found endpoint id

Returns

SL_STATUS_OK If parents nodes (HomeID/NodeID/endpoints) were found and the values were copied in the UNID and endpoint_id variables has been copied to the read_value pointer

SL_STATUS_NOT_FOUND If the function went all the way up to the tree root and did not find UNID/endpoints

SL_STATUS_FAIL If some error occurred reading values in the tree.

Here is the call graph for this function:

Here is the caller graph for this function:

attribute_store_network_helper_get_unid_from_node()

sl_status_t attribute_store_network_helper_get_unid_from_node	(	attribute_store_node_t	node,
		unid_t	unid
	)

Traverse up the tree from a node and finds under which UNID it is.

Parameters

node	The Attribute store node for which the parent UNID will be search for
unid	A pointer where to write the found UNID

Returns

SL_STATUS_OK If parents nodes (HomeID/NodeID) were found and the value was copied in the UNID variable has been copied to the read_value pointer

SL_STATUS_NOT_FOUND If the function went all the way up to the tree root and did not find UNID

SL_STATUS_FAIL If some error occurred reading values in the tree.

Here is the call graph for this function:

Here is the caller graph for this function:

attribute_store_network_helper_get_zwave_ids_from_node()

sl_status_t attribute_store_network_helper_get_zwave_ids_from_node	(	attribute_store_node_t	node,
		zwave_node_id_t *	zwave_node_id,
		zwave_endpoint_id_t *	zwave_endpoint_id
	)

Traverse up the tree from a node and finds under which Z-Wave NodeID/endpoint id it is located.

Parameters

node	The Attribute store node for which the parent Z-Wave NodeID/endpoint will be searched for
zwave_node_id	A pointer where to write the found Z-Wave NodeID (reported value)
zwave_endpoint_id	A pointer where to write the found Z-Wave endpoint id (reported value)

Returns

SL_STATUS_OK If both NodeID/endpoint parents nodes were found and their value were copied in the zwave_node_id and zwave_endpoint_id variables

SL_STATUS_NOT_FOUND If the function went all the way up to the tree root and did not find consecutive NodeID/endpoint attribute types

SL_STATUS_FAIL If some error occurred reading values in the tree.

Here is the caller graph for this function:

attribute_store_network_helper_get_zwave_node_id_node()

attribute_store_node_t attribute_store_network_helper_get_zwave_node_id_node

(

zwave_node_id_t

node_id

)

Take a Z-Wave NodeID and return its Attribute Store node representing the NodeID.

This function will convert the NodeID to UNID, ensuring that the returned Node representing the NodeID belongs to the same HomeiD as the ZPC

Parameters

node_id

The Z-Wave NodeID value to parse and search in the tree.

Returns

attribute_store_node_t representing the NodeID for the Z-Wave NodeID in the attribute store.

ATTRIBUTE_STORE_INVALID_NODE if no matching Z-Wave NodeID node exists

Here is the call graph for this function:

Here is the caller graph for this function:

zwave_command_class_get_endpoint_id_node()

attribute_store_node_t zwave_command_class_get_endpoint_id_node	(	zwave_node_id_t	node_id,
		zwave_endpoint_id_t	endpoint_id
	)

Gets the Attribute Store Endpoint ID node for a given Z-Wave NodeID / Endpoint ID in our network.

Parameters

node_id	Z-Wave NodeID to find in the attribute store
endpoint_id	Z-Wave Endpoint ID to find in the attribute store.

Returns

Attribute store node for the NodeID / Endpoint.

Here is the call graph for this function:

Here is the caller graph for this function: