Transport for the Z-Wave API. More...

Collaboration diagram for Z-Wave API Transport:

Classes
struct	send_data_state

Macros
#define	ZWAVE_API_MAXIMUM_FRAME_LENGTH 255

#define	INVALID_NODE_ID 0

#define	SEND_DATA_EMERGENCY_TIMEOUT 65

Typedefs
typedef struct send_data_state	send_data_state_t

Enumerations
enum	zwave_api_transport_events_t { ZWAVE_API_TRANSPORT_START_TIMER }
	Event definitions for the Z-Wave API transport Process. More...

Functions
sl_status_t	zwave_api_transport_init (void)
	Initialize the Z-Wave API Transport *. More...

void	zwave_api_transport_reset ()
	Resets the state of the Z-Wave API transport. More...

Detailed Description

Transport for the Z-Wave API.

Macro Definition Documentation

◆ INVALID_NODE_ID

#define INVALID_NODE_ID 0

◆ SEND_DATA_EMERGENCY_TIMEOUT

#define SEND_DATA_EMERGENCY_TIMEOUT 65

The maximum time in seconds that we will wait for a zwapi_send_data callback from the Z-Wave API

◆ ZWAVE_API_MAXIMUM_FRAME_LENGTH

#define ZWAVE_API_MAXIMUM_FRAME_LENGTH 255

Typedef Documentation

◆ send_data_state_t

typedef struct send_data_state send_data_state_t

Enumeration Type Documentation

◆ zwave_api_transport_events_t

enum zwave_api_transport_events_t

Event definitions for the Z-Wave API transport Process.

Enumerator
ZWAVE_API_TRANSPORT_START_TIMER	Send the next message in the TX Queue.

Function Documentation

◆ zwave_api_transport_init()

sl_status_t zwave_api_transport_init ( void )

Initialize the Z-Wave API Transport *.

Returns: SL_STATUS_OK if successful; SL_STATUS_FAIL if an error occurred

Here is the call graph for this function:

Here is the caller graph for this function:

◆ zwave_api_transport_reset()

void zwave_api_transport_reset ( )

Resets the state of the Z-Wave API transport.

This function will invoke the user callback of the ongoing transmission with TRANSMIT_STATUS_FAIL if a transmission is ongoing. No call to Z-Wave API send data abort is made when using this function.

Use this function, for example, when restarting the Z-Wave API or expecting that it may not callback after invoking Z-Wave API send data.