• 2019 Silicon Laboratories Inc.

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

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
TRANSMIT_OPTION_ACK 0x01

Request acknowledge from destination node.

#define
TRANSMIT_OPTION_LOW_POWER 0x02

Rransmit at low output power level (1/3 of normal RF range)

#define
TRANSMIT_OPTION_MULTICAST_AS_BROADCAST 0x02

The multicast frame should be send as a broadcast.

#define
TRANSMIT_OPTION_AUTO_ROUTE 0x04

Request retransmission via repeater nodes.

#define
TRANSMIT_OPTION_NO_ROUTE 0x10

Do not use response route - Even if available.

#define
TRANSMIT_OPTION_EXPLORE 0x20

Use explore frame if needed.

#define
RECEIVE_STATUS_ROUTED_BUSY 0x01

< A response route is locked by the application

#define
RECEIVE_STATUS_LOW_POWER 0x02

Received at low output power level, this must have the same value as TRANSMIT_OPTION_LOW_POWER.

#define
RECEIVE_STATUS_TYPE_MASK 0x0C

Mask for masking out the received frametype bits.

#define
RECEIVE_STATUS_TYPE_SINGLE 0x00

Received frame is singlecast frame (rxOptions == xxxx00xx)

#define
RECEIVE_STATUS_TYPE_BROAD 0x04

Received frame is broadcast frame (rxOptions == xxxx01xx)

#define
RECEIVE_STATUS_TYPE_MULTI 0x08

Received frame is multicast frame (rxOptions == xxxx10xx)

#define
RECEIVE_STATUS_TYPE_EXPLORE 0x10

Received frame is an explore frame (rxOptions == xxx1xxxx) Only TYPE_BROAD can be active at the same time as TYPE_EXPLORE.

#define
RECEIVE_STATUS_FOREIGN_FRAME 0x40

Received frame is not send to me (rxOptions == x1xxxxxx)

#define
NODE_BROADCAST 0xFF

Predefined Node ID's.

#define
TRANSMIT_COMPLETE_OK 0x00

Transmit OK.

#define
TRANSMIT_COMPLETE_NO_ACK 0x01

Retransmission error.

#define
TRANSMIT_COMPLETE_FAIL 0x02

Transmit error.

#define
TRANSMIT_ROUTING_NOT_IDLE 0x03

Transmit error.

#define
TRANSMIT_COMPLETE_VERIFIED 0x05

Security S2. Receiving node has decrypted the frame.

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

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.

Macro Definition Documentation#

ZW_MAX_NODES#

#define ZW_MAX_NODES
Value:
232

Definition at line 27 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

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.


Definition at line 31 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

LOWEST_LONG_RANGE_NODE_ID#

#define LOWEST_LONG_RANGE_NODE_ID
Value:
(0x0100)

Definition at line 33 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

HIGHEST_LONG_RANGE_NODE_ID#

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

Definition at line 35 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

NODEPARM_MAX#

#define NODEPARM_MAX
Value:
35

max. number of parameters


Definition at line 37 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

HOMEID_LENGTH#

#define HOMEID_LENGTH
Value:
4

Number of bytes in a homeID.


Definition at line 38 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

TRANSMIT_OPTION_ACK#

#define TRANSMIT_OPTION_ACK
Value:
0x01

Request acknowledge from destination node.


Definition at line 47 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

TRANSMIT_OPTION_LOW_POWER#

#define TRANSMIT_OPTION_LOW_POWER
Value:
0x02

Rransmit at low output power level (1/3 of normal RF range)


Definition at line 48 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

TRANSMIT_OPTION_MULTICAST_AS_BROADCAST#

#define TRANSMIT_OPTION_MULTICAST_AS_BROADCAST
Value:
0x02

The multicast frame should be send as a broadcast.


Definition at line 49 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

TRANSMIT_OPTION_AUTO_ROUTE#

#define TRANSMIT_OPTION_AUTO_ROUTE
Value:
0x04

Request retransmission via repeater nodes.


Definition at line 50 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

TRANSMIT_OPTION_NO_ROUTE#

#define TRANSMIT_OPTION_NO_ROUTE
Value:
0x10

Do not use response route - Even if available.


Definition at line 51 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

TRANSMIT_OPTION_EXPLORE#

#define TRANSMIT_OPTION_EXPLORE
Value:
0x20

Use explore frame if needed.


Definition at line 52 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

RECEIVE_STATUS_ROUTED_BUSY#

#define RECEIVE_STATUS_ROUTED_BUSY
Value:
0x01

< A response route is locked by the application


Definition at line 61 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

RECEIVE_STATUS_LOW_POWER#

#define RECEIVE_STATUS_LOW_POWER
Value:
0x02

Received at low output power level, this must have the same value as TRANSMIT_OPTION_LOW_POWER.


Definition at line 66 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

RECEIVE_STATUS_TYPE_MASK#

#define RECEIVE_STATUS_TYPE_MASK
Value:
0x0C

Mask for masking out the received frametype bits.


Definition at line 70 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

RECEIVE_STATUS_TYPE_SINGLE#

#define RECEIVE_STATUS_TYPE_SINGLE
Value:
0x00

Received frame is singlecast frame (rxOptions == xxxx00xx)


Definition at line 74 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

RECEIVE_STATUS_TYPE_BROAD#

#define RECEIVE_STATUS_TYPE_BROAD
Value:
0x04

Received frame is broadcast frame (rxOptions == xxxx01xx)


Definition at line 78 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

RECEIVE_STATUS_TYPE_MULTI#

#define RECEIVE_STATUS_TYPE_MULTI
Value:
0x08

Received frame is multicast frame (rxOptions == xxxx10xx)


Definition at line 82 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

RECEIVE_STATUS_TYPE_EXPLORE#

#define RECEIVE_STATUS_TYPE_EXPLORE
Value:
0x10

Received frame is an explore frame (rxOptions == xxx1xxxx) Only TYPE_BROAD can be active at the same time as TYPE_EXPLORE.


Definition at line 87 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

RECEIVE_STATUS_FOREIGN_FRAME#

#define RECEIVE_STATUS_FOREIGN_FRAME
Value:
0x40

Received frame is not send to me (rxOptions == x1xxxxxx)

  • useful only in promiscuous mode


Definition at line 92 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

NODE_BROADCAST#

#define NODE_BROADCAST
Value:
0xFF

Predefined Node ID's.

broadcast


Definition at line 96 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

ZW_TEST_NOT_A_NODEID#

#define ZW_TEST_NOT_A_NODEID
Value:
0x00

Definition at line 97 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

TRANSMIT_COMPLETE_OK#

#define TRANSMIT_COMPLETE_OK
Value:
0x00

Transmit OK.


Definition at line 103 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

TRANSMIT_COMPLETE_NO_ACK#

#define TRANSMIT_COMPLETE_NO_ACK
Value:
0x01

Retransmission error.


Definition at line 104 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

TRANSMIT_COMPLETE_FAIL#

#define TRANSMIT_COMPLETE_FAIL
Value:
0x02

Transmit error.


Definition at line 105 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

TRANSMIT_ROUTING_NOT_IDLE#

#define TRANSMIT_ROUTING_NOT_IDLE
Value:
0x03

Transmit error.


Definition at line 106 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

TRANSMIT_COMPLETE_VERIFIED#

#define TRANSMIT_COMPLETE_VERIFIED
Value:
0x05

Security S2. Receiving node has decrypted the frame.


Definition at line 113 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

ZW_MAX_CACHED_RETURN_ROUTE_DESTINATIONS#

#define ZW_MAX_CACHED_RETURN_ROUTE_DESTINATIONS
Value:
5

Definition at line 116 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

MAX_REPEATERS#

#define MAX_REPEATERS
Value:
4

Max hops in route.


Definition at line 119 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

LAST_USED_ROUTE_CONF_SIZE#

#define LAST_USED_ROUTE_CONF_SIZE
Value:
1

TX_STATUS_TYPE Last Used Route array size definitions.


Definition at line 122 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

LAST_USED_ROUTE_SIZE#

#define LAST_USED_ROUTE_SIZE
Value:
(MAX_REPEATERS + LAST_USED_ROUTE_CONF_SIZE)

Definition at line 123 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

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


Definition at line 199 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

S2_TXOPTION_SINGLECAST_FOLLOWUP#

#define S2_TXOPTION_SINGLECAST_FOLLOWUP
Value:
2

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


Definition at line 204 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

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.


Definition at line 210 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

Typedef Documentation#

TxOptions_t#

typedef uint32_t TxOptions_t

The universal TX-Option flag count.


Definition at line 40 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

S_ROUTE_LINK_T#

typedef struct _S_ROUTE_LINK_T_ S_ROUTE_LINK_T

Definition at line 136 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

TX_STATUS_TYPE#

typedef struct _TX_STATUS_TYPE_ TX_STATUS_TYPE

Definition at line 157 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

RECEIVE_OPTIONS_TYPE#

typedef struct _RECEIVE_OPTIONS_TYPE RECEIVE_OPTIONS_TYPE

Definition at line 185 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

TRANSMIT_OPTIONS_TYPE#

typedef struct _TRANSMIT_OPTIONS_TYPE TRANSMIT_OPTIONS_TYPE

Transmit options for ZW_SendDataEx.


Definition at line 228 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h

TRANSMIT_MULTI_OPTIONS_TYPE#

typedef struct _TRANSMIT_MULTI_OPTIONS_TYPE TRANSMIT_MULTI_OPTIONS_TYPE

Transmit options for ZW_SendDataMultiEx.


Definition at line 242 of file /mnt/raid/workspaces/ws.WH1KakGoP/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h