Functions for controlling COMMAND_CLASS_DOOR_LOCK. More...

Collaboration diagram for Command handlers for COMMAND_CLASS_DOOR_LOCK:

Macros
#define	COMMAND_CLASS_DOOR_LOCK_VERSION 2
	Version of COMMAND_CLASS_DOOR_LOCK which this handlers is genrated for. More...

Functions
sl_status_t	zwave_COMMAND_CLASS_DOOR_LOCK_init ()
	Initialisation of COMMAND_CLASS_DOOR_LOCK. More...

sl_status_t	zwave_DOOR_LOCK_CONFIGURATION_REPORT_handle_report_command_override (const zwave_controller_connection_info_t connection_info, const uint8_t frame, uint16_t frame_length)
	Override function for DOOR_LOCK_CONFIGURATION_REPORT. More...

sl_status_t	zwave_DOOR_LOCK_OPERATION_REPORT_handle_report_command_override (const zwave_controller_connection_info_t connection_info, const uint8_t frame, uint16_t frame_length)
	Override function for DOOR_LOCK_OPERATION_REPORT. More...

sl_status_t	zwave_DOOR_LOCK_CONFIGURATION_GET (attribute_store_node_t _node, uint8_t frame, uint16_t frame_len)
	Auto-generated function for DOOR_LOCK_CONFIGURATION_GET. More...

sl_status_t	zwave_DOOR_LOCK_CONFIGURATION_GET_override (attribute_store_node_t _node, uint8_t frame, uint16_t frame_len)
	Override function for DOOR_LOCK_CONFIGURATION_GET. More...

sl_status_t	zwave_DOOR_LOCK_OPERATION_GET (attribute_store_node_t _node, uint8_t frame, uint16_t frame_len)
	Auto-generated function for DOOR_LOCK_OPERATION_GET. More...

sl_status_t	zwave_DOOR_LOCK_OPERATION_GET_override (attribute_store_node_t _node, uint8_t frame, uint16_t frame_len)
	Override function for DOOR_LOCK_OPERATION_GET. More...

sl_status_t	zwave_DOOR_LOCK_CONFIGURATION_SET (attribute_store_node_t _node, uint8_t frame, uint16_t frame_len)
	Auto-generated function for DOOR_LOCK_CONFIGURATION_SET. More...

sl_status_t	zwave_DOOR_LOCK_CONFIGURATION_SET_override (attribute_store_node_t _node, uint8_t frame, uint16_t frame_len)
	Override function for DOOR_LOCK_CONFIGURATION_SET. More...

sl_status_t	zwave_DOOR_LOCK_OPERATION_SET (attribute_store_node_t _node, uint8_t frame, uint16_t frame_len)
	Auto-generated function for DOOR_LOCK_OPERATION_SET. More...

sl_status_t	zwave_DOOR_LOCK_OPERATION_SET_override (attribute_store_node_t _node, uint8_t frame, uint16_t frame_len)
	Override function for DOOR_LOCK_OPERATION_SET. More...

Detailed Description

Functions for controlling COMMAND_CLASS_DOOR_LOCK.

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

#define COMMAND_CLASS_DOOR_LOCK_VERSION 2

Version of COMMAND_CLASS_DOOR_LOCK which this handlers is genrated for.

Function Documentation

◆ zwave_COMMAND_CLASS_DOOR_LOCK_init()

sl_status_t zwave_COMMAND_CLASS_DOOR_LOCK_init ( )

Initialisation of COMMAND_CLASS_DOOR_LOCK.

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

◆ zwave_DOOR_LOCK_CONFIGURATION_GET()

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

Auto-generated function for DOOR_LOCK_CONFIGURATION_GET.

This function provide automatic handling of the DOOR_LOCK_CONFIGURATION_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_DOOR_LOCK_CONFIGURATION_GET_override()

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

Override function for DOOR_LOCK_CONFIGURATION_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_DOOR_LOCK_CONFIGURATION_REPORT_handle_report_command_override()

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

Override function for DOOR_LOCK_CONFIGURATION_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_DOOR_LOCK_CONFIGURATION_SET()

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

Auto-generated function for DOOR_LOCK_CONFIGURATION_SET.

This function provide automatic handling of the DOOR_LOCK_CONFIGURATION_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_DOOR_LOCK_CONFIGURATION_SET_override()

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

Override function for DOOR_LOCK_CONFIGURATION_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_DOOR_LOCK_OPERATION_GET()

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

Auto-generated function for DOOR_LOCK_OPERATION_GET.

This function provide automatic handling of the DOOR_LOCK_OPERATION_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_DOOR_LOCK_OPERATION_GET_override()

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

Override function for DOOR_LOCK_OPERATION_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_DOOR_LOCK_OPERATION_REPORT_handle_report_command_override()

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

Override function for DOOR_LOCK_OPERATION_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_DOOR_LOCK_OPERATION_SET()

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

Auto-generated function for DOOR_LOCK_OPERATION_SET.

This function provide automatic handling of the DOOR_LOCK_OPERATION_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_DOOR_LOCK_OPERATION_SET_override()

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

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

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ COMMAND_CLASS_DOOR_LOCK_VERSION

Function Documentation

◆ zwave_COMMAND_CLASS_DOOR_LOCK_init()

◆ zwave_DOOR_LOCK_CONFIGURATION_GET()

◆ zwave_DOOR_LOCK_CONFIGURATION_GET_override()

◆ zwave_DOOR_LOCK_CONFIGURATION_REPORT_handle_report_command_override()

◆ zwave_DOOR_LOCK_CONFIGURATION_SET()

◆ zwave_DOOR_LOCK_CONFIGURATION_SET_override()

◆ zwave_DOOR_LOCK_OPERATION_GET()

◆ zwave_DOOR_LOCK_OPERATION_GET_override()

◆ zwave_DOOR_LOCK_OPERATION_REPORT_handle_report_command_override()

◆ zwave_DOOR_LOCK_OPERATION_SET()

◆ zwave_DOOR_LOCK_OPERATION_SET_override()