Z-Wave Protocol Controller Reference
Command handlers for COMMAND_CLASS_ZWAVEPLUS_INFO

Functions for controlling COMMAND_CLASS_ZWAVEPLUS_INFO. More...

Collaboration diagram for Command handlers for COMMAND_CLASS_ZWAVEPLUS_INFO:

Macros

#define COMMAND_CLASS_ZWAVEPLUS_INFO_VERSION   2
 Version of COMMAND_CLASS_ZWAVEPLUS_INFO which this handlers is genrated for. More...
 

Functions

sl_status_t zwave_COMMAND_CLASS_ZWAVEPLUS_INFO_init ()
 Initialisation of COMMAND_CLASS_ZWAVEPLUS_INFO. More...
 
sl_status_t zwave_ZWAVEPLUS_INFO_REPORT_handle_report_command_override (const zwave_controller_connection_info_t *connection_info, const uint8_t *frame, uint16_t frame_length)
 Override function for ZWAVEPLUS_INFO_REPORT. More...
 
sl_status_t zwave_ZWAVEPLUS_INFO_GET (attribute_store_node_t _node, uint8_t *frame, uint16_t *frame_len)
 Auto-generated function for ZWAVEPLUS_INFO_GET. More...
 
sl_status_t zwave_ZWAVEPLUS_INFO_GET_override (attribute_store_node_t _node, uint8_t *frame, uint16_t *frame_len)
 Override function for ZWAVEPLUS_INFO_GET. More...
 

Detailed Description

Functions for controlling COMMAND_CLASS_ZWAVEPLUS_INFO.

This module implement functions for generating and parsing the Z-Wave frames for controlling COMMAND_CLASS_ZWAVEPLUS_INFO. The module builds frames by reading data from the attribute according to the tree data model shown below. When data is received is will also update the attribute store with data again according the the model described below.

In addition the module will react on the on_version update events from the attribute store to and insert required attributes into to attribute store. A set of helper functions for inserting attribute for more complex data is also provided. The complex data are generally data dependign on some sort of index.

Macro Definition Documentation

◆ COMMAND_CLASS_ZWAVEPLUS_INFO_VERSION

#define COMMAND_CLASS_ZWAVEPLUS_INFO_VERSION   2

Version of COMMAND_CLASS_ZWAVEPLUS_INFO which this handlers is genrated for.

Function Documentation

◆ zwave_COMMAND_CLASS_ZWAVEPLUS_INFO_init()

sl_status_t zwave_COMMAND_CLASS_ZWAVEPLUS_INFO_init ( )

Initialisation of COMMAND_CLASS_ZWAVEPLUS_INFO.

This function registers the command handler with the attribute resolver and the command handler framework.

Here is the caller graph for this function:

◆ zwave_ZWAVEPLUS_INFO_GET()

sl_status_t zwave_ZWAVEPLUS_INFO_GET ( attribute_store_node_t  _node,
uint8_t *  frame,
uint16_t *  frame_len 
)

Auto-generated function for ZWAVEPLUS_INFO_GET.

This function provide automatic handling of the ZWAVEPLUS_INFO_GET command.

Parameters
_nodeAttribute to genrate the set frame from.
framePointer to frame data which should be written into
frame_lenLength of the generated frame. I this is 0 on exit the auto generated code is executed otherwise it is not.
Returns
Return code to send to the resolver.

◆ zwave_ZWAVEPLUS_INFO_GET_override()

sl_status_t zwave_ZWAVEPLUS_INFO_GET_override ( attribute_store_node_t  _node,
uint8_t *  frame,
uint16_t *  frame_len 
)

Override function for ZWAVEPLUS_INFO_GET.

This if this function is implemented as a weak symbol. This provided such an external component can modify the behaviour of the auto generated code.

Parameters
_nodeAttribute to genrate the get frame from.
framePointer to frame data which should be written into
frame_lenLength of the generated frame. I this is 0 on exit the auto generated code is executed otherwise it is not.
Returns
Return code to send to the resolver.

◆ zwave_ZWAVEPLUS_INFO_REPORT_handle_report_command_override()

sl_status_t zwave_ZWAVEPLUS_INFO_REPORT_handle_report_command_override ( const zwave_controller_connection_info_t connection_info,
const uint8_t *  frame,
uint16_t  frame_length 
)

Override function for ZWAVEPLUS_INFO_REPORT.

This if this function is implemented as a weak symbol. This provided such an external component can modifiy the behaviour of the generated code.

Returns
If not SL_STATUS_OK the auto generated hander is executed after this.