Z-Wave Transport API

Z-Wave Transport Application layer interface. More...

Collaboration diagram for Z-Wave Transport API:

Topics
	Transmit Options
	Transmit frame option flags.
	Receive Status
	Status codes for receiving frames.
	Transmit complete codes

Data Structures
struct	s_rssi_val
struct	_S_ROUTE_LINK_T_
struct	_TX_STATUS_TYPE_
struct	_RECEIVE_OPTIONS_TYPE
struct	_TRANSMIT_OPTIONS_TYPE
struct	_TRANSMIT_MULTI_OPTIONS_TYPE

Macros
#define	ZW_MAX_NODES   232
#define	ZW_MAX_NODES_LR   1024
#define	LOWEST_LONG_RANGE_NODE_ID   (0x0100)
#define	HIGHEST_LONG_RANGE_NODE_ID   (LOWEST_LONG_RANGE_NODE_ID + ZW_MAX_NODES_LR - 1)
#define	NODEPARM_MAX   35
	max. number of parameters
#define	HOMEID_LENGTH   4
	Number of bytes in a homeID.
#define	NODE_BROADCAST   0xFF
	broadcast
#define	ZW_TEST_NOT_A_NODEID   0x00
#define	ZW_MAX_CACHED_RETURN_ROUTE_DESTINATIONS   5
#define	MAX_REPEATERS   4
#define	LAST_USED_ROUTE_CONF_SIZE   1
#define	LAST_USED_ROUTE_SIZE   (MAX_REPEATERS + LAST_USED_ROUTE_CONF_SIZE)
#define	S2_TXOPTION_VERIFY_DELIVERY   1
#define	S2_TXOPTION_SINGLECAST_FOLLOWUP   2
#define	S2_TXOPTION_FIRST_SINGLECAST_FOLLOWUP   4

Typedefs
typedef uint32_t	TxOptions_t
	The universal TX-Option flag count.
typedef struct _S_ROUTE_LINK_T_	S_ROUTE_LINK_T
typedef struct _TX_STATUS_TYPE_	TX_STATUS_TYPE
typedef struct _RECEIVE_OPTIONS_TYPE	RECEIVE_OPTIONS_TYPE
typedef struct _TRANSMIT_OPTIONS_TYPE	TRANSMIT_OPTIONS_TYPE
typedef struct _TRANSMIT_MULTI_OPTIONS_TYPE	TRANSMIT_MULTI_OPTIONS_TYPE

Detailed Description

Z-Wave Transport Application layer interface.

The Z Wave transport layer controls transfer of data between Z Wave nodes including retransmission, frame check and acknowledgement. The Z Wave transport interface includes functions for transfer of data to other Z Wave nodes. Application data received from other nodes is handed over to the application via ApplicationCommandHandler(). The ZW_MAX_NODES define defines the maximum of nodes possible in a Z Wave network.

Macro Definition Documentation

HIGHEST_LONG_RANGE_NODE_ID

#define HIGHEST_LONG_RANGE_NODE_ID   (LOWEST_LONG_RANGE_NODE_ID + ZW_MAX_NODES_LR - 1)

HOMEID_LENGTH

#define HOMEID_LENGTH   4

Number of bytes in a homeID.

LAST_USED_ROUTE_CONF_SIZE

#define LAST_USED_ROUTE_CONF_SIZE   1

TX_STATUS_TYPE Last Used Route array size definitions

LAST_USED_ROUTE_SIZE

#define LAST_USED_ROUTE_SIZE   (MAX_REPEATERS + LAST_USED_ROUTE_CONF_SIZE)

LOWEST_LONG_RANGE_NODE_ID

#define LOWEST_LONG_RANGE_NODE_ID   (0x0100)

MAX_REPEATERS

#define MAX_REPEATERS   4

Max hops in route

NODE_BROADCAST

#define NODE_BROADCAST   0xFF

broadcast

Predefined Node ID's

NODEPARM_MAX

#define NODEPARM_MAX   35

max. number of parameters

S2_TXOPTION_FIRST_SINGLECAST_FOLLOWUP

#define S2_TXOPTION_FIRST_SINGLECAST_FOLLOWUP   4

This flag must be present on the first, and only the first single cast followup message in a S2 multicast transmission.

S2_TXOPTION_SINGLECAST_FOLLOWUP

#define S2_TXOPTION_SINGLECAST_FOLLOWUP   2

This flag must be present on all single cast followup messages.

S2_TXOPTION_VERIFY_DELIVERY

#define S2_TXOPTION_VERIFY_DELIVERY   1

This flag will activate frame delivery.

In this transmission mode the S2_send_data will try to verify that the receiver understood the sent message. This is done by waiting a little to see if the node will respond nonce report to the encrypted message. If the node does respond with a nonce report then the S2_send_data call will automatically cause the system to re-sync the node, and deliver the message

ZW_MAX_CACHED_RETURN_ROUTE_DESTINATIONS

#define ZW_MAX_CACHED_RETURN_ROUTE_DESTINATIONS   5

ZW_MAX_NODES

#define ZW_MAX_NODES   232

ZW_MAX_NODES_LR

#define ZW_MAX_NODES_LR   1024

Max number of Long Range nodes in a Z-wave system Must not be higher than 4000 according to specs

ZW_TEST_NOT_A_NODEID

#define ZW_TEST_NOT_A_NODEID   0x00

Typedef Documentation

RECEIVE_OPTIONS_TYPE

typedef struct _RECEIVE_OPTIONS_TYPE RECEIVE_OPTIONS_TYPE

S_ROUTE_LINK_T

typedef struct _S_ROUTE_LINK_T_ S_ROUTE_LINK_T

TRANSMIT_MULTI_OPTIONS_TYPE

typedef struct _TRANSMIT_MULTI_OPTIONS_TYPE TRANSMIT_MULTI_OPTIONS_TYPE

Transmit options for ZW_SendDataMultiEx

TRANSMIT_OPTIONS_TYPE

typedef struct _TRANSMIT_OPTIONS_TYPE TRANSMIT_OPTIONS_TYPE

Transmit options for ZW_SendDataEx

TX_STATUS_TYPE

typedef struct _TX_STATUS_TYPE_ TX_STATUS_TYPE

TxOptions_t

typedef uint32_t TxOptions_t

The universal TX-Option flag count.