Z-Wave Protocol Controller Reference
ZPC Attribute Store

attribute_store functions specifically for ZPC More...

Collaboration diagram for ZPC Attribute Store:

Modules

 List of defined attributes types
 List of defines Attribute Types for the attribute store.
 
 Type definitions for attribute storage of Command Classes
 Type definitions for Command Classes, used for attribute_store storage.
 
 ZPC Attribute Store Z-Wave Network Helpers
 Helper functions to read find out HomeID / NodeID / Endpoints nodes in the attribute_store.
 
 ZPC attribute store default type data
 Registers attribute store types for all types defines in the header files.
 
 ZPC attribute store known attribute types
 Lists and registers all attribute types.
 

Functions

bool is_zpc_unid (const unid_t unid)
 Verify if a UNID is the ZPC's UNID. More...
 
attribute_store_node_t get_zpc_network_node ()
 Returns the HomeID (attribute store) node of our current network. More...
 
attribute_store_node_t get_zpc_node_id_node ()
 Returns the NodeID (attribute store) node of our current network / NodeID. More...
 
attribute_store_node_t get_zpc_endpoint_id_node (zwave_endpoint_id_t endpoint_id)
 Returns the Endpoint ID (attribute store) node of our current network / NodeID for a specified Endpoint ID. More...
 
sl_status_t zpc_attribute_store_init (void)
 Initialize attribute store specifically for ZPC. More...
 

Detailed Description

attribute_store functions specifically for ZPC

Function Documentation

◆ get_zpc_endpoint_id_node()

attribute_store_node_t get_zpc_endpoint_id_node ( zwave_endpoint_id_t  endpoint_id)

Returns the Endpoint ID (attribute store) node of our current network / NodeID for a specified Endpoint ID.

NOTE: This function requires network management to be initialized to work properly.

Returns
The Endpoint ID attribute store node. ATTRIBUTE_STORE_INVALID_NODE if the attribute store does not have our HomeID, NodeID or Endpoint ID node.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_zpc_network_node()

attribute_store_node_t get_zpc_network_node ( )

Returns the HomeID (attribute store) node of our current network.

NOTE: This function requires network management to be initialized to work properly.

Returns
The HomeID attribute store node. ATTRIBUTE_STORE_INVALID_NODE if the attribute store does not have our HomeID node.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_zpc_node_id_node()

attribute_store_node_t get_zpc_node_id_node ( )

Returns the NodeID (attribute store) node of our current network / NodeID.

NOTE: This function requires network management to be initialized to work properly.

Returns
The HomeID attribute store node. ATTRIBUTE_STORE_INVALID_NODE if the attribute store does not have our HomeID node.
The NodeID attribute store node. ATTRIBUTE_STORE_INVALID_NODE if the attribute store does not have our HomeID or NodeID node.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ is_zpc_unid()

bool is_zpc_unid ( const unid_t  unid)

Verify if a UNID is the ZPC's UNID.

NOTE: This function requires network management to be initialized to work properly.

Parameters
unidThe UNID to compare with our UNID.
Returns
true if the unid passed in argument is our unid. false otherwise.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ zpc_attribute_store_init()

sl_status_t zpc_attribute_store_init ( void  )

Initialize attribute store specifically for ZPC.

Refreshes all callbacks for HOME_ID children.

Returns
SL_STATUS_OK if all callbacks was initialized.
SL_STATUS_FAIL if invokking any callback fails.
Here is the call graph for this function: