Z-Wave Protocol Controller Reference

Callbacks registration system that enables an application to provide some functions performing look-ups in the persistent storage system. More...

Collaboration diagram for Z-Wave Controller Storage:

Classes

struct  zwave_controller_storage_callback_t
 

Functions

sl_status_t zwave_controller_storage_callback_register (const zwave_controller_storage_callback_t *callbacks)
 zwave_controller_storage callbacks register API More...
 
sl_status_t zwave_controller_storage_as_set_node_s2_capable (zwave_node_id_t node_id)
 Set the Z-Wave node as s2 capable when it supports S2. More...
 
bool zwave_controller_storage_is_node_s2_capable (zwave_node_id_t node_id)
 Verify if the registered node is supporting S2. More...
 
zwave_cc_version_t zwave_controller_storage_get_cc_version (zwave_command_class_t command_class, zwave_node_id_t node_id, zwave_endpoint_id_t endpoint_id)
 Return the version of a Command Class implemented by a node. More...
 
sl_status_t zwave_controller_storage_get_node_granted_keys (zwave_node_id_t node_id, zwave_keyset_t *keys)
 Return the granted keys for a node. More...
 
zwave_protocol_t zwave_controller_storage_inclusion_protocol (zwave_node_id_t node_id)
 Returns the protocol that the node is running in this network. More...
 

Detailed Description

Callbacks registration system that enables an application to provide some functions performing look-ups in the persistent storage system.

Function Documentation

◆ zwave_controller_storage_as_set_node_s2_capable()

sl_status_t zwave_controller_storage_as_set_node_s2_capable ( zwave_node_id_t  node_id)

Set the Z-Wave node as s2 capable when it supports S2.

Parameters
node_idThe NodeID that supports S2.
Here is the caller graph for this function:

◆ zwave_controller_storage_callback_register()

sl_status_t zwave_controller_storage_callback_register ( const zwave_controller_storage_callback_t callbacks)

zwave_controller_storage callbacks register API

Parameters
callbackscallbacks pointer for the zwave_controller component.
Returns
SL_STATUS_OK if the callback pointer has been registered.
SL_STATUS_FAIL if the callback pointer is invalide

◆ zwave_controller_storage_get_cc_version()

zwave_cc_version_t zwave_controller_storage_get_cc_version ( zwave_command_class_t  command_class,
zwave_node_id_t  node_id,
zwave_endpoint_id_t  endpoint_id 
)

Return the version of a Command Class implemented by a node.

Parameters
command_classThe Command Class identifier for which the version is requested.
node_idThe NodeID for which the version is requested.
endpoint_idThe Endpoint for which the version is requested.
Returns
the version number of the Command Class. 0 if it is neither supported nor controlled.
Here is the caller graph for this function:

◆ zwave_controller_storage_get_node_granted_keys()

sl_status_t zwave_controller_storage_get_node_granted_keys ( zwave_node_id_t  node_id,
zwave_keyset_t keys 
)

Return the granted keys for a node.

Parameters
[in]node_idZ-Wave NodeID of the node
[out]keysPointer where to write granted keys.
Here is the caller graph for this function:

◆ zwave_controller_storage_inclusion_protocol()

zwave_protocol_t zwave_controller_storage_inclusion_protocol ( zwave_node_id_t  node_id)

Returns the protocol that the node is running in this network.

This function will return the protocol that has been used for including a node in our network.

Parameters
node_idThe NodeID for which the operating protocol is requested
Here is the caller graph for this function:

◆ zwave_controller_storage_is_node_s2_capable()

bool zwave_controller_storage_is_node_s2_capable ( zwave_node_id_t  node_id)

Verify if the registered node is supporting S2.

Parameters
node_idThe NodeID that supports S2.
Returns
True if the node has been registered to support S2, false otherwise
Here is the caller graph for this function: