2019 Silicon Laboratories Inc.
Modules#
Macros#
Max number of Long Range nodes in a Z-wave system Must not be higher than 4000 according to specs.
max. number of parameters
Number of bytes in a homeID.
Request acknowledge from destination node.
Rransmit at low output power level (1/3 of normal RF range)
The multicast frame should be send as a broadcast.
Request retransmission via repeater nodes.
Do not use response route - Even if available.
Use explore frame if needed.
< A response route is locked by the application
Received at low output power level, this must have the same value as TRANSMIT_OPTION_LOW_POWER.
Mask for masking out the received frametype bits.
Received frame is singlecast frame (rxOptions == xxxx00xx)
Received frame is broadcast frame (rxOptions == xxxx01xx)
Received frame is multicast frame (rxOptions == xxxx10xx)
Received frame is an explore frame (rxOptions == xxx1xxxx) Only TYPE_BROAD can be active at the same time as TYPE_EXPLORE.
Received frame is not send to me (rxOptions == x1xxxxxx)
Predefined Node ID's.
Transmit OK.
Retransmission error.
Transmit error.
Transmit error.
Security S2. Receiving node has decrypted the frame.
Max hops in route.
TX_STATUS_TYPE Last Used Route array size definitions.
This flag will activate frame delivery.
This flag must be present on all single cast followup messages.
This flag must be present on the first, and only the first single cast followup message in a S2 multicast transmission.
Typedefs#
The universal TX-Option flag count.
Transmit options for ZW_SendDataEx.
Transmit options for ZW_SendDataMultiEx.
Macro Definition Documentation#
ZW_MAX_NODES#
#define ZW_MAX_NODESValue:
232
27
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
ZW_MAX_NODES_LR#
#define ZW_MAX_NODES_LRValue:
1024
Max number of Long Range nodes in a Z-wave system Must not be higher than 4000 according to specs.
31
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
LOWEST_LONG_RANGE_NODE_ID#
#define LOWEST_LONG_RANGE_NODE_IDValue:
(0x0100)
33
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
HIGHEST_LONG_RANGE_NODE_ID#
#define HIGHEST_LONG_RANGE_NODE_IDValue:
(LOWEST_LONG_RANGE_NODE_ID + ZW_MAX_NODES_LR - 1)
35
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
NODEPARM_MAX#
#define NODEPARM_MAXValue:
35
max. number of parameters
37
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
HOMEID_LENGTH#
#define HOMEID_LENGTHValue:
4
Number of bytes in a homeID.
38
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
TRANSMIT_OPTION_ACK#
#define TRANSMIT_OPTION_ACKValue:
0x01
Request acknowledge from destination node.
47
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
TRANSMIT_OPTION_LOW_POWER#
#define TRANSMIT_OPTION_LOW_POWERValue:
0x02
Rransmit at low output power level (1/3 of normal RF range)
48
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
TRANSMIT_OPTION_MULTICAST_AS_BROADCAST#
#define TRANSMIT_OPTION_MULTICAST_AS_BROADCASTValue:
0x02
The multicast frame should be send as a broadcast.
49
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
TRANSMIT_OPTION_AUTO_ROUTE#
#define TRANSMIT_OPTION_AUTO_ROUTEValue:
0x04
Request retransmission via repeater nodes.
50
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
TRANSMIT_OPTION_NO_ROUTE#
#define TRANSMIT_OPTION_NO_ROUTEValue:
0x10
Do not use response route - Even if available.
51
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
TRANSMIT_OPTION_EXPLORE#
#define TRANSMIT_OPTION_EXPLOREValue:
0x20
Use explore frame if needed.
52
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
RECEIVE_STATUS_ROUTED_BUSY#
#define RECEIVE_STATUS_ROUTED_BUSYValue:
0x01
< A response route is locked by the application
61
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
RECEIVE_STATUS_LOW_POWER#
#define RECEIVE_STATUS_LOW_POWERValue:
0x02
Received at low output power level, this must have the same value as TRANSMIT_OPTION_LOW_POWER.
66
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
RECEIVE_STATUS_TYPE_MASK#
#define RECEIVE_STATUS_TYPE_MASKValue:
0x0C
Mask for masking out the received frametype bits.
70
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
RECEIVE_STATUS_TYPE_SINGLE#
#define RECEIVE_STATUS_TYPE_SINGLEValue:
0x00
Received frame is singlecast frame (rxOptions == xxxx00xx)
74
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
RECEIVE_STATUS_TYPE_BROAD#
#define RECEIVE_STATUS_TYPE_BROADValue:
0x04
Received frame is broadcast frame (rxOptions == xxxx01xx)
78
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
RECEIVE_STATUS_TYPE_MULTI#
#define RECEIVE_STATUS_TYPE_MULTIValue:
0x08
Received frame is multicast frame (rxOptions == xxxx10xx)
82
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
RECEIVE_STATUS_TYPE_EXPLORE#
#define RECEIVE_STATUS_TYPE_EXPLOREValue:
0x10
Received frame is an explore frame (rxOptions == xxx1xxxx) Only TYPE_BROAD can be active at the same time as TYPE_EXPLORE.
87
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
RECEIVE_STATUS_FOREIGN_FRAME#
#define RECEIVE_STATUS_FOREIGN_FRAMEValue:
0x40
Received frame is not send to me (rxOptions == x1xxxxxx)
useful only in promiscuous mode
92
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
NODE_BROADCAST#
#define NODE_BROADCASTValue:
0xFF
Predefined Node ID's.
broadcast
96
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
ZW_TEST_NOT_A_NODEID#
#define ZW_TEST_NOT_A_NODEIDValue:
0x00
97
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
TRANSMIT_COMPLETE_OK#
#define TRANSMIT_COMPLETE_OKValue:
0x00
Transmit OK.
103
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
TRANSMIT_COMPLETE_NO_ACK#
#define TRANSMIT_COMPLETE_NO_ACKValue:
0x01
Retransmission error.
104
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
TRANSMIT_COMPLETE_FAIL#
#define TRANSMIT_COMPLETE_FAILValue:
0x02
Transmit error.
105
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
TRANSMIT_ROUTING_NOT_IDLE#
#define TRANSMIT_ROUTING_NOT_IDLEValue:
0x03
Transmit error.
106
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
TRANSMIT_COMPLETE_VERIFIED#
#define TRANSMIT_COMPLETE_VERIFIEDValue:
0x05
Security S2. Receiving node has decrypted the frame.
113
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
ZW_MAX_CACHED_RETURN_ROUTE_DESTINATIONS#
#define ZW_MAX_CACHED_RETURN_ROUTE_DESTINATIONSValue:
5
116
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
MAX_REPEATERS#
#define MAX_REPEATERSValue:
4
Max hops in route.
119
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
LAST_USED_ROUTE_CONF_SIZE#
#define LAST_USED_ROUTE_CONF_SIZEValue:
1
TX_STATUS_TYPE Last Used Route array size definitions.
122
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
LAST_USED_ROUTE_SIZE#
#define LAST_USED_ROUTE_SIZEValue:
(MAX_REPEATERS + LAST_USED_ROUTE_CONF_SIZE)
123
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
S2_TXOPTION_VERIFY_DELIVERY#
#define S2_TXOPTION_VERIFY_DELIVERYValue:
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
199
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
S2_TXOPTION_SINGLECAST_FOLLOWUP#
#define S2_TXOPTION_SINGLECAST_FOLLOWUPValue:
2
This flag must be present on all single cast followup messages.
204
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
S2_TXOPTION_FIRST_SINGLECAST_FOLLOWUP#
#define S2_TXOPTION_FIRST_SINGLECAST_FOLLOWUPValue:
4
This flag must be present on the first, and only the first single cast followup message in a S2 multicast transmission.
210
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/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.
40
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/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
136
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
TX_STATUS_TYPE#
typedef struct _TX_STATUS_TYPE_ TX_STATUS_TYPE
157
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h
RECEIVE_OPTIONS_TYPE#
typedef struct _RECEIVE_OPTIONS_TYPE RECEIVE_OPTIONS_TYPE
185
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/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.
228
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/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.
242
of file /mnt/raid/workspaces/ws.Mh9rMZz8x/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h