Transport Service Transport Wrapper

Wrapper for the Transport Service Command Class Transport. More...

Collaboration diagram for Transport Service Transport Wrapper:

Modules
	Transport Service
	Transport for Transport Service Command Class.

Functions
sl_status_t	zwave_transport_service_transport_init ()
sl_status_t	zwave_transport_service_send_data (const zwave_controller_connection_info_t *connection, uint16_t data_length, const uint8_t *cmd_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 parent_session_id)
	Sending a frame with Transport service. More...
sl_status_t	zwave_transport_service_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)
	Entry point of Transport service frames received from the PHY/radio stack. More...

Detailed Description

Wrapper for the Transport Service Command Class Transport.

Function Documentation

zwave_transport_service_on_frame_received()

sl_status_t zwave_transport_service_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
	)

Entry point of Transport service frames received from the PHY/radio stack.

Parameters

connection_info	Information about sender.
rx_options	Receive options
frame_data	S0 control frame data
frame_length	S0 control frame length

Returns

SL_STATUS_OK If frame is accepted

SL_STATUS_FAIL If frame can not be processed

SL_STATUS_NOT_SUPPORTED If frame is not Tranport service

SL_STATUS_NOT_FOUND If command of transport service frame is unknown

SL_STATUS_WOULD_OVERFLOW If frame size if bigger than what transport service can handle

Here is the call graph for this function:

Here is the caller graph for this function:

zwave_transport_service_send_data()

sl_status_t zwave_transport_service_send_data	(	const zwave_controller_connection_info_t *	connection,
		uint16_t	data_length,
		const uint8_t *	cmd_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	parent_session_id
	)

Sending a frame with Transport service.

This function will split a message bigger than maximum zwave frame size into smaller frames that can fit into z-wave frame and send it with Transport service protocol

Parameters

connection	Contains information about target node.
data_length	Length of un-encrypted data.
cmd_data	un-encrypted data to send
tx_options	Transmit options. The number_of_responses field determines if S0 verify delivery is going to be used
on_send_complete	Callback for the transmission complete event.
user	User pointer
parent_session_id	Parent session id of this session

Returns

sl_status_t

• SL_STATUS_OK on success
• SL_STATUS_BUSY if a tranmission is ongoing.
• SL_STATUS_WOULD_OVERFLOW if we cannot handle the frame and it should just be dropped.

Here is the call graph for this function:

Here is the caller graph for this function:

zwave_transport_service_transport_init()

sl_status_t zwave_transport_service_transport_init

(

)

Here is the call graph for this function:

Here is the caller graph for this function: