Command handlers for COMMAND_CLASS_INDICATOR

Functions for controlling COMMAND_CLASS_INDICATOR. More...

Collaboration diagram for Command handlers for COMMAND_CLASS_INDICATOR:

Macros
#define	COMMAND_CLASS_INDICATOR_VERSION   3
	Version of COMMAND_CLASS_INDICATOR which this handlers is genrated for. More...

Functions
void	zwave_COMMAND_CLASS_INDICATOR_add_INDICATOR_INDICATOR_ID (attribute_store_node_t parent, uint8_t index)
	Add INDICATOR_INDICATOR_ID and its mandatory children to a parent. More...
sl_status_t	zwave_COMMAND_CLASS_INDICATOR_init ()
	Initialisation of COMMAND_CLASS_INDICATOR. More...
sl_status_t	zwave_INDICATOR_REPORT_handle_report_command_override (const zwave_controller_connection_info_t *connection_info, const uint8_t *frame, uint16_t frame_length)
	Override function for INDICATOR_REPORT. More...
sl_status_t	zwave_INDICATOR_SUPPORTED_REPORT_handle_report_command_override (const zwave_controller_connection_info_t *connection_info, const uint8_t *frame, uint16_t frame_length)
	Override function for INDICATOR_SUPPORTED_REPORT. More...
sl_status_t	zwave_INDICATOR_GET (attribute_store_node_t _node, uint8_t *frame, uint16_t *frame_len)
	Auto-generated function for INDICATOR_GET. More...
sl_status_t	zwave_INDICATOR_GET_override (attribute_store_node_t _node, uint8_t *frame, uint16_t *frame_len)
	Override function for INDICATOR_GET. More...
sl_status_t	zwave_INDICATOR_SUPPORTED_GET (attribute_store_node_t _node, uint8_t *frame, uint16_t *frame_len)
	Auto-generated function for INDICATOR_SUPPORTED_GET. More...
sl_status_t	zwave_INDICATOR_SUPPORTED_GET_override (attribute_store_node_t _node, uint8_t *frame, uint16_t *frame_len)
	Override function for INDICATOR_SUPPORTED_GET. More...
sl_status_t	zwave_INDICATOR_SET (attribute_store_node_t _node, uint8_t *frame, uint16_t *frame_len)
	Auto-generated function for INDICATOR_SET. More...
sl_status_t	zwave_INDICATOR_SET_override (attribute_store_node_t _node, uint8_t *frame, uint16_t *frame_len)
	Override function for INDICATOR_SET. More...

Detailed Description

Functions for controlling COMMAND_CLASS_INDICATOR.

This module implement functions for generating and parsing the Z-Wave frames for controlling COMMAND_CLASS_INDICATOR. 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_INDICATOR_VERSION

#define COMMAND_CLASS_INDICATOR_VERSION   3

Version of COMMAND_CLASS_INDICATOR which this handlers is genrated for.

Function Documentation

zwave_COMMAND_CLASS_INDICATOR_add_INDICATOR_INDICATOR_ID()

void zwave_COMMAND_CLASS_INDICATOR_add_INDICATOR_INDICATOR_ID	(	attribute_store_node_t	parent,
		uint8_t	index
	)

Add INDICATOR_INDICATOR_ID and its mandatory children to a parent.

This function will add an attribute of type INDICATOR_INDICATOR_ID under the given parent attribute. The value of the new attribute set to index, and the manetory children are also created under the new attribute, considering the commad class version.

Parameters

parent	attribute store node to add children to.
index	Index of the new attribute subtree to created

zwave_COMMAND_CLASS_INDICATOR_init()

sl_status_t zwave_COMMAND_CLASS_INDICATOR_init

(

)

Initialisation of COMMAND_CLASS_INDICATOR.

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

zwave_INDICATOR_GET()

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

Auto-generated function for INDICATOR_GET.

This function provide automatic handling of the INDICATOR_GET command.

Parameters

_node	Attribute to genrate the set frame from.
frame	Pointer to frame data which should be written into
frame_len	Length 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_INDICATOR_GET_override()

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

Override function for INDICATOR_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

_node	Attribute to genrate the get frame from.
frame	Pointer to frame data which should be written into
frame_len	Length 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_INDICATOR_REPORT_handle_report_command_override()

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

Override function for INDICATOR_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.

zwave_INDICATOR_SET()

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

Auto-generated function for INDICATOR_SET.

This function provide automatic handling of the INDICATOR_SET command.

Parameters

_node	Attribute to genrate the set frame from.
frame	Pointer to frame data which should be written into
frame_len	Length 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_INDICATOR_SET_override()

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

Override function for INDICATOR_SET.

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

_node	Attribute to genrate the set frame from.
frame	Pointer to frame data which should be written into
frame_len	Length 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_INDICATOR_SUPPORTED_GET()

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

Auto-generated function for INDICATOR_SUPPORTED_GET.

This function provide automatic handling of the INDICATOR_SUPPORTED_GET command.

Parameters

_node	Attribute to genrate the set frame from.
frame	Pointer to frame data which should be written into
frame_len	Length 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_INDICATOR_SUPPORTED_GET_override()

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

Override function for INDICATOR_SUPPORTED_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

_node	Attribute to genrate the get frame from.
frame	Pointer to frame data which should be written into
frame_len	Length 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_INDICATOR_SUPPORTED_REPORT_handle_report_command_override()

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

Override function for INDICATOR_SUPPORTED_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.