Z-Wave Transport API#

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 the ApplicationCommandHandler function. The ZW_MAX_NODES define defines the maximum of nodes possible in a Z Wave network.

Modules#

s_rssi_val

_S_ROUTE_LINK_T_

_TX_STATUS_TYPE_

_RECEIVE_OPTIONS_TYPE

_TRANSMIT_OPTIONS_TYPE

_TRANSMIT_MULTI_OPTIONS_TYPE

_RECEIVE_OPTIONS_TYPE.homeId

Transmit Options

Receive Status

Transmit complete codes

Typedefs#

typedef uint32_t
TxOptions_t

The universal TX-Option flag count.

typedef struct _TRANSMIT_OPTIONS_TYPE
TRANSMIT_OPTIONS_TYPE

Transmit options for ZW_SendDataEx.

typedef struct _TRANSMIT_MULTI_OPTIONS_TYPE
TRANSMIT_MULTI_OPTIONS_TYPE

Transmit options for ZW_SendDataMultiEx.

Macros#

#define
ZW_MAX_NODES 232
#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.

#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
GET_NLS_NODES_LIST_LENGTH_MAX (128)

Frames should not exceed 128 bytes long.

#define
NODE_BROADCAST 0xFF

Predefined Node ID's.

#define
MAX_REPEATERS 4

Max hops in route.

#define
LAST_USED_ROUTE_CONF_SIZE 1

TX_STATUS_TYPE Last Used Route array size definitions.

#define
LAST_USED_ROUTE_SIZE (MAX_REPEATERS + LAST_USED_ROUTE_CONF_SIZE)
#define
S2_TXOPTION_VERIFY_DELIVERY 1

This flag will activate frame delivery.

#define
S2_TXOPTION_SINGLECAST_FOLLOWUP 2

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

#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.

Typedef Documentation#

TxOptions_t#

typedef uint32_t TxOptions_t

The universal TX-Option flag count.


S_ROUTE_LINK_T#

typedef struct _S_ROUTE_LINK_T_ S_ROUTE_LINK_T

TX_STATUS_TYPE#

typedef struct _TX_STATUS_TYPE_ TX_STATUS_TYPE

RECEIVE_OPTIONS_TYPE#

typedef struct _RECEIVE_OPTIONS_TYPE RECEIVE_OPTIONS_TYPE

TRANSMIT_OPTIONS_TYPE#

typedef struct _TRANSMIT_OPTIONS_TYPE TRANSMIT_OPTIONS_TYPE

Transmit options for ZW_SendDataEx.


TRANSMIT_MULTI_OPTIONS_TYPE#

typedef struct _TRANSMIT_MULTI_OPTIONS_TYPE TRANSMIT_MULTI_OPTIONS_TYPE

Transmit options for ZW_SendDataMultiEx.


Macro Definition Documentation#

ZW_MAX_NODES#

#define ZW_MAX_NODES
Value:
232

ZW_MAX_NODES_LR#

#define ZW_MAX_NODES_LR
Value:
1024

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


LOWEST_LONG_RANGE_NODE_ID#

#define LOWEST_LONG_RANGE_NODE_ID
Value:
(0x0100)

HIGHEST_LONG_RANGE_NODE_ID#

#define HIGHEST_LONG_RANGE_NODE_ID
Value:
(LOWEST_LONG_RANGE_NODE_ID + ZW_MAX_NODES_LR - 1)

NODEPARM_MAX#

#define NODEPARM_MAX
Value:
35

max. number of parameters


HOMEID_LENGTH#

#define HOMEID_LENGTH
Value:
4

Number of bytes in a homeID.


GET_NLS_NODES_LIST_LENGTH_MAX#

#define GET_NLS_NODES_LIST_LENGTH_MAX
Value:
(128)

Frames should not exceed 128 bytes long.


NODE_BROADCAST#

#define NODE_BROADCAST
Value:
0xFF

Predefined Node ID's.

broadcast


ZW_TEST_NOT_A_NODEID#

#define ZW_TEST_NOT_A_NODEID
Value:
0x00

ZW_MAX_CACHED_RETURN_ROUTE_DESTINATIONS#

#define ZW_MAX_CACHED_RETURN_ROUTE_DESTINATIONS
Value:
5

MAX_REPEATERS#

#define MAX_REPEATERS
Value:
4

Max hops in route.


LAST_USED_ROUTE_CONF_SIZE#

#define LAST_USED_ROUTE_CONF_SIZE
Value:
1

TX_STATUS_TYPE Last Used Route array size definitions.


LAST_USED_ROUTE_SIZE#

#define LAST_USED_ROUTE_SIZE
Value:
(MAX_REPEATERS + LAST_USED_ROUTE_CONF_SIZE)

S2_TXOPTION_VERIFY_DELIVERY#

#define S2_TXOPTION_VERIFY_DELIVERY
Value:
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


S2_TXOPTION_SINGLECAST_FOLLOWUP#

#define S2_TXOPTION_SINGLECAST_FOLLOWUP
Value:
2

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


S2_TXOPTION_FIRST_SINGLECAST_FOLLOWUP#

#define S2_TXOPTION_FIRST_SINGLECAST_FOLLOWUP
Value:
4

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