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#
Typedefs#
The universal TX-Option flag count.
Transmit options for ZW_SendDataEx.
Transmit options for ZW_SendDataMultiEx.
Macros#
Max number of Long Range nodes in a Z-wave system Must not be higher than 4000 according to specs.
count of LR nodes stored in NVM.
max. number of parameters
Number of bytes in a homeID.
Predefined Node ID's.
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.
Typedef Documentation#
TxOptions_t#
typedef uint32_t TxOptions_t
The universal TX-Option flag count.
44 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hS_ROUTE_LINK_T#
typedef struct _S_ROUTE_LINK_T_ S_ROUTE_LINK_T
139 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hTX_STATUS_TYPE#
typedef struct _TX_STATUS_TYPE_ TX_STATUS_TYPE
160 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hRECEIVE_OPTIONS_TYPE#
typedef struct _RECEIVE_OPTIONS_TYPE RECEIVE_OPTIONS_TYPE
188 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hTRANSMIT_OPTIONS_TYPE#
typedef struct _TRANSMIT_OPTIONS_TYPE TRANSMIT_OPTIONS_TYPE
Transmit options for ZW_SendDataEx.
231 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hTRANSMIT_MULTI_OPTIONS_TYPE#
typedef struct _TRANSMIT_MULTI_OPTIONS_TYPE TRANSMIT_MULTI_OPTIONS_TYPE
Transmit options for ZW_SendDataMultiEx.
245 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hMacro Definition Documentation#
ZW_MAX_NODES#
#define ZW_MAX_NODESValue:
232
27 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hZW_MAX_NODES_LR#
#define ZW_MAX_NODES_LRValue:
256
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.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hZW_MAX_NVM_NODES_LR#
#define ZW_MAX_NVM_NODES_LRValue:
1024
count of LR nodes stored in NVM.
This value could not be changed without a migration script. Use different definitions for RAM & ROM in order to save on some release/part but keeping a compatible NVM.
35 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hLOWEST_LONG_RANGE_NODE_ID#
#define LOWEST_LONG_RANGE_NODE_IDValue:
(0x0100)
37 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hHIGHEST_LONG_RANGE_NODE_ID#
#define HIGHEST_LONG_RANGE_NODE_IDValue:
(LOWEST_LONG_RANGE_NODE_ID + ZW_MAX_NODES_LR - 1)
39 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hNODEPARM_MAX#
#define NODEPARM_MAXValue:
35
max. number of parameters
41 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hHOMEID_LENGTH#
#define HOMEID_LENGTHValue:
4
Number of bytes in a homeID.
42 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hNODE_BROADCAST#
#define NODE_BROADCASTValue:
0xFF
Predefined Node ID's.
broadcast
100 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hZW_TEST_NOT_A_NODEID#
#define ZW_TEST_NOT_A_NODEIDValue:
0x00
101 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hZW_MAX_CACHED_RETURN_ROUTE_DESTINATIONS#
#define ZW_MAX_CACHED_RETURN_ROUTE_DESTINATIONSValue:
5
119 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hMAX_REPEATERS#
#define MAX_REPEATERSValue:
4
Max hops in route.
122 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hLAST_USED_ROUTE_CONF_SIZE#
#define LAST_USED_ROUTE_CONF_SIZEValue:
1
TX_STATUS_TYPE Last Used Route array size definitions.
125 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hLAST_USED_ROUTE_SIZE#
#define LAST_USED_ROUTE_SIZEValue:
(MAX_REPEATERS + LAST_USED_ROUTE_CONF_SIZE)
126 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hS2_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
202 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hS2_TXOPTION_SINGLECAST_FOLLOWUP#
#define S2_TXOPTION_SINGLECAST_FOLLOWUPValue:
2
This flag must be present on all single cast followup messages.
207 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.hS2_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.
213 of file /mnt/raid/workspaces/ws.T7KR5OZRo/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_transport_api.h