zwave_tx.h File Reference

#include "sl_status.h"
#include "zwave_controller_connection_info.h"
#include "zwapi_protocol_transport.h"
#include "zwapi_protocol_basis.h"
#include "zwave_tx_definitions.h"

Include dependency graph for zwave_tx.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	ZWAVE_TX_QUEUE_BUFFER_SIZE   64
#define	ZWAVE_TX_INCOMING_FRAMES_BUFFER_SIZE   10
#define	ZWAVE_TX_ROUTE_CACHE_BUFFER_SIZE   50

Typedefs
typedef void(*	on_zwave_tx_send_data_complete_t) (uint8_t status, const zwapi_tx_report_t *tx_info, void *user)
	Function signature for callbacks invoked when send data has completed. More...

Functions
sl_status_t	zwave_tx_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)
	Queue and send frames to Z-Wave nodes. More...
sl_status_t	zwave_tx_send_test_frame (zwave_node_id_t destination_node_id, rf_power_level_t power_level, const on_zwave_tx_send_data_complete_t on_send_complete, void *user, zwave_tx_session_id_t *session_id)
	Queues and send a test frame to a Z-Wave node. More...
sl_status_t	zwave_tx_abort_transmission (zwave_tx_session_id_t session_id)
	Abort a queued or ongoing transmission. More...
uint8_t	zwave_tx_get_number_of_responses (zwave_tx_session_id_t session_id)
	Returns the total number of responses that a frame (and its parent) will generate *. More...
void	zwave_tx_set_expected_frames (zwave_node_id_t remote_node_id, uint8_t number_of_incoming_frames)
	Tell the Tx Queue that a remote NodeID is about to send some frames and we should back-off a little more. More...
const uint8_t *	zwave_tx_get_frame (zwave_tx_session_id_t session_id)
	Returns a pointer to frame data for a given Z-Wave Tx session ID. More...
uint16_t	zwave_tx_get_frame_length (zwave_tx_session_id_t session_id)
	Returns the length of a frame in the Z-Wave Tx Queue. More...
bool	zwave_tx_has_frames_for_node (zwave_node_id_t node_id)
	Verifies if we have frames in the queue to send to a NodeID. More...
sl_status_t	zwave_tx_init ()
	Initialize the zwave_tx component. More...
void	zwave_tx_log_queue (bool with_contents)
	Log the contents of the TX Queue. More...
void	zwave_tx_log_element (zwave_tx_session_id_t session_id, bool log_frame_payload)
	Log the details about an element in the Tx Queue. More...
int	zwave_tx_get_queue_size ()
	Returns the current number of elements in the Tx Queue. More...

Macro Definition Documentation

ZWAVE_TX_INCOMING_FRAMES_BUFFER_SIZE

#define ZWAVE_TX_INCOMING_FRAMES_BUFFER_SIZE   10

ZWAVE_TX_QUEUE_BUFFER_SIZE

#define ZWAVE_TX_QUEUE_BUFFER_SIZE   64

ZWAVE_TX_ROUTE_CACHE_BUFFER_SIZE

#define ZWAVE_TX_ROUTE_CACHE_BUFFER_SIZE   50