Z-Wave Controller Internal definitions

Internal types and definitions for Z-Wave Controller. More...

Collaboration diagram for Z-Wave Controller Internal definitions:

Functions
void	zwave_controller_on_state_updated (zwave_network_management_state_t state)
	see zwave_controller_callbacks_t More...
void	zwave_controller_on_error (zwave_network_management_error_t error)
	see zwave_controller_callbacks_t More...
void	zwave_controller_on_node_id_assigned (zwave_node_id_t node_id, zwave_protocol_t inclusion_protocol)
	see zwave_controller_callbacks_t More...
void	zwave_controller_on_node_deleted (zwave_node_id_t node_id)
	see zwave_controller_callbacks_t More...
void	zwave_controller_on_node_info_req_failed (zwave_node_id_t node_id)
	see zwave_controller_callbacks_t More...
void	zwave_controller_on_frame_transmission (bool transmission_successful, const zwapi_tx_report_t *tx_status, zwave_node_id_t node_id)
	see zwave_controller_callbacks_t More...
void	zwave_controller_on_frame_reception (zwave_node_id_t node_id)
	Tell the Z-Wave Controller that we received a frame (Rx) from a NodeID. More...
void	zwave_controller_on_node_added (sl_status_t status, const zwave_node_info_t *nif, zwave_node_id_t node_id, zwave_dsk_t dsk, zwave_keyset_t granted_keys, zwave_kex_fail_type_t kex_fail_type, zwave_protocol_t inclusion_protocol)
	see zwave_controller_callbacks_t More...
void	zwave_controller_on_network_address_update (zwave_home_id_t home_id, zwave_node_id_t node_id)
	Tell the Z-Wave Controller to anounce to all other components that we changed network address. More...
void	zwave_controller_on_new_network_entered (zwave_home_id_t home_id, zwave_node_id_t node_id, zwave_keyset_t granted_keys, zwave_kex_fail_type_t kex_fail_type)
	see zwave_controller_callbacks_t More...
void	zwave_controller_on_keys_report (bool csa, zwave_keyset_t keys)
	see zwave_controller_callbacks_t More...
void	zwave_controller_on_dsk_report (uint8_t input_length, zwave_dsk_t dsk, zwave_keyset_t keys)
	see zwave_controller_callbacks_t More...
void	zwave_controller_on_frame_received (const zwave_controller_connection_info_t *connection_info, const zwave_rx_receive_options_t *rx_options, const uint8_t *frame_data, uint16_t frame_length)
	see zwave_controller_callbacks_t More...
void	zwave_controller_on_protocol_cc_encryption_request_received (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)
	see zwave_controller_callbacks_t More...
void	zwave_controller_on_smart_start_inclusion_request (uint32_t home_id, bool already_included, const zwave_node_info_t *node_info, zwave_protocol_t inclusion_protocol)
	see zwave_controller_callbacks_t More...
void	zwave_controller_on_node_information (zwave_node_id_t node_id, const zwave_node_info_t *node_info)
	see zwave_controller_callbacks_t More...
void	zwave_controller_on_new_suc (zwave_node_id_t suc_node_id)
	see zwave_controller_callbacks_t More...
void	zwave_controller_on_multicast_group_deleted (zwave_multicast_group_id_t group_id)
	see zwave_controller_callbacks_t More...
void	zwave_controller_on_request_neighbor_update (uint8_t status)
	see zwave_controller_callbacks_t More...
sl_status_t	zwave_controller_transport_send_data (const zwave_controller_connection_info_t *connection, uint16_t data_length, const uint8_t *data, const zwave_tx_options_t *tx_options, const on_zwave_tx_send_data_complete_t on_send_complete, void *user, zwave_tx_session_id_t session)
	Send a frame with transport plugin system. More...
sl_status_t	zwave_controller_transport_abort_send_data (zwave_tx_session_id_t session_id)
	Functions to abort the ongoing transport sessions. More...

Detailed Description

Internal types and definitions for Z-Wave Controller.

Function Documentation

zwave_controller_on_dsk_report()

void zwave_controller_on_dsk_report	(	uint8_t	input_length,
		zwave_dsk_t	dsk,
		zwave_keyset_t	keys
	)

see zwave_controller_callbacks_t

Here is the caller graph for this function:

zwave_controller_on_error()

void zwave_controller_on_error

(

zwave_network_management_error_t

error

)

see zwave_controller_callbacks_t

Here is the caller graph for this function:

zwave_controller_on_frame_received()

void zwave_controller_on_frame_received	(	const zwave_controller_connection_info_t *	connection_info,
		const zwave_rx_receive_options_t *	rx_options,
		const uint8_t *	frame_data,
		uint16_t	frame_length
	)

see zwave_controller_callbacks_t

Here is the call graph for this function:

Here is the caller graph for this function:

zwave_controller_on_frame_reception()

void zwave_controller_on_frame_reception

(

zwave_node_id_t

node_id

)

Tell the Z-Wave Controller that we received a frame (Rx) from a NodeID.

The Z-Wave Controller will invoke the on_rx_frame_received functions from the zwave_controller_callbacks_t

Parameters

node_id

The NodeID that sent the frame.

Here is the caller graph for this function:

zwave_controller_on_frame_transmission()

void zwave_controller_on_frame_transmission	(	bool	transmission_successful,
		const zwapi_tx_report_t *	tx_status,
		zwave_node_id_t	node_id
	)

see zwave_controller_callbacks_t

Here is the caller graph for this function:

zwave_controller_on_keys_report()

void zwave_controller_on_keys_report	(	bool	csa,
		zwave_keyset_t	keys
	)

see zwave_controller_callbacks_t

Here is the caller graph for this function:

zwave_controller_on_multicast_group_deleted()

void zwave_controller_on_multicast_group_deleted

(

zwave_multicast_group_id_t

group_id

)

see zwave_controller_callbacks_t

zwave_controller_on_network_address_update()

void zwave_controller_on_network_address_update	(	zwave_home_id_t	home_id,
		zwave_node_id_t	node_id
	)

Tell the Z-Wave Controller to anounce to all other components that we changed network address.

Parameters

home_id	Our new HomeID
node_id	Our new NodeID

Here is the caller graph for this function:

zwave_controller_on_new_network_entered()

void zwave_controller_on_new_network_entered	(	zwave_home_id_t	home_id,
		zwave_node_id_t	node_id,
		zwave_keyset_t	granted_keys,
		zwave_kex_fail_type_t	kex_fail_type
	)

see zwave_controller_callbacks_t

Here is the caller graph for this function:

zwave_controller_on_new_suc()

void zwave_controller_on_new_suc

(

zwave_node_id_t

suc_node_id

)

see zwave_controller_callbacks_t

Here is the caller graph for this function:

zwave_controller_on_node_added()

void zwave_controller_on_node_added	(	sl_status_t	status,
		const zwave_node_info_t *	nif,
		zwave_node_id_t	node_id,
		zwave_dsk_t	dsk,
		zwave_keyset_t	granted_keys,
		zwave_kex_fail_type_t	kex_fail_type,
		zwave_protocol_t	inclusion_protocol
	)

see zwave_controller_callbacks_t

Here is the call graph for this function:

Here is the caller graph for this function:

zwave_controller_on_node_deleted()

void zwave_controller_on_node_deleted

(

zwave_node_id_t

node_id

)

see zwave_controller_callbacks_t

Here is the caller graph for this function:

zwave_controller_on_node_id_assigned()

void zwave_controller_on_node_id_assigned	(	zwave_node_id_t	node_id,
		zwave_protocol_t	inclusion_protocol
	)

see zwave_controller_callbacks_t

Here is the call graph for this function:

Here is the caller graph for this function:

zwave_controller_on_node_info_req_failed()

void zwave_controller_on_node_info_req_failed

(

zwave_node_id_t

node_id

)

see zwave_controller_callbacks_t

Here is the caller graph for this function:

zwave_controller_on_node_information()

void zwave_controller_on_node_information	(	zwave_node_id_t	node_id,
		const zwave_node_info_t *	node_info
	)

see zwave_controller_callbacks_t

Here is the call graph for this function:

Here is the caller graph for this function:

zwave_controller_on_protocol_cc_encryption_request_received()

void zwave_controller_on_protocol_cc_encryption_request_received	(	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
	)

see zwave_controller_callbacks_t

Here is the caller graph for this function:

zwave_controller_on_request_neighbor_update()

void zwave_controller_on_request_neighbor_update

(

uint8_t

status

)

see zwave_controller_callbacks_t

Here is the caller graph for this function:

zwave_controller_on_smart_start_inclusion_request()

void zwave_controller_on_smart_start_inclusion_request	(	uint32_t	home_id,
		bool	already_included,
		const zwave_node_info_t *	node_info,
		zwave_protocol_t	inclusion_protocol
	)

see zwave_controller_callbacks_t

Here is the caller graph for this function:

zwave_controller_on_state_updated()

void zwave_controller_on_state_updated

(

zwave_network_management_state_t

state

)

see zwave_controller_callbacks_t

Here is the caller graph for this function:

zwave_controller_transport_abort_send_data()

sl_status_t zwave_controller_transport_abort_send_data

(

zwave_tx_session_id_t

session_id

)

Functions to abort the ongoing transport sessions.

Parameters

session_id

The Z-Wave Tx Session ID to abort.

Returns

SL_STATUS_NOT_FOUND if no abort was performed. SL_STATUS_OK if abort is ongoing.

zwave_controller_transport_send_data()

sl_status_t zwave_controller_transport_send_data	(	const zwave_controller_connection_info_t *	connection,
		uint16_t	data_length,
		const uint8_t *	data,
		const zwave_tx_options_t *	tx_options,
		const on_zwave_tx_send_data_complete_t	on_send_complete,
		void *	user,
		zwave_tx_session_id_t	session
	)

Send a frame with transport plugin system.

This function sends a frame with the transport system. It will return SL_STATUS_OK if the frame is consumed

Parameters

connection	see zwave_tx_send_data
data_length	see zwave_tx_send_data
data	see zwave_tx_send_data
tx_options	see zwave_tx_send_data
on_send_complete	see zwave_tx_send_data
user	see zwave_tx_send_data
session	see zwave_tx_send_data

Returns

sl_status_t Indicating the processing of the frame.

• SL_STATUS_OK indicates that the frame was accepted and encapsulated
• SL_STATUS_NOT_SUPPORTED indicates that transport has nothing to encapsulate, the frame is ready the Z-Wave API.
• SL_STATUS_WOULD_OVERFLOW indicates that transport should encapsulate the frame but cannot. Frame should be dropped.
• Any other error code (SL_STATUS_BUSY, SL_STATUS_FAIL, etc.) indicating that the frame should be encapsulated, but could not due to an error.

Here is the call graph for this function: