Z-Wave Application Transport Interface#

EProtocolType#

EProtocolType

ELibraryType#

ELibraryType

EInclusionState_t#

EInclusionState_t

EListenBeforeTalkThreshold_t#

EListenBeforeTalkThreshold_t

EtxPowerLevel_t#

EtxPowerLevel_t

EZwaveTransmitType#

EZwaveTransmitType

Transmit Type enum used by SZwaveTransmitPackage.

ELearnStatus#

ELearnStatus

Learn mode status updates.

EZwaveCommandType#

EZwaveCommandType

Z-Wave Command Types.

EZwaveCommandStatusType#

EZwaveCommandStatusType

Z-Wave Command Status Type used by SZwaveCommandStatusPackage.

EZwaveReceiveType#

EZwaveReceiveType

Z-Wave Receive type.

EProtocolEvent#

EProtocolEvent

ERequestEncryptionEvent#

ERequestEncryptionEvent

ELearnMode#

ELearnMode

EProtocolType#

typedef enum EProtocolType EProtocolType

ELibraryType#

typedef enum ELibraryType ELibraryType

EInclusionState_t#

typedef enum EInclusionState_t EInclusionState_t

EListenBeforeTalkThreshold_t#

typedef enum EListenBeforeTalkThreshold_t EListenBeforeTalkThreshold_t

EtxPowerLevel_t#

typedef enum EtxPowerLevel_t EtxPowerLevel_t

EZwaveTransmitType#

typedef enum EZwaveTransmitType EZwaveTransmitType

Transmit Type enum used by SZwaveTransmitPackage.

ELearnStatus#

typedef enum ELearnStatus ELearnStatus

Learn mode status updates.

EZwaveCommandType#

typedef enum EZwaveCommandType EZwaveCommandType

Z-Wave Command Types.

EZwaveCommandStatusType#

typedef enum EZwaveCommandStatusType EZwaveCommandStatusType

Z-Wave Command Status Type used by SZwaveCommandStatusPackage.

EZwaveReceiveType#

typedef enum EZwaveReceiveType EZwaveReceiveType

Z-Wave Receive type.

EProtocolEvent#

typedef enum EProtocolEvent EProtocolEvent

ERequestEncryptionEvent#

typedef enum ERequestEncryptionEvent ERequestEncryptionEvent

SNetworkUpdateRequest#

typedef struct SNetworkUpdateRequest SNetworkUpdateRequest

Network Update Request.

ELearnMode#

typedef enum ELearnMode ELearnMode

SNodeInfoRequest#

typedef struct SNodeInfoRequest SNodeInfoRequest

SNodeInfo#

typedef struct SNodeInfo SNodeInfo

SCommandClassList_t#

typedef struct SCommandClassList_t SCommandClassList_t

SCommandClassSet_t#

typedef struct SCommandClassSet_t SCommandClassSet_t

List of Command Classes supported when device is not included, included insecurely or included securely.

SCommandClassVersions#

typedef struct SCommandClassVersions SCommandClassVersions

SCommandGenerateRandom#

typedef struct SCommandGenerateRandom SCommandGenerateRandom

Generates true random word.

SCommandNodeInfo#

typedef struct SCommandNodeInfo SCommandNodeInfo

SCommandClearNetworkStatistics#

typedef struct SCommandClearNetworkStatistics SCommandClearNetworkStatistics

SCommandSetLearnMode#

typedef struct SCommandSetLearnMode SCommandSetLearnMode

SCommandSetSmartStartLearnMode#

typedef struct SCommandSetSmartStartLearnMode SCommandSetSmartStartLearnMode

SSetSucNodeId#

typedef struct SSetSucNodeId SSetSucNodeId

Controller API.

SCommandSetRfPowerLevel#

typedef struct SCommandSetRfPowerLevel SCommandSetRfPowerLevel

SSendSucNodeId#

typedef struct SSendSucNodeId SSendSucNodeId

SCommandSetPromiscuousMode#

typedef struct SCommandSetPromiscuousMode SCommandSetPromiscuousMode

SAssignReturnRoute#

typedef struct SAssignReturnRoute SAssignReturnRoute

SCommandSetRfReceiveMode#

typedef struct SCommandSetRfReceiveMode SCommandSetRfReceiveMode

SDeleteReturnRoute#

typedef struct SDeleteReturnRoute SDeleteReturnRoute

SCommandGeniric8bParameter#

typedef struct SCommandGeniric8bParameter SCommandGeniric8bParameter

SCommandGeniric16bParameter#

typedef struct SCommandGeniric16bParameter SCommandGeniric16bParameter

SCommandAreNodesNeighbours#

typedef struct SCommandAreNodesNeighbours SCommandAreNodesNeighbours

SCommandGetRoutingInfo#

typedef struct SCommandGetRoutingInfo SCommandGetRoutingInfo

SSendSlaveNodeInformation#

typedef struct SSendSlaveNodeInformation SSendSlaveNodeInformation

SCommandSetRoutingInfo#

typedef struct SCommandSetRoutingInfo SCommandSetRoutingInfo

SCommandStoreNodeInfo#

typedef struct SCommandStoreNodeInfo SCommandStoreNodeInfo

SCommandStoreHomeID#

typedef struct SCommandStoreHomeID SCommandStoreHomeID

SCommandSetPriorityRoute#

typedef struct SCommandSetPriorityRoute SCommandSetPriorityRoute

SCommandAesEcb#

typedef struct SCommandAesEcb SCommandAesEcb

SCommandGetPriorityRoute#

typedef struct SCommandGetPriorityRoute SCommandGetPriorityRoute

SCommandFailedNodeIDCmd#

typedef struct SCommandFailedNodeIDCmd SCommandFailedNodeIDCmd

SCommandPMSetPowerDownCallback#

typedef struct SCommandPMSetPowerDownCallback SCommandPMSetPowerDownCallback

SCommandSetLBTThreshold#

typedef struct SCommandSetLBTThreshold SCommandSetLBTThreshold

SCommandSetMaxInclReqInterval#

typedef struct SCommandSetMaxInclReqInterval SCommandSetMaxInclReqInterval

SCommandNvmBackupRestore#

typedef struct SCommandNvmBackupRestore SCommandNvmBackupRestore

SCommandSetSecurityKeys#

typedef struct SCommandSetSecurityKeys SCommandSetSecurityKeys

SCommandEnableNodeNLS#

typedef struct SCommandEnableNodeNLS SCommandEnableNodeNLS

SCommandGetNodeNLSState#

typedef struct SCommandGetNodeNLSState SCommandGetNodeNLSState

SCommandSendProtocolDataCb#

typedef struct SCommandSendProtocolDataCb SCommandSendProtocolDataCb

SProtocolVersion#

typedef struct SProtocolVersion SProtocolVersion

SProtocolInfo#

typedef struct SProtocolInfo SProtocolInfo

Protocol Info data.

SNetworkInfo#

typedef struct SNetworkInfo SNetworkInfo

Network Info.

SLongRangeInfo#

typedef struct SLongRangeInfo SLongRangeInfo

t_ExtNodeInfo#

typedef struct t_ExtNodeInfo t_ExtNodeInfo

SRadioStatus#

typedef struct SRadioStatus SRadioStatus

SApplicationHandles#

typedef struct SApplicationHandles SApplicationHandles

SRadioConfig_t#

typedef struct SRadioConfig_t SRadioConfig_t

SAppNodeInfo_t#

typedef struct SAppNodeInfo_t SAppNodeInfo_t

SVirtualSlaveNodeInfo_t#

typedef struct SVirtualSlaveNodeInfo_t SVirtualSlaveNodeInfo_t

SVirtualSlaveNodeInfoTable_t#

typedef struct SVirtualSlaveNodeInfoTable_t SVirtualSlaveNodeInfoTable_t

SProtocolConfig_t#

typedef struct SProtocolConfig_t SProtocolConfig_t

This allows "nulling" a pointer while modifying a virtual slave node info Or changing pointer to point to a different one.

This struct content must be set up by application before enabling protocol (enabling radio) Direct content (the pointers) may not be changed runtime, but the data they point to can be edited by application run time

STransmitFrameConfig#

typedef struct STransmitFrameConfig STransmitFrameConfig

STransmitProtocolFrameConfig#

typedef struct STransmitProtocolFrameConfig STransmitProtocolFrameConfig

SExploreInclusionRequest#

typedef struct SExploreInclusionRequest SExploreInclusionRequest

SExploreExclusionRequest#

typedef struct SExploreExclusionRequest SExploreExclusionRequest

SIncludedNodeInfo#

typedef struct SIncludedNodeInfo SIncludedNodeInfo

Contains info related to sending an INIF.

STest#

typedef struct STest STest

SSendData#

typedef struct SSendData SSendData

SSendDataEx#

typedef struct SSendDataEx SSendDataEx

SSendDataBridge#

typedef struct SSendDataBridge SSendDataBridge

SSendDataMulti#

typedef struct SSendDataMulti SSendDataMulti

SSendDataMultiEx#

typedef struct SSendDataMultiEx SSendDataMultiEx

SSendDataMultiBridge#

typedef struct SSendDataMultiBridge SSendDataMultiBridge

SSendProtocolData#

typedef struct SSendProtocolData SSendProtocolData

SCommandNetworkManagement#

typedef struct SCommandNetworkManagement SCommandNetworkManagement

SRequestNewRouteDestinations#

typedef struct SRequestNewRouteDestinations SRequestNewRouteDestinations

SCommandNetworkManagementDSK#

typedef struct SCommandNetworkManagementDSK SCommandNetworkManagementDSK

SZWaveTransmitStatus#

typedef struct SZWaveTransmitStatus SZWaveTransmitStatus

SZWaveGenerateRandomStatus#

typedef struct SZWaveGenerateRandomStatus SZWaveGenerateRandomStatus

SZWaveNodeInfoStatus#

typedef struct SZWaveNodeInfoStatus SZWaveNodeInfoStatus

SZWaveLearnModeStatus#

typedef struct SZWaveLearnModeStatus SZWaveLearnModeStatus

SZWaveInvalidTxRequestStatus#

typedef struct SZWaveInvalidTxRequestStatus SZWaveInvalidTxRequestStatus

SZWaveInvalidCommandStatus#

typedef struct SZWaveInvalidCommandStatus SZWaveInvalidCommandStatus

SZWaveGeneric8bStatus#

typedef struct SZWaveGeneric8bStatus SZWaveGeneric8bStatus

SZWaveGenericBoolStatus#

typedef struct SZWaveGenericBoolStatus SZWaveGenericBoolStatus

SCommandRequestNodeNeighborUpdate#

typedef struct SCommandRequestNodeNeighborUpdate SCommandRequestNodeNeighborUpdate

SCommandRequestNodeTypeNeighborUpdate#

typedef struct SCommandRequestNodeTypeNeighborUpdate SCommandRequestNodeTypeNeighborUpdate

SZWaveGetRoutingInfoStatus#

typedef struct SZWaveGetRoutingInfoStatus SZWaveGetRoutingInfoStatus

SCommandInitiateShutdown#

typedef struct SCommandInitiateShutdown SCommandInitiateShutdown

SCommandSetSecurityFlags#

typedef struct SCommandSetSecurityFlags SCommandSetSecurityFlags

SZWaveGetPriorityRouteStatus#

typedef struct SZWaveGetPriorityRouteStatus SZWaveGetPriorityRouteStatus

SZWaveSetPriorityRouteStatus#

typedef struct SZWaveSetPriorityRouteStatus SZWaveSetPriorityRouteStatus

SZWaveGetVirtualNodesStatus#

typedef struct SZWaveGetVirtualNodesStatus SZWaveGetVirtualNodesStatus

SZWaveAesEcbStatus#

typedef struct SZWaveAesEcbStatus SZWaveAesEcbStatus

SZWaveGetBackgroundRssiStatus#

typedef struct SZWaveGetBackgroundRssiStatus SZWaveGetBackgroundRssiStatus

SZWaveNetworkManagementStatus#

typedef struct SZWaveNetworkManagementStatus SZWaveNetworkManagementStatus

SNvmBackupRestoreStatus#

typedef struct SNvmBackupRestoreStatus SNvmBackupRestoreStatus

SCommandGetNodeNLSStateStatus#

typedef struct SCommandGetNodeNLSStateStatus SCommandGetNodeNLSStateStatus

SCommandEnableNodeNLSStatus#

typedef struct SCommandEnableNodeNLSStatus SCommandEnableNodeNLSStatus

SZWaveGetIncludedNodes#

typedef struct SZWaveGetIncludedNodes SZWaveGetIncludedNodes

SZWaveGetIncludedNodesLR#

typedef struct SZWaveGetIncludedNodesLR SZWaveGetIncludedNodesLR

SZWaveTxPowerMaxSupported#

typedef struct SZWaveTxPowerMaxSupported SZWaveTxPowerMaxSupported

SCommandTransferProtocolCC#

typedef struct SCommandTransferProtocolCC SCommandTransferProtocolCC

SReceiveNodeUpdate#

typedef struct SReceiveNodeUpdate SReceiveNodeUpdate

The Z Wave protocol MAY notify an application by sending SReceiveNodeUpdate when a Node Information Frame has been received.

The Z Wave protocol MAY refrain from sending the information if the protocol is currently expecting node information.

A controller application MAY use the information provided by SReceiveNodeUpdate to update local data structures.

The Z Wave protocol MUST notify a controller application by calling SReceiveNodeUpdate when a new node has been added or deleted from the controller through the network management features.

The Z Wave protocol MUST pass SReceiveNodeUpdate to application in response to SNodeInfoRequest being passed to protocol by the controller application. The Z Wave protocol MAY notify a controller application by sending SReceiveNodeUpdate when a Node Information Frame has been received. The Z Wave protocol MAY refrain from sending the information if the protocol is currently expecting a Node Information frame.

SReceiveNodeUpdate MUST be sent in a controller node operating as SIS each time a node is added or deleted by the primary controller. SReceiveNodeUpdate MUST be sent in a controller node operating as SIS each time a node is added/deleted by an inclusion controller.

A controller application MAY send a ZW_RequestNetWorkUpdate command to a SIS or SIS node. In response, the SIS MUST return update information for each node change since the last update handled by the requesting controller node. The application of the requesting controller node MAY receive multiple instances of SReceiveNodeUpdate in response to application passing SNetworkUpdateRequest to protocol.

The Z Wave protocol MUST NOT send SReceiveNodeUpdate in a controller node acting as primary controller or inclusion controller when a node is added or deleted.

Any controller application MUST implement this function.

serialapi{ZW->HOST: REQ | 0x49 | bStatus | bNodeID | bLen | basic | generic | specific | commandclasses[ ]}

SReceiveNodeUpdate via the Serial API also have the possibility for receiving the status UPDATE_STATE_NODE_INFO_REQ_FAILED, which means that a node did not acknowledge a SNodeInfoRequest .

SReceiveSecurityEvent#

typedef struct SReceiveSecurityEvent SReceiveSecurityEvent

UTransmitParameters#

typedef union UTransmitParameters UTransmitParameters

Transmit Parameters Union used by SZwaveTransmitPackage.

UCommandStatus#

typedef union UCommandStatus UCommandStatus

Command Status Union used by SZwaveCommandStatusPackage.

UReceiveCmdPayload#

typedef union UReceiveCmdPayload UReceiveCmdPayload

UCommandParameters#

typedef union UCommandParameters UCommandParameters

SZwaveTransmitPackage#

typedef struct SZwaveTransmitPackage SZwaveTransmitPackage

SZwaveCommandStatusPackage#

typedef struct SZwaveCommandStatusPackage SZwaveCommandStatusPackage

Z-Wave Command Status Package.

SZwaveCommandPackage#

typedef struct SZwaveCommandPackage SZwaveCommandPackage

SReceiveSingle#

typedef struct SReceiveSingle SReceiveSingle

SReceiveMulti#

typedef struct SReceiveMulti SReceiveMulti

SProtocolTxOptions#

typedef struct SProtocolTxOptions SProtocolTxOptions

SRequestEncryption#

typedef struct SRequestEncryption SRequestEncryption

UReceiveParameters#

typedef union UReceiveParameters UReceiveParameters

SZwaveReceivePackage#

typedef struct SZwaveReceivePackage SZwaveReceivePackage

ZW_MAX_PAYLOAD_SIZE#

#define ZW_MAX_PAYLOAD_SIZE

160

Max theoretical Z-Wave frame payload size in a Z-Wave protocol using 3CH network The real Z-Wave frame payload type depends on various parameters (routed, multicast, explore, security and/or number of RF channels) Customer must not use this value in their application.

They must use the value MaxPayloadSize from the SNetworkInfo structure.

MULTICAST_NODE_LIST_SIZE#

#define MULTICAST_NODE_LIST_SIZE

64

Numbers of nodes we can support when sending multicast frames on LR channel.

TX_BUFFER_SIZE#

#define TX_BUFFER_SIZE

170

MAX_NODE_INFO_LENGTH#

#define MAX_NODE_INFO_LENGTH

159

Maximum size for the node info frame contained in the SReceiveNodeUpdate struct.

PROTOCOL_METADATA_SPEED_IDX#

#define PROTOCOL_METADATA_SPEED_IDX

0

PROTOCOL_METADATA_TX_POWER_IDX#

#define PROTOCOL_METADATA_TX_POWER_IDX

1

PROTOCOL_METADATA_TX_OPTIONS_IDX#

#define PROTOCOL_METADATA_TX_OPTIONS_IDX

2

PROTOCOL_METADATA_CALLBACK_ID_IDX#

#define PROTOCOL_METADATA_CALLBACK_ID_IDX

6

PROTOCOL_METADATA_LENGTH#

#define PROTOCOL_METADATA_LENGTH

(sizeof(uint8_t) + sizeof(uint8_t) + sizeof(TxOptions_t) + sizeof(uint8_t))

APPLICATION_INTERFACE_TRANSMIT_ENUM_OFFSET#

#define APPLICATION_INTERFACE_TRANSMIT_ENUM_OFFSET

(0x00)

APPLICATION_INTERFACE_COMMAND_ENUM_OFFSET#

#define APPLICATION_INTERFACE_COMMAND_ENUM_OFFSET

(0x40)

APPLICATION_INTERFACE_RECEIVE_ENUM_OFFSET#

#define APPLICATION_INTERFACE_RECEIVE_ENUM_OFFSET

(0x80)

APPLICATION_INTERFACE_STATUS_ENUM_OFFSET#

#define APPLICATION_INTERFACE_STATUS_ENUM_OFFSET

(0xC0)