Z-Wave RX Z-Wave API Callbacks

List of Z-Wave RX callbacks that are registered to the Z-Wave API and used to call Z-Wave RX callbacks ( Z-Wave RX ). More...

Collaboration diagram for Z-Wave RX Z-Wave API Callbacks:

Functions
void	zwave_rx_application_command_handler (uint8_t rx_status, zwave_node_id_t destination_node_id, zwave_node_id_t source_node_id, const uint8_t *zwave_command_payload, uint8_t zwave_command_payload_length, int8_t rssi_value)
	application_command_handler function for zwapi_callbacks. Z-Wave API controller libraries will call this function for incoming frames from the Z-Wave nodes (e.g. Basic Report) will be dispatched to this function. More...
void	zwave_rx_protocol_cc_encryption_request (const zwave_node_id_t destination_node_id, const uint8_t payload_length, const uint8_t *const payload, const uint8_t protocol_metadata_length, const uint8_t *const protocol_metadata, const uint8_t use_supervision, const uint8_t session_id)
	protocol_cc_encryption_request function for zwapi_callbacks. Z-Wave API controller libraries will call this function for incoming protocol command class frame from the Z-Wave controller will be dispatched to this function. More...
void	zwave_rx_application_command_handler_bridge (uint8_t rx_status, zwave_node_id_t destination_node_id, zwave_node_id_t source_node_id, const uint8_t *zwave_command_payload, uint8_t zwave_command_payload_length, int8_t rssi_value)
	application_command_handler_bridge function for zwapi_callbacks. Z-Wave API Bridge libraries will call this function instead of application_command_handler(). Incoming frames from the Z-Wave nodes (e.g. Basic Report) will be dispatched to this function. More...
void	zwave_rx_application_controller_update (uint8_t status, zwave_node_id_t node_id, const uint8_t *zwave_nif, uint8_t zwave_nif_length, zwave_home_id_t nwi_home_id)
	application_controller_update function for zwapi_callbacks. Incoming NIF from the Z-Wave nodes will be dispatched to this function. More...
void	zwave_rx_zwave_api_started (const uint8_t *buffer, uint8_t buffer_length)
	functions handling when the Z-Wave API is ready to use. This is called after soft reset. See zwapi_callbacks More...
void	zwave_rx_poll_request ()
	Request call zwapi_poll again. More...

Detailed Description

List of Z-Wave RX callbacks that are registered to the Z-Wave API and used to call Z-Wave RX callbacks ( Z-Wave RX ).

These callbacks are an intermediate step between the Z-Wave API and the next application layers. Some mapping is done and data is validated/filtered, so that the right handlers are called based on what was received from the Z-Wave API

Function Documentation

zwave_rx_application_command_handler()

void zwave_rx_application_command_handler	(	uint8_t	rx_status,
		zwave_node_id_t	destination_node_id,
		zwave_node_id_t	source_node_id,
		const uint8_t *	zwave_command_payload,
		uint8_t	zwave_command_payload_length,
		int8_t	rssi_value
	)

application_command_handler function for zwapi_callbacks. Z-Wave API controller libraries will call this function for incoming frames from the Z-Wave nodes (e.g. Basic Report) will be dispatched to this function.

Parameters are described in application_command_handler_function

Here is the call graph for this function:

Here is the caller graph for this function:

zwave_rx_application_command_handler_bridge()

void zwave_rx_application_command_handler_bridge	(	uint8_t	rx_status,
		zwave_node_id_t	destination_node_id,
		zwave_node_id_t	source_node_id,
		const uint8_t *	zwave_command_payload,
		uint8_t	zwave_command_payload_length,
		int8_t	rssi_value
	)

application_command_handler_bridge function for zwapi_callbacks. Z-Wave API Bridge libraries will call this function instead of application_command_handler(). Incoming frames from the Z-Wave nodes (e.g. Basic Report) will be dispatched to this function.

Parameters are described in application_command_handler_function

Here is the call graph for this function:

Here is the caller graph for this function:

zwave_rx_application_controller_update()

void zwave_rx_application_controller_update	(	uint8_t	status,
		zwave_node_id_t	node_id,
		const uint8_t *	zwave_nif,
		uint8_t	zwave_nif_length,
		zwave_home_id_t	nwi_home_id
	)

application_controller_update function for zwapi_callbacks. Incoming NIF from the Z-Wave nodes will be dispatched to this function.

Parameters are described in application_controller_update_function

Here is the call graph for this function:

Here is the caller graph for this function:

zwave_rx_poll_request()

void zwave_rx_poll_request

(

)

Request call zwapi_poll again.

Here is the caller graph for this function:

zwave_rx_protocol_cc_encryption_request()

void zwave_rx_protocol_cc_encryption_request	(	const zwave_node_id_t	destination_node_id,
		const uint8_t	payload_length,
		const uint8_t *const	payload,
		const uint8_t	protocol_metadata_length,
		const uint8_t *const	protocol_metadata,
		const uint8_t	use_supervision,
		const uint8_t	session_id
	)

protocol_cc_encryption_request function for zwapi_callbacks. Z-Wave API controller libraries will call this function for incoming protocol command class frame from the Z-Wave controller will be dispatched to this function.

Here is the call graph for this function:

Here is the caller graph for this function:

zwave_rx_zwave_api_started()

void zwave_rx_zwave_api_started	(	const uint8_t *	buffer,
		uint8_t	buffer_length
	)

functions handling when the Z-Wave API is ready to use. This is called after soft reset. See zwapi_callbacks

This function will configure the NodeID base type again with the Z-Wave API module and ensure that no network management operation in ongoing.

Parameters

buffer	Contains the payload of the currently configured NIF for the Z-Wave module
buffer_length	Indicates the length in bytes of the data contained in the buffer pointer.

Here is the call graph for this function:

Here is the caller graph for this function: