Z-Wave Application Transport Interface#

Modules#

SNetworkUpdateRequest

SNodeInfoRequest

SNodeInfo

SCommandClassList_t

SCommandClassSet_t

SCommandClassVersions

SCommandGenerateRandom

SCommandNodeInfo

SCommandClearNetworkStatistics

SCommandSetLearnMode

SCommandSetSmartStartLearnMode

SSetSucNodeId

SCommandSetRfPowerLevel

SSendSucNodeId

SCommandSetPromiscuousMode

SAssignReturnRoute

SCommandSetRfReceiveMode

SDeleteReturnRoute

SCommandGeniric8bParameter

SCommandGeniric16bParameter

SCommandAreNodesNeighbours

SCommandGetRoutingInfo

SSendSlaveNodeInformation

SCommandSetRoutingInfo

SCommandStoreNodeInfo

SCommandStoreHomeID

SCommandSetPriorityRoute

SCommandAesEcb

SCommandGetPriorityRoute

SCommandFailedNodeIDCmd

SCommandPMSetPowerDownCallback

SCommandSetLBTThreshold

SCommandSetMaxInclReqInterval

SCommandNvmBackupRestore

SCommandSetSecurityKeys

SProtocolVersion

SProtocolInfo

SNetworkInfo

SLongRangeInfo

t_ExtNodeInfo

SRadioStatus

SApplicationHandles

SRadioConfig_t

SAppNodeInfo_t

SVirtualSlaveNodeInfo_t

SVirtualSlaveNodeInfoTable_t

SProtocolConfig_t

STransmitFrameConfig

SExploreInclusionRequest

SExploreExclusionRequest

SIncludedNodeInfo

STest

SSendData

SSendDataEx

SSendDataBridge

SSendDataMulti

SSendDataMultiEx

SSendDataMultiBridge

SCommandNetworkManagement

SSendReplication

SSendReplicationReceiveComplete

SRequestNewRouteDestinations

SCommandNetworkManagementDSK

SZWaveTransmitStatus

SZWaveGenerateRandomStatus

SZWaveNodeInfoStatus

SZWaveLearnModeStatus

SZWaveInvalidTxRequestStatus

SZWaveInvalidCommandStatus

SZWaveGeneric8bStatus

SZWaveGenericBoolStatus

SCommandRequestNodeNeighborUpdate

SCommandRequestNodeTypeNeighborUpdate

SZWaveGetRoutingInfoStatus

SCommandInitiateShutdown

SCommandSetSecurityFlags

SZWaveGetPriorityRouteStatus

SZWaveSetPriorityRouteStatus

SZWaveGetVirtualNodesStatus

SZWaveAesEcbStatus

SZWaveGetBackgroundRssiStatus

SZWaveNetworkManagementStatus

SNvmBackupRestoreStatus

SZWaveGetIncludedNodes

SZWaveGetIncludedNodesLR

SZWaveTxPowerMaxSupported

SReceiveNodeUpdate

SReceiveSecurityEvent

UTransmitParameters

UCommandStatus

UReceiveCmdPayload

UCommandParameters

SZwaveTransmitPackage

SZwaveCommandStatusPackage

SZwaveCommandPackage

SReceiveSingle

SReceiveMulti

UReceiveParameters

SZwaveReceivePackage

Enumerations#

enum
EPROTOCOLTYPE_ZWAVE = 0
EPROTOCOLTYPE_ZWAVE_AV
EPROTOCOLTYPE_ZWAVE_FOR_IP
}
enum
ELIBRARYTYPE_CONTROLLER_STATIC = 1
ELIBRARYTYPE_CONTROLLER_PORTABLE = 2
ELIBRARYTYPE_SLAVE = 3
ELIBRARYTYPE_SLAVE_BEFORE_ENHANCED = 4
ELIBRARYTYPE_INSTALLER = 5
ELIBRARYTYPE_SLAVE_ROUTING = 6
ELIBRARYTYPE_CONTROLLER = 7
ELIBRARYTYPE_DUT = 8
ELIBRARYTYPE_AVREMOTE = 10
ELIBRARYTYPE_AVDEVICE = 11
}
enum
EINCLUSIONSTATE_EXCLUDED = 0
EINCLUSIONSTATE_UNSECURE_INCLUDED
EINCLUSIONSTATE_SECURE_INCLUDED
}
enum
ELISTENBEFORETALKTRESHOLD_DEFAULT = 127
}
enum
ETXPOWERLEVEL_DEFAULT = 127
}
enum
EZWAVETRANSMITTYPE_STD = APPLICATION_INTERFACE_TRANSMIT_ENUM_OFFSET
EZWAVETRANSMITTYPE_EX
EZWAVETRANSMITTYPE_BRIDGE
EZWAVETRANSMITTYPE_MULTI
EZWAVETRANSMITTYPE_MULTI_EX
EZWAVETRANSMITTYPE_MULTI_BRIDGE
EZWAVETRANSMITTYPE_EXPLOREINCLUSIONREQUEST
EZWAVETRANSMITTYPE_EXPLOREEXCLUSIONREQUEST
EZWAVETRANSMITTYPE_NETWORKUPDATEREQUEST
EZWAVETRANSMITTYPE_NODEINFORMATION
EZWAVETRANSMITTYPE_NODEINFORMATIONREQUEST
EZWAVETRANSMITTYPE_TESTFRAME
EZWAVETRANSMITTYPE_SETSUCNODEID
EZWAVETRANSMITTYPE_SENDSUCNODEID
EZWAVETRANSMITTYPE_ASSIGNRETURNROUTE
EZWAVETRANSMITTYPE_DELETERETURNROUTE
EZWAVETRANSMITTYPE_SENDREPLICATION
EZWAVETRANSMITTYPE_SENDREPLICATIONRECEIVECOMPLETE
EZWAVETRANSMITTYPE_REQUESTNEWROUTEDESTINATIONS
EZWAVETRANSMITTYPE_SEND_SLAVE_NODE_INFORMATION
EZWAVETRANSMITTYPE_SEND_SLAVE_DATA
EZWAVETRANSMITTYPE_INCLUDEDNODEINFORMATION
EZWAVETRANSMITTYPE_SECURE
EZWAVETRANSMITTYPE_NON_SECURE
NUM_EZWAVETRANSMITTYPE
}

Transmit Type enum used by SZwaveTransmitPackage.

enum
ELEARNSTATUS_ASSIGN_COMPLETE
ELEARNSTATUS_ASSIGN_NODEID_DONE
ELEARNSTATUS_ASSIGN_RANGE_INFO_UPDATE
ELEARNSTATUS_ASSIGN_INFO_PENDING
ELEARNSTATUS_ASSIGN_WAITING_FOR_FIND
ELEARNSTATUS_SMART_START_IN_PROGRESS
ELEARNSTATUS_LEARN_IN_PROGRESS
ELEARNSTATUS_LEARN_MODE_COMPLETED_TIMEOUT
ELEARNSTATUS_LEARN_MODE_COMPLETED_FAILED
}

Learn mode status updates.

enum
EZWAVECOMMANDTYPE_GENERATE_RANDOM = APPLICATION_INTERFACE_COMMAND_ENUM_OFFSET
EZWAVECOMMANDTYPE_NODE_INFO
EZWAVECOMMANDTYPE_CLEAR_NETWORK_STATISTICS
EZWAVECOMMANDTYPE_SET_LEARN_MODE
EZWAVECOMMANDTYPE_SET_DEFAULT
EZWAVECOMMANDTYPE_SEND_DATA_ABORT
EZWAVECOMMANDTYPE_SET_PROMISCUOUS_MODE
EZWAVECOMMANDTYPE_SET_RF_RECEIVE_MODE
EZWAVECOMMANDTYPE_IS_NODE_WITHIN_DIRECT_RANGE
EZWAVECOMMANDTYPE_GET_NEIGHBOR_COUNT
EZWAVECOMMANDTYPE_ARE_NODES_NEIGHBOURS
EZWAVECOMMANDTYPE_IS_FAILED_NODE_ID
EZWAVECOMMANDTYPE_GET_ROUTING_TABLE_LINE
EZWAVECOMMANDTYPE_SET_ROUTING_INFO
EZWAVECOMMANDTYPE_STORE_NODE_INFO
EZWAVECOMMANDTYPE_STORE_HOMEID
EZWAVECOMMANDTYPE_LOCK_ROUTE_RESPONSE
EZWAVECOMMANDTYPE_GET_PRIORITY_ROUTE
EZWAVECOMMANDTYPE_SET_PRIORITY_ROUTE
EZWAVECOMMANDTYPE_SET_SLAVE_LEARN_MODE
EZWAVECOMMANDTYPE_IS_VIRTUAL_NODE
EZWAVECOMMANDTYPE_GET_VIRTUAL_NODES
EZWAVECOMMANDTYPE_GET_CONTROLLER_CAPABILITIES
EZWAVECOMMANDTYPE_SET_ROUTING_MAX
EZWAVECOMMANDTYPE_IS_PRIMARY_CTRL
EZWAVECOMMANDTYPE_ADD_NODE_TO_NETWORK
EZWAVECOMMANDTYPE_REMOVE_NODE_FROM_NETWORK
EZWAVECOMMANDTYPE_AES_ECB
EZWAVECOMMANDTYPE_GET_BACKGROUND_RSSI
EZWAVECOMMANDTYPE_REMOVE_FAILED_NODE_ID
EZWAVECOMMANDTYPE_REPLACE_FAILED_NODE_ID
EZWAVECOMMANDTYPE_PM_STAY_AWAKE
EZWAVECOMMANDTYPE_PM_CANCEL
EZWAVECOMMANDTYPE_PM_REGISTER
EZWAVECOMMANDTYPE_ZW_UPDATE_CTRL_NODE_INFORMATION
EZWAVECOMMANDTYPE_ZW_SET_LBT_THRESHOLD
EZWAVECOMMANDTYPE_ADD_NODE_DSK_TO_NETWORK
EZWAVECOMMANDTYPE_NETWORK_LEARN_MODE_START
EZWAVECOMMANDTYPE_CREAT_NEW_PRIMARY_CTRL
EZWAVECOMMANDTYPE_CONTROLLER_CHANGE
EZWAVECOMMANDTYPE_CLEAR_TX_TIMERS
EZWAVECOMMANDTYPE_ZW_SET_MAX_INCL_REQ_INTERVALS
EZWAVECOMMANDTYPE_NVM_BACKUP_OPEN
EZWAVECOMMANDTYPE_NVM_BACKUP_READ
EZWAVECOMMANDTYPE_NVM_BACKUP_WRITE
EZWAVECOMMANDTYPE_NVM_BACKUP_CLOSE
EZWAVECOMMANDTYPE_PM_SET_POWERDOWN_CALLBACK
EZWAVECOMMANDTYPE_SET_SECURITY_KEYS
EZWAVECOMMANDTYPE_SOFT_RESET
EZWAVECOMMANDTYPE_BOOTLOADER_REBOOT
EZWAVECOMMANDTYPE_REMOVE_NODEID_FROM_NETWORK
EZWAVECOMMANDTYPE_ZW_GET_INCLUDED_NODES
EZWAVECOMMANDTYPE_REQUESTNODENEIGHBORUPDATE
EZWAVECOMMANDTYPE_ZW_INITIATE_SHUTDOWN
EZWAVECOMMANDTYPE_ZW_GET_INCLUDED_LR_NODES
EZWAVECOMMANDTYPE_ZW_GET_LR_CHANNEL
EZWAVECOMMANDTYPE_ZW_SET_LR_CHANNEL
EZWAVECOMMANDTYPE_ZW_SET_LR_VIRTUAL_IDS
EZWAVECOMMANDTYPE_UNUSED1
EZWAVECOMMANDTYPE_UNUSED2
EZWAVECOMMANDTYPE_ZW_GET_PTI_CONFIG
EZWAVECOMMANDTYPE_ZW_SET_TX_ATTENUATION
EZWAVECOMMANDTYPE_SECURE_NETWORK_MANAGEMENT_ADD_NODE
EZWAVECOMMANDTYPE_SECURE_NETWORK_MANAGEMENT_ABORT
EZWAVECOMMANDTYPE_SECURE_NETWORK_MANAGEMENT_REMOVE_NODE
EZWAVECOMMANDTYPE_SECURE_SEND_DATA
EZWAVECOMMANDTYPE_SECURE_NETWORK_MANAGEMENT_LEARN_MODE_INCLUSION
EZWAVECOMMANDTYPE_SECURE_NETWORK_MANAGEMENT_LEARN_MODE_EXCLUSION
EZWAVECOMMANDTYPE_SECURE_NETWORK_MANAGEMENT_SET_SECURITY_FLAGS
EZWAVECOMMANDTYPE_ZW_GET_TX_POWER_MAX_SUPPORTED
EZWAVECOMMANDTYPE_REQUESTNODETYPE_NEIGHBORUPDATE
NUM_EZWAVECOMMANDTYPE
}

Z-Wave Command Types.

enum
EZWAVECOMMANDSTATUS_TX = APPLICATION_INTERFACE_STATUS_ENUM_OFFSET
EZWAVECOMMANDSTATUS_GENERATE_RANDOM
EZWAVECOMMANDSTATUS_NODE_INFO
EZWAVECOMMANDSTATUS_LEARN_MODE_STATUS
EZWAVECOMMANDSTATUS_SET_DEFAULT
EZWAVECOMMANDSTATUS_INVALID_TX_REQUEST
EZWAVECOMMANDSTATUS_INVALID_COMMAND
EZWAVECOMMANDSTATUS_SET_RF_RECEIVE_MODE
EZWAVECOMMANDSTATUS_IS_NODE_WITHIN_DIRECT_RANGE
EZWAVECOMMANDSTATUS_GET_NEIGHBOR_COUNT
EZWAVECOMMANDSTATUS_ARE_NODES_NEIGHBOURS
EZWAVECOMMANDSTATUS_IS_FAILED_NODE_ID
EZWAVECOMMANDSTATUS_GET_ROUTING_TABLE_LINE
EZWAVECOMMANDSTATUS_SET_ROUTING_INFO
EZWAVECOMMANDSTATUS_STORE_NODE_INFO
EZWAVECOMMANDSTATUS_GET_PRIORITY_ROUTE
EZWAVECOMMANDSTATUS_SET_PRIORITY_ROUTE
EZWAVECOMMANDSTATUS_SET_SLAVE_LEARN_MODE
EZWAVECOMMANDSTATUS_SET_SLAVE_LEARN_MODE_RESULT
EZWAVECOMMANDSTATUS_IS_VIRTUAL_NODE
EZWAVECOMMANDSTATUS_GET_VIRTUAL_NODES
EZWAVECOMMANDSTATUS_GET_CONTROLLER_CAPABILITIES
EZWAVECOMMANDSTATUS_IS_PRIMARY_CTRL
EZWAVECOMMANDSTATUS_NETWORK_MANAGEMENT
EZWAVECOMMANDSTATUS_GET_BACKGROUND_RSSI
EZWAVECOMMANDSTATUS_AES_ECB
EZWAVECOMMANDSTATUS_REMOVE_FAILED_NODE_ID
EZWAVECOMMANDSTATUS_REPLACE_FAILED_NODE_ID
EZWAVECOMMANDSTATUS_NETWORK_LEARN_MODE_START
EZWAVECOMMANDSTATUS_ZW_SET_MAX_INCL_REQ_INTERVALS
EZWAVECOMMANDSTATUS_NVM_BACKUP_RESTORE
EZWAVECOMMANDSTATUS_PM_SET_POWERDOWN_CALLBACK
EZWAVECOMMANDSTATUS_ZW_GET_INCLUDED_NODES
EZWAVECOMMANDSTATUS_ZW_REQUESTNODENEIGHBORUPDATE
EZWAVECOMMANDSTATUS_ZW_REQUESTNODETYPE_NEIGHBORUPDATE
EZWAVECOMMANDSTATUS_ZW_INITIATE_SHUTDOWN
EZWAVECOMMANDSTATUS_ZW_GET_INCLUDED_LR_NODES
EZWAVECOMMANDSTATUS_ZW_GET_LR_CHANNEL
EZWAVECOMMANDSTATUS_UNUSED1
EZWAVECOMMANDSTATUS_UNUSED2
EZWAVECOMMANDSTATUS_ZW_GET_PTI_CONFIG
EZWAVECOMMANDSTATUS_ZW_SET_TX_ATTENUATION
EZWAVECOMMANDSTATUS_SECURE_ON_NODE_ADDED
EZWAVECOMMANDSTATUS_SECURE_ON_NODE_DELETED
EZWAVECOMMANDSTATUS_SECURE_ON_NEW_NETWORK_ENTERED
EZWAVECOMMANDSTATUS_SECURE_ON_NETWORK_MANAGEMENT_STATE_UPDATE
EZWAVECOMMANDSTATUS_SECURE_ON_NEW_SUC
EZWAVECOMMANDSTATUS_SECURE_ON_FRAME_TRANSMISSION
EZWAVECOMMANDSTATUS_SECURE_ON_RX_FRAME_RECEIVED_INDICATOR
EZWAVECOMMANDSTATUS_ZW_SET_LR_CHANNEL
EZWAVECOMMANDSTATUS_ZW_GET_TX_POWER_MAX_SUPPORTED
NUM_EZWAVECOMMANDSTATUS
}

Z-Wave Command Status Type used by SZwaveCommandStatusPackage.

enum
EZWAVERECEIVETYPE_SINGLE = APPLICATION_INTERFACE_RECEIVE_ENUM_OFFSET
EZWAVERECEIVETYPE_MULTI
EZWAVERECEIVETYPE_NODE_UPDATE
EZWAVERECEIVETYPE_SECURITY_EVENT
EZWAVERECEIVETYPE_STAY_AWAKE
EZWAVERECEIVETYPE_SECURE_FRAME_RECEIVED
NUM_EZWAVERECEIVETYPE
}

Z-Wave Receive type.

enum
ELEARNMODE_DISABLED = 0
ELEARNMODE_CLASSIC = 1
ELEARNMODE_NETWORK_WIDE_INCLUSION = 2
ELEARNMODE_NETWORK_WIDE_EXCLUSION = 3
}

Typedefs#

typedef enum EZwaveTransmitType

Transmit Type enum used by SZwaveTransmitPackage.

typedef enum ELearnStatus

Learn mode status updates.

typedef enum EZwaveCommandType

Z-Wave Command Types.

Z-Wave Command Status Type used by SZwaveCommandStatusPackage.

typedef enum EZwaveReceiveType

Z-Wave Receive type.

typedef struct SNetworkUpdateRequest

Network Update Request.

typedef struct SNodeInfo
typedef struct SCommandClassSet_t

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

typedef struct SCommandGenerateRandom

Generates true random word.

typedef struct SSetSucNodeId

Controller API.

typedef struct SProtocolInfo

Protocol Info data.

typedef struct SNetworkInfo

Network Info.

typedef struct SProtocolConfig_t

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

typedef struct SIncludedNodeInfo

Contains info related to sending an INIF.

typedef struct STest
typedef struct SSendData
typedef struct SSendDataEx
typedef struct SReceiveNodeUpdate

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

typedef union UTransmitParameters

Transmit Parameters Union used by SZwaveTransmitPackage.

typedef union UCommandStatus

Command Status Union used by SZwaveCommandStatusPackage.

Z-Wave Command Status Package.

Functions#

STATIC_ASSERT(NUM_EZWAVETRANSMITTYPE<(APPLICATION_INTERFACE_TRANSMIT_ENUM_OFFSET+(APPLICATION_INTERFACE_COMMAND_ENUM_OFFSET)), STATIC_ASSERT_FAILED_interface_tx_enum_overlap)

Macros#

#define

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.

#define

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

#define
#define

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

Enumeration Documentation#

EProtocolType#

EProtocolType
Enumerator
EPROTOCOLTYPE_ZWAVE
EPROTOCOLTYPE_ZWAVE_AV
EPROTOCOLTYPE_ZWAVE_FOR_IP

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

ELibraryType#

ELibraryType
Enumerator
ELIBRARYTYPE_CONTROLLER_STATIC
ELIBRARYTYPE_CONTROLLER_PORTABLE

DEPRECATED.

ELIBRARYTYPE_SLAVE

DEPRECATED.

ELIBRARYTYPE_SLAVE_BEFORE_ENHANCED

Previously Slave Enhanced.

ELIBRARYTYPE_INSTALLER

DEPRECATED.

ELIBRARYTYPE_SLAVE_ROUTING

DEPRECATED.

ELIBRARYTYPE_CONTROLLER

DEPRECATED.

ELIBRARYTYPE_DUT

Previously Controller Bridge.

ELIBRARYTYPE_AVREMOTE

DEPRECATED.

ELIBRARYTYPE_AVDEVICE

DEPRECATED.


Definition at line 57 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

EInclusionState_t#

EInclusionState_t
Enumerator
EINCLUSIONSTATE_EXCLUDED
EINCLUSIONSTATE_UNSECURE_INCLUDED
EINCLUSIONSTATE_SECURE_INCLUDED

Definition at line 71 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

EListenBeforeTalkThreshold_t#

EListenBeforeTalkThreshold_t
Enumerator
ELISTENBEFORETALKTRESHOLD_DEFAULT

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

EtxPowerLevel_t#

EtxPowerLevel_t
Enumerator
ETXPOWERLEVEL_DEFAULT

Definition at line 83 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

EZwaveTransmitType#

EZwaveTransmitType

Transmit Type enum used by SZwaveTransmitPackage.

Enumerator
EZWAVETRANSMITTYPE_STD

EZWAVETRANSMITTYPE_STD.

EZWAVETRANSMITTYPE_EX

EZWAVETRANSMITTYPE_EX.

EZWAVETRANSMITTYPE_BRIDGE

EZWAVETRANSMITTYPE_BRIDGE.

EZWAVETRANSMITTYPE_MULTI

Multi types requires SZwaveTransmitPackage.NodeMask to be setup.

EZWAVETRANSMITTYPE_MULTI_EX

EZWAVETRANSMITTYPE_MULTI_EX.

EZWAVETRANSMITTYPE_MULTI_BRIDGE

EZWAVETRANSMITTYPE_MULTI_BRIDGE.

EZWAVETRANSMITTYPE_EXPLOREINCLUSIONREQUEST

EZWAVETRANSMITTYPE_EXPLOREINCLUSIONREQUEST.

EZWAVETRANSMITTYPE_EXPLOREEXCLUSIONREQUEST

EZWAVETRANSMITTYPE_EXPLOREEXCLUSIONREQUEST.

EZWAVETRANSMITTYPE_NETWORKUPDATEREQUEST

EZWAVETRANSMITTYPE_NETWORKUPDATEREQUEST.

EZWAVETRANSMITTYPE_NODEINFORMATION

EZWAVETRANSMITTYPE_NODEINFORMATION.

EZWAVETRANSMITTYPE_NODEINFORMATIONREQUEST

EZWAVETRANSMITTYPE_NODEINFORMATIONREQUEST.

EZWAVETRANSMITTYPE_TESTFRAME

EZWAVETRANSMITTYPE_TESTFRAME.

EZWAVETRANSMITTYPE_SETSUCNODEID

EZWAVETRANSMITTYPE_SETSUCNODEID.

EZWAVETRANSMITTYPE_SENDSUCNODEID

EZWAVETRANSMITTYPE_SENDSUCNODEID.

EZWAVETRANSMITTYPE_ASSIGNRETURNROUTE

EZWAVETRANSMITTYPE_ASSIGNRETURNROUTE.

EZWAVETRANSMITTYPE_DELETERETURNROUTE

EZWAVETRANSMITTYPE_DELETERETURNROUTE.

EZWAVETRANSMITTYPE_SENDREPLICATION

EZWAVETRANSMITTYPE_SENDREPLICATION.

EZWAVETRANSMITTYPE_SENDREPLICATIONRECEIVECOMPLETE

EZWAVETRANSMITTYPE_SENDREPLICATIONRECEIVECOMPLETE.

EZWAVETRANSMITTYPE_REQUESTNEWROUTEDESTINATIONS

EZWAVETRANSMITTYPE_REQUESTNEWROUTEDESTINATIONS.

EZWAVETRANSMITTYPE_SEND_SLAVE_NODE_INFORMATION

EZWAVETRANSMITTYPE_SEND_SLAVE_NODE_INFORMATION.

EZWAVETRANSMITTYPE_SEND_SLAVE_DATA

EZWAVETRANSMITTYPE_SEND_SLAVE_DATA.

EZWAVETRANSMITTYPE_INCLUDEDNODEINFORMATION

EZWAVETRANSMITTYPE_INCLUDEDNODEINFORMATION.

EZWAVETRANSMITTYPE_SECURE

EZWAVETRANSMITTYPE_SECURE.

EZWAVETRANSMITTYPE_NON_SECURE

EZWAVETRANSMITTYPE_NON_SECURE.

NUM_EZWAVETRANSMITTYPE

NUM_EZWAVETRANSMITTYPE.


Definition at line 91 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

ELearnStatus#

ELearnStatus

Learn mode status updates.

Enumerator
ELEARNSTATUS_ASSIGN_COMPLETE

Internal status.

ELEARNSTATUS_ASSIGN_NODEID_DONE

Internal status.

ELEARNSTATUS_ASSIGN_RANGE_INFO_UPDATE

Internal status.

ELEARNSTATUS_ASSIGN_INFO_PENDING

Internal status.

ELEARNSTATUS_ASSIGN_WAITING_FOR_FIND

Internal status.

ELEARNSTATUS_SMART_START_IN_PROGRESS

Passed to application when Smart Start learn mode goes into progress.

ELEARNSTATUS_LEARN_IN_PROGRESS

Passed to application when classic learn mode goes into progress.

ELEARNSTATUS_LEARN_MODE_COMPLETED_TIMEOUT

Passed to application if classic learn mode times out.

ELEARNSTATUS_LEARN_MODE_COMPLETED_FAILED

Passed to application if learn mode failed.


Definition at line 124 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

EZwaveCommandType#

EZwaveCommandType

Z-Wave Command Types.

Enumerator
EZWAVECOMMANDTYPE_GENERATE_RANDOM

Generate a specific number of random bytes.

EZWAVECOMMANDTYPE_NODE_INFO

Returns the Node Information Frame without command classes from the NVM for a given node ID.

EZWAVECOMMANDTYPE_CLEAR_NETWORK_STATISTICS

Clear the current network statistics collected by the Z-Wave protocol.

EZWAVECOMMANDTYPE_SET_LEARN_MODE

Enable/disable home/node ID learn mode.

EZWAVECOMMANDTYPE_SET_DEFAULT

Set the device back to the factory default state.

EZWAVECOMMANDTYPE_SEND_DATA_ABORT

Stop any application initiated transmits.

EZWAVECOMMANDTYPE_SET_PROMISCUOUS_MODE

Enable/disable the installer library promiscuous mode.

EZWAVECOMMANDTYPE_SET_RF_RECEIVE_MODE

Initialize the Z-Wave RF chip.

EZWAVECOMMANDTYPE_IS_NODE_WITHIN_DIRECT_RANGE
EZWAVECOMMANDTYPE_GET_NEIGHBOR_COUNT
EZWAVECOMMANDTYPE_ARE_NODES_NEIGHBOURS
EZWAVECOMMANDTYPE_IS_FAILED_NODE_ID

Test if a node ID is stored in the failed node ID list.

EZWAVECOMMANDTYPE_GET_ROUTING_TABLE_LINE

Read out neighbor information.

EZWAVECOMMANDTYPE_SET_ROUTING_INFO
EZWAVECOMMANDTYPE_STORE_NODE_INFO
EZWAVECOMMANDTYPE_STORE_HOMEID
EZWAVECOMMANDTYPE_LOCK_ROUTE_RESPONSE

If true then any attempt to purge a LastWorkingRoute entry is denied.

EZWAVECOMMANDTYPE_GET_PRIORITY_ROUTE

Get the route with the highest priority.

EZWAVECOMMANDTYPE_SET_PRIORITY_ROUTE

Set the Priority Route for a destination node.

EZWAVECOMMANDTYPE_SET_SLAVE_LEARN_MODE

Enable/disable home/node ID learn mode for virtual nodes.

EZWAVECOMMANDTYPE_IS_VIRTUAL_NODE

Check if node is a Virtual Slave node.

EZWAVECOMMANDTYPE_GET_VIRTUAL_NODES

Read the virtual node flags for all nodes in the network.

EZWAVECOMMANDTYPE_GET_CONTROLLER_CAPABILITIES

Returns the Controller capabilities.

EZWAVECOMMANDTYPE_SET_ROUTING_MAX

Set the maximum number of route tries which should be done before failing or resorting to exploring if this is specified.

EZWAVECOMMANDTYPE_IS_PRIMARY_CTRL

Returns wether the controller is a primary controller.

EZWAVECOMMANDTYPE_ADD_NODE_TO_NETWORK

Add any type of node to the network.

EZWAVECOMMANDTYPE_REMOVE_NODE_FROM_NETWORK
EZWAVECOMMANDTYPE_AES_ECB
EZWAVECOMMANDTYPE_GET_BACKGROUND_RSSI

Returns the most recent background RSSI levels detected.

EZWAVECOMMANDTYPE_REMOVE_FAILED_NODE_ID

Remove a node from the failed node list.

EZWAVECOMMANDTYPE_REPLACE_FAILED_NODE_ID

Replace a node from the failed node list.

EZWAVECOMMANDTYPE_PM_STAY_AWAKE
EZWAVECOMMANDTYPE_PM_CANCEL
EZWAVECOMMANDTYPE_PM_REGISTER
EZWAVECOMMANDTYPE_ZW_UPDATE_CTRL_NODE_INFORMATION
EZWAVECOMMANDTYPE_ZW_SET_LBT_THRESHOLD

Set the LBT RSSI level.

EZWAVECOMMANDTYPE_ADD_NODE_DSK_TO_NETWORK

If NetworkManagement.pHandle is not NULL#

EZWAVECOMMANDTYPE_NETWORK_LEARN_MODE_START

Enable/disable the Network Management module inclusion/exclusion mode sequence according to specified mode.

EZWAVECOMMANDTYPE_CREAT_NEW_PRIMARY_CTRL
EZWAVECOMMANDTYPE_CONTROLLER_CHANGE

Add a controller to the Z-Wave network and transfer the role as primary controller to it.

EZWAVECOMMANDTYPE_CLEAR_TX_TIMERS

Clear current Channel Transmit timers.

EZWAVECOMMANDTYPE_ZW_SET_MAX_INCL_REQ_INTERVALS

Set the maximum interval between SmartStart inclusion requests.

EZWAVECOMMANDTYPE_NVM_BACKUP_OPEN
EZWAVECOMMANDTYPE_NVM_BACKUP_READ
EZWAVECOMMANDTYPE_NVM_BACKUP_WRITE
EZWAVECOMMANDTYPE_NVM_BACKUP_CLOSE
EZWAVECOMMANDTYPE_PM_SET_POWERDOWN_CALLBACK

Register application functions to be called just before power down.

EZWAVECOMMANDTYPE_SET_SECURITY_KEYS

Initiate the S2 inclusion engine.

EZWAVECOMMANDTYPE_SOFT_RESET

Perform a soft reset.

EZWAVECOMMANDTYPE_BOOTLOADER_REBOOT
EZWAVECOMMANDTYPE_REMOVE_NODEID_FROM_NETWORK

Remove a specific node from a Z-Wave network.

EZWAVECOMMANDTYPE_ZW_GET_INCLUDED_NODES

Get the node IDs for the nodes included in the network.

EZWAVECOMMANDTYPE_REQUESTNODENEIGHBORUPDATE

Start neighbor discovery for node if primary and other nodes are present.

EZWAVECOMMANDTYPE_ZW_INITIATE_SHUTDOWN

Initiate graceful shutdown.

EZWAVECOMMANDTYPE_ZW_GET_INCLUDED_LR_NODES

Get the node IDs for the long range nodes included in the network.

EZWAVECOMMANDTYPE_ZW_GET_LR_CHANNEL

Get the current Primary Long Range Channel.

EZWAVECOMMANDTYPE_ZW_SET_LR_CHANNEL

Set the Primary Long Range Channel.

EZWAVECOMMANDTYPE_ZW_SET_LR_VIRTUAL_IDS

Enable Long Range virtual node IDs.

EZWAVECOMMANDTYPE_UNUSED1

Legacy command.

EZWAVECOMMANDTYPE_UNUSED2
EZWAVECOMMANDTYPE_ZW_GET_PTI_CONFIG

Check if the PTI Zniffer functionality is enabled/disabled.

EZWAVECOMMANDTYPE_ZW_SET_TX_ATTENUATION

Reduce Tx power of classic non-listening devices.

EZWAVECOMMANDTYPE_SECURE_NETWORK_MANAGEMENT_ADD_NODE

Add a new node to the network.

EZWAVECOMMANDTYPE_SECURE_NETWORK_MANAGEMENT_ABORT

Abort Inclusion or Exclusion of node.

EZWAVECOMMANDTYPE_SECURE_NETWORK_MANAGEMENT_REMOVE_NODE

Remove a node from the network.

EZWAVECOMMANDTYPE_SECURE_SEND_DATA

Unused.

EZWAVECOMMANDTYPE_SECURE_NETWORK_MANAGEMENT_LEARN_MODE_INCLUSION

Put the application in Network Wide Inclusion mode so it can be included in a network.

EZWAVECOMMANDTYPE_SECURE_NETWORK_MANAGEMENT_LEARN_MODE_EXCLUSION

Put the application in Network Wide Exclusion mode so it can be excluded from a network.

EZWAVECOMMANDTYPE_SECURE_NETWORK_MANAGEMENT_SET_SECURITY_FLAGS

Set security flags for a network node.

EZWAVECOMMANDTYPE_ZW_GET_TX_POWER_MAX_SUPPORTED

Get the maximum settable tx power.

EZWAVECOMMANDTYPE_REQUESTNODETYPE_NEIGHBORUPDATE
NUM_EZWAVECOMMANDTYPE

Definition at line 140 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

EZwaveCommandStatusType#

EZwaveCommandStatusType

Z-Wave Command Status Type used by SZwaveCommandStatusPackage.

Enumerator
EZWAVECOMMANDSTATUS_TX

EZWAVECOMMANDSTATUS_TX.

EZWAVECOMMANDSTATUS_GENERATE_RANDOM

EZWAVECOMMANDSTATUS_GENERATE_RANDOM.

EZWAVECOMMANDSTATUS_NODE_INFO

EZWAVECOMMANDSTATUS_NODE_INFO.

EZWAVECOMMANDSTATUS_LEARN_MODE_STATUS

EZWAVECOMMANDSTATUS_LEARN_MODE_STATUS.

EZWAVECOMMANDSTATUS_SET_DEFAULT
EZWAVECOMMANDSTATUS_INVALID_TX_REQUEST

Received when protocol has finished starting up, and after receiving a set default command, has no content.

EZWAVECOMMANDSTATUS_INVALID_COMMAND

Received Tx Request that was not a EZWAVETRANSMITTYPE.

EZWAVECOMMANDSTATUS_SET_RF_RECEIVE_MODE

Receveid command that was not a EZWAVECOMMANDTYPE value.

EZWAVECOMMANDSTATUS_IS_NODE_WITHIN_DIRECT_RANGE

EZWAVECOMMANDSTATUS_IS_NODE_WITHIN_DIRECT_RANGE.

EZWAVECOMMANDSTATUS_GET_NEIGHBOR_COUNT

EZWAVECOMMANDSTATUS_GET_NEIGHBOR_COUNT.

EZWAVECOMMANDSTATUS_ARE_NODES_NEIGHBOURS

EZWAVECOMMANDSTATUS_ARE_NODES_NEIGHBOURS.

EZWAVECOMMANDSTATUS_IS_FAILED_NODE_ID

EZWAVECOMMANDSTATUS_IS_FAILED_NODE_ID.

EZWAVECOMMANDSTATUS_GET_ROUTING_TABLE_LINE

EZWAVECOMMANDSTATUS_GET_ROUTING_TABLE_LINE.

EZWAVECOMMANDSTATUS_SET_ROUTING_INFO

EZWAVECOMMANDSTATUS_SET_ROUTING_INFO.

EZWAVECOMMANDSTATUS_STORE_NODE_INFO

EZWAVECOMMANDSTATUS_STORE_NODE_INFO.

EZWAVECOMMANDSTATUS_GET_PRIORITY_ROUTE

EZWAVECOMMANDSTATUS_GET_PRIORITY_ROUTE.

EZWAVECOMMANDSTATUS_SET_PRIORITY_ROUTE

EZWAVECOMMANDSTATUS_SET_PRIORITY_ROUTE.

EZWAVECOMMANDSTATUS_SET_SLAVE_LEARN_MODE

EZWAVECOMMANDSTATUS_SET_SLAVE_LEARN_MODE.

EZWAVECOMMANDSTATUS_SET_SLAVE_LEARN_MODE_RESULT

EZWAVECOMMANDSTATUS_SET_SLAVE_LEARN_MODE_RESULT.

EZWAVECOMMANDSTATUS_IS_VIRTUAL_NODE

EZWAVECOMMANDSTATUS_IS_VIRTUAL_NODE.

EZWAVECOMMANDSTATUS_GET_VIRTUAL_NODES

EZWAVECOMMANDSTATUS_GET_VIRTUAL_NODES.

EZWAVECOMMANDSTATUS_GET_CONTROLLER_CAPABILITIES

EZWAVECOMMANDSTATUS_GET_CONTROLLER_CAPABILITIES.

EZWAVECOMMANDSTATUS_IS_PRIMARY_CTRL

EZWAVECOMMANDSTATUS_IS_PRIMARY_CTRL.

EZWAVECOMMANDSTATUS_NETWORK_MANAGEMENT

EZWAVECOMMANDSTATUS_NETWORK_MANAGEMENT.

EZWAVECOMMANDSTATUS_GET_BACKGROUND_RSSI

EZWAVECOMMANDSTATUS_GET_BACKGROUND_RSSI.

EZWAVECOMMANDSTATUS_AES_ECB

EZWAVECOMMANDSTATUS_AES_ECB.

EZWAVECOMMANDSTATUS_REMOVE_FAILED_NODE_ID

EZWAVECOMMANDSTATUS_REMOVE_FAILED_NODE_ID.

EZWAVECOMMANDSTATUS_REPLACE_FAILED_NODE_ID

EZWAVECOMMANDSTATUS_REPLACE_FAILED_NODE_ID.

EZWAVECOMMANDSTATUS_NETWORK_LEARN_MODE_START

EZWAVECOMMANDSTATUS_NETWORK_LEARN_MODE_START.

EZWAVECOMMANDSTATUS_ZW_SET_MAX_INCL_REQ_INTERVALS

EZWAVECOMMANDSTATUS_ZW_SET_MAX_INCL_REQ_INTERVALS.

EZWAVECOMMANDSTATUS_NVM_BACKUP_RESTORE

EZWAVECOMMANDSTATUS_NVM_BACKUP_RESTORE.

EZWAVECOMMANDSTATUS_PM_SET_POWERDOWN_CALLBACK

EZWAVECOMMANDSTATUS_PM_SET_POWERDOWN_CALLBACK.

EZWAVECOMMANDSTATUS_ZW_GET_INCLUDED_NODES

EZWAVECOMMANDSTATUS_ZW_GET_INCLUDED_NODES.

EZWAVECOMMANDSTATUS_ZW_REQUESTNODENEIGHBORUPDATE

EZWAVECOMMANDSTATUS_ZW_REQUESTNODENEIGHBORUPDATE.

EZWAVECOMMANDSTATUS_ZW_REQUESTNODETYPE_NEIGHBORUPDATE

EZWAVECOMMANDSTATUS_ZW_REQUESTNODETYPENEIGHBORUPDATE.

EZWAVECOMMANDSTATUS_ZW_INITIATE_SHUTDOWN

EZWAVECOMMANDSTATUS_ZW_INITIATE_SHUTDOWN.

EZWAVECOMMANDSTATUS_ZW_GET_INCLUDED_LR_NODES

EZWAVECOMMANDSTATUS_ZW_GET_INCLUDED_LR_NODES.

EZWAVECOMMANDSTATUS_ZW_GET_LR_CHANNEL

EZWAVECOMMANDSTATUS_ZW_GET_LR_CHANNEL.

EZWAVECOMMANDSTATUS_UNUSED1

EZWAVECOMMANDSTATUS_UNUSED1.

EZWAVECOMMANDSTATUS_UNUSED2

EZWAVECOMMANDSTATUS_UNUSED2.

EZWAVECOMMANDSTATUS_ZW_GET_PTI_CONFIG

EZWAVECOMMANDSTATUS_ZW_GET_PTI_CONFIG.

EZWAVECOMMANDSTATUS_ZW_SET_TX_ATTENUATION

EZWAVECOMMANDSTATUS_ZW_SET_TX_ATTENUATION.

EZWAVECOMMANDSTATUS_SECURE_ON_NODE_ADDED

The node is completely added using the ControllerPortable lib.

EZWAVECOMMANDSTATUS_SECURE_ON_NODE_DELETED

The node is completely removed using the ControllerPortable lib.

EZWAVECOMMANDSTATUS_SECURE_ON_NEW_NETWORK_ENTERED

Node entered a new network.

EZWAVECOMMANDSTATUS_SECURE_ON_NETWORK_MANAGEMENT_STATE_UPDATE

Secure network management changed state.

EZWAVECOMMANDSTATUS_SECURE_ON_NEW_SUC

New SUC NodeID received.

EZWAVECOMMANDSTATUS_SECURE_ON_FRAME_TRANSMISSION

Frame transmission result.

EZWAVECOMMANDSTATUS_SECURE_ON_RX_FRAME_RECEIVED_INDICATOR

Frame received from NodeID indicator.

EZWAVECOMMANDSTATUS_ZW_SET_LR_CHANNEL

EZWAVECOMMANDSTATUS_ZW_SET_LR_CHANNEL.

EZWAVECOMMANDSTATUS_ZW_GET_TX_POWER_MAX_SUPPORTED

EZWAVECOMMANDSTATUS_ZW_GET_TX_POWER_MAX_SUPPORTED.

NUM_EZWAVECOMMANDSTATUS

NUM_EZWAVECOMMANDSTATUS.


Definition at line 1194 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

EZwaveReceiveType#

EZwaveReceiveType

Z-Wave Receive type.

Enumerator
EZWAVERECEIVETYPE_SINGLE

EZWAVERECEIVETYPE_SINGLE.

EZWAVERECEIVETYPE_MULTI

EZWAVERECEIVETYPE_MULTI.

EZWAVERECEIVETYPE_NODE_UPDATE

EZWAVERECEIVETYPE_NODE_UPDATE.

EZWAVERECEIVETYPE_SECURITY_EVENT

EZWAVERECEIVETYPE_SECURITY_EVENT.

EZWAVERECEIVETYPE_STAY_AWAKE

EZWAVERECEIVETYPE_STAY_AWAKE.

EZWAVERECEIVETYPE_SECURE_FRAME_RECEIVED

Event received from the SECURE module.

NUM_EZWAVERECEIVETYPE

NUM_EZWAVERECEIVETYPE.


Definition at line 1257 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

ELearnMode#

ELearnMode
Enumerator
ELEARNMODE_DISABLED
ELEARNMODE_CLASSIC
ELEARNMODE_NETWORK_WIDE_INCLUSION
ELEARNMODE_NETWORK_WIDE_EXCLUSION

Definition at line 1279 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

Typedef Documentation#

EProtocolType#

typedef enum EProtocolType EProtocolType

Definition at line 55 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

ELibraryType#

typedef enum ELibraryType ELibraryType

Definition at line 69 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

EInclusionState_t#

typedef enum EInclusionState_t EInclusionState_t

Definition at line 76 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

EListenBeforeTalkThreshold_t#

typedef enum EListenBeforeTalkThreshold_t EListenBeforeTalkThreshold_t

Definition at line 81 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

EtxPowerLevel_t#

typedef enum EtxPowerLevel_t EtxPowerLevel_t

Definition at line 86 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

EZwaveTransmitType#

typedef enum EZwaveTransmitType EZwaveTransmitType

Transmit Type enum used by SZwaveTransmitPackage.


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

ELearnStatus#

typedef enum ELearnStatus ELearnStatus

Learn mode status updates.


Definition at line 135 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

EZwaveCommandType#

typedef enum EZwaveCommandType EZwaveCommandType

Z-Wave Command Types.


Definition at line 1189 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

EZwaveCommandStatusType#

typedef enum EZwaveCommandStatusType EZwaveCommandStatusType

Z-Wave Command Status Type used by SZwaveCommandStatusPackage.


Definition at line 1252 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

EZwaveReceiveType#

typedef enum EZwaveReceiveType EZwaveReceiveType

Z-Wave Receive type.


Definition at line 1266 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SNetworkUpdateRequest#

typedef struct SNetworkUpdateRequest SNetworkUpdateRequest

Network Update Request.


Definition at line 1276 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

ELearnMode#

typedef enum ELearnMode ELearnMode

Definition at line 1285 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SNodeInfoRequest#

typedef struct SNodeInfoRequest SNodeInfoRequest

Definition at line 1294 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SNodeInfo#

typedef struct SNodeInfo SNodeInfo

Definition at line 1303 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandClassList_t#

typedef struct SCommandClassList_t SCommandClassList_t

Definition at line 1312 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandClassSet_t#

typedef struct SCommandClassSet_t SCommandClassSet_t

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


Definition at line 1323 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandClassVersions#

typedef struct SCommandClassVersions SCommandClassVersions

Definition at line 1330 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandGenerateRandom#

typedef struct SCommandGenerateRandom SCommandGenerateRandom

Generates true random word.


Definition at line 1336 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandNodeInfo#

typedef struct SCommandNodeInfo SCommandNodeInfo

Definition at line 1341 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandClearNetworkStatistics#

typedef struct SCommandClearNetworkStatistics SCommandClearNetworkStatistics

Definition at line 1346 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandSetLearnMode#

typedef struct SCommandSetLearnMode SCommandSetLearnMode

Definition at line 1352 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandSetSmartStartLearnMode#

typedef struct SCommandSetSmartStartLearnMode SCommandSetSmartStartLearnMode

Definition at line 1357 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SSetSucNodeId#

typedef struct SSetSucNodeId SSetSucNodeId

Controller API.


Definition at line 1369 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandSetRfPowerLevel#

typedef struct SCommandSetRfPowerLevel SCommandSetRfPowerLevel

Definition at line 1375 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SSendSucNodeId#

typedef struct SSendSucNodeId SSendSucNodeId

Definition at line 1385 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandSetPromiscuousMode#

typedef struct SCommandSetPromiscuousMode SCommandSetPromiscuousMode

Definition at line 1391 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SAssignReturnRoute#

typedef struct SAssignReturnRoute SAssignReturnRoute

Definition at line 1404 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandSetRfReceiveMode#

typedef struct SCommandSetRfReceiveMode SCommandSetRfReceiveMode

Definition at line 1410 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SDeleteReturnRoute#

typedef struct SDeleteReturnRoute SDeleteReturnRoute

Definition at line 1420 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandGeniric8bParameter#

typedef struct SCommandGeniric8bParameter SCommandGeniric8bParameter

Definition at line 1425 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandGeniric16bParameter#

typedef struct SCommandGeniric16bParameter SCommandGeniric16bParameter

Definition at line 1430 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandAreNodesNeighbours#

typedef struct SCommandAreNodesNeighbours SCommandAreNodesNeighbours

Definition at line 1436 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandGetRoutingInfo#

typedef struct SCommandGetRoutingInfo SCommandGetRoutingInfo

Definition at line 1442 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SSendSlaveNodeInformation#

typedef struct SSendSlaveNodeInformation SSendSlaveNodeInformation

Definition at line 1452 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandSetRoutingInfo#

typedef struct SCommandSetRoutingInfo SCommandSetRoutingInfo

Definition at line 1460 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandStoreNodeInfo#

typedef struct SCommandStoreNodeInfo SCommandStoreNodeInfo

Definition at line 1466 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandStoreHomeID#

typedef struct SCommandStoreHomeID SCommandStoreHomeID

Definition at line 1472 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandSetPriorityRoute#

typedef struct SCommandSetPriorityRoute SCommandSetPriorityRoute

Definition at line 1480 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandAesEcb#

typedef struct SCommandAesEcb SCommandAesEcb

Definition at line 1486 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandGetPriorityRoute#

typedef struct SCommandGetPriorityRoute SCommandGetPriorityRoute

Definition at line 1493 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandFailedNodeIDCmd#

typedef struct SCommandFailedNodeIDCmd SCommandFailedNodeIDCmd

Definition at line 1499 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandPMSetPowerDownCallback#

typedef struct SCommandPMSetPowerDownCallback SCommandPMSetPowerDownCallback

Definition at line 1503 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandSetLBTThreshold#

typedef struct SCommandSetLBTThreshold SCommandSetLBTThreshold

Definition at line 1509 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandSetMaxInclReqInterval#

typedef struct SCommandSetMaxInclReqInterval SCommandSetMaxInclReqInterval

Definition at line 1513 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandNvmBackupRestore#

typedef struct SCommandNvmBackupRestore SCommandNvmBackupRestore

Definition at line 1519 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandSetSecurityKeys#

typedef struct SCommandSetSecurityKeys SCommandSetSecurityKeys

Definition at line 1524 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SProtocolVersion#

typedef struct SProtocolVersion SProtocolVersion

Definition at line 1533 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SProtocolInfo#

typedef struct SProtocolInfo SProtocolInfo

Protocol Info data.


Definition at line 1542 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SNetworkInfo#

typedef struct SNetworkInfo SNetworkInfo

Network Info.


Definition at line 1553 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SLongRangeInfo#

typedef struct SLongRangeInfo SLongRangeInfo

Definition at line 1558 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

t_ExtNodeInfo#

typedef struct t_ExtNodeInfo t_ExtNodeInfo

Definition at line 1564 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SRadioStatus#

typedef struct SRadioStatus SRadioStatus

Definition at line 1569 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SApplicationHandles#

typedef struct SApplicationHandles SApplicationHandles

Definition at line 1600 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SRadioConfig_t#

typedef struct SRadioConfig_t SRadioConfig_t

Definition at line 1610 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SAppNodeInfo_t#

typedef struct SAppNodeInfo_t SAppNodeInfo_t

Definition at line 1616 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SVirtualSlaveNodeInfo_t#

typedef struct SVirtualSlaveNodeInfo_t SVirtualSlaveNodeInfo_t

Definition at line 1624 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SVirtualSlaveNodeInfoTable_t#

typedef struct SVirtualSlaveNodeInfoTable_t SVirtualSlaveNodeInfoTable_t

Definition at line 1630 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

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


Definition at line 1641 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

STransmitFrameConfig#

typedef struct STransmitFrameConfig STransmitFrameConfig

Definition at line 1651 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SExploreInclusionRequest#

typedef struct SExploreInclusionRequest SExploreInclusionRequest

Definition at line 1657 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SExploreExclusionRequest#

typedef struct SExploreExclusionRequest SExploreExclusionRequest

Definition at line 1662 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SIncludedNodeInfo#

typedef struct SIncludedNodeInfo SIncludedNodeInfo

Contains info related to sending an INIF.


Definition at line 1671 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

STest#

typedef struct STest STest

Definition at line 1683 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SSendData#

typedef struct SSendData SSendData

Definition at line 1690 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SSendDataEx#

typedef struct SSendDataEx SSendDataEx

Definition at line 1700 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SSendDataBridge#

typedef struct SSendDataBridge SSendDataBridge

Definition at line 1707 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SSendDataMulti#

typedef struct SSendDataMulti SSendDataMulti

Definition at line 1713 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SSendDataMultiEx#

typedef struct SSendDataMultiEx SSendDataMultiEx

Definition at line 1721 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SSendDataMultiBridge#

typedef struct SSendDataMultiBridge SSendDataMultiBridge

Definition at line 1729 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandNetworkManagement#

typedef struct SCommandNetworkManagement SCommandNetworkManagement

Definition at line 1739 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SSendReplication#

typedef struct SSendReplication SSendReplication

Definition at line 1747 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SSendReplicationReceiveComplete#

typedef struct SSendReplicationReceiveComplete SSendReplicationReceiveComplete

Definition at line 1752 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SRequestNewRouteDestinations#

typedef struct SRequestNewRouteDestinations SRequestNewRouteDestinations

Definition at line 1762 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandNetworkManagementDSK#

typedef struct SCommandNetworkManagementDSK SCommandNetworkManagementDSK

Definition at line 1771 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZWaveTransmitStatus#

typedef struct SZWaveTransmitStatus SZWaveTransmitStatus

Definition at line 1779 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZWaveGenerateRandomStatus#

typedef struct SZWaveGenerateRandomStatus SZWaveGenerateRandomStatus

Definition at line 1785 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZWaveNodeInfoStatus#

typedef struct SZWaveNodeInfoStatus SZWaveNodeInfoStatus

Definition at line 1791 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZWaveLearnModeStatus#

typedef struct SZWaveLearnModeStatus SZWaveLearnModeStatus

Definition at line 1796 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZWaveInvalidTxRequestStatus#

typedef struct SZWaveInvalidTxRequestStatus SZWaveInvalidTxRequestStatus

Definition at line 1801 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZWaveInvalidCommandStatus#

typedef struct SZWaveInvalidCommandStatus SZWaveInvalidCommandStatus

Definition at line 1806 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZWaveGeneric8bStatus#

typedef struct SZWaveGeneric8bStatus SZWaveGeneric8bStatus

Definition at line 1811 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZWaveGenericBoolStatus#

typedef struct SZWaveGenericBoolStatus SZWaveGenericBoolStatus

Definition at line 1817 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandRequestNodeNeighborUpdate#

typedef struct SCommandRequestNodeNeighborUpdate SCommandRequestNodeNeighborUpdate

Definition at line 1826 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandRequestNodeTypeNeighborUpdate#

typedef struct SCommandRequestNodeTypeNeighborUpdate SCommandRequestNodeTypeNeighborUpdate

Definition at line 1836 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZWaveGetRoutingInfoStatus#

typedef struct SZWaveGetRoutingInfoStatus SZWaveGetRoutingInfoStatus

Definition at line 1842 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandInitiateShutdown#

typedef struct SCommandInitiateShutdown SCommandInitiateShutdown

Definition at line 1849 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SCommandSetSecurityFlags#

typedef struct SCommandSetSecurityFlags SCommandSetSecurityFlags

Definition at line 1858 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZWaveGetPriorityRouteStatus#

typedef struct SZWaveGetPriorityRouteStatus SZWaveGetPriorityRouteStatus

Definition at line 1865 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZWaveSetPriorityRouteStatus#

typedef struct SZWaveSetPriorityRouteStatus SZWaveSetPriorityRouteStatus

Definition at line 1870 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZWaveGetVirtualNodesStatus#

typedef struct SZWaveGetVirtualNodesStatus SZWaveGetVirtualNodesStatus

Definition at line 1875 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZWaveAesEcbStatus#

typedef struct SZWaveAesEcbStatus SZWaveAesEcbStatus

Definition at line 1880 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZWaveGetBackgroundRssiStatus#

typedef struct SZWaveGetBackgroundRssiStatus SZWaveGetBackgroundRssiStatus

Definition at line 1885 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZWaveNetworkManagementStatus#

typedef struct SZWaveNetworkManagementStatus SZWaveNetworkManagementStatus

Definition at line 1892 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SNvmBackupRestoreStatus#

typedef struct SNvmBackupRestoreStatus SNvmBackupRestoreStatus

Definition at line 1897 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZWaveGetIncludedNodes#

typedef struct SZWaveGetIncludedNodes SZWaveGetIncludedNodes

Definition at line 1902 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZWaveGetIncludedNodesLR#

typedef struct SZWaveGetIncludedNodesLR SZWaveGetIncludedNodesLR

Definition at line 1907 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZWaveTxPowerMaxSupported#

typedef struct SZWaveTxPowerMaxSupported SZWaveTxPowerMaxSupported

Definition at line 1912 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SReceiveNodeUpdate#

typedef struct SReceiveNodeUpdate SReceiveNodeUpdate

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

Parameters
[in]bNodeID
[in]pCmd

Pointer of the updated node's node info.

[in]bLen

The length of the pCmd parameter.

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 .


Definition at line 1981 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SReceiveSecurityEvent#

typedef struct SReceiveSecurityEvent SReceiveSecurityEvent

Definition at line 1999 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

UTransmitParameters#

typedef union UTransmitParameters UTransmitParameters

Transmit Parameters Union used by SZwaveTransmitPackage.


Definition at line 2031 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

UCommandStatus#

typedef union UCommandStatus UCommandStatus

Command Status Union used by SZwaveCommandStatusPackage.


Definition at line 2076 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

UReceiveCmdPayload#

typedef union UReceiveCmdPayload UReceiveCmdPayload

Definition at line 2082 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

UCommandParameters#

typedef union UCommandParameters UCommandParameters

Definition at line 2125 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZwaveTransmitPackage#

typedef struct SZwaveTransmitPackage SZwaveTransmitPackage

Definition at line 2136 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZwaveCommandStatusPackage#

typedef struct SZwaveCommandStatusPackage SZwaveCommandStatusPackage

Z-Wave Command Status Package.


Definition at line 2145 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZwaveCommandPackage#

typedef struct SZwaveCommandPackage SZwaveCommandPackage

Definition at line 2151 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SReceiveSingle#

typedef struct SReceiveSingle SReceiveSingle

Definition at line 2160 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SReceiveMulti#

typedef struct SReceiveMulti SReceiveMulti

Definition at line 2168 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

UReceiveParameters#

typedef union UReceiveParameters UReceiveParameters

Definition at line 2177 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

SZwaveReceivePackage#

typedef struct SZwaveReceivePackage SZwaveReceivePackage

Definition at line 2183 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

Function Documentation#

STATIC_ASSERT#

STATIC_ASSERT ()

Definition at line 2188 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

Macro Definition Documentation#

ZW_MAX_PAYLOAD_SIZE#

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


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

MULTICAST_NODE_LIST_SIZE#

#define MULTICAST_NODE_LIST_SIZE
Value:
64

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


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

TX_BUFFER_SIZE#

#define TX_BUFFER_SIZE
Value:
170

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

MAX_NODE_INFO_LENGTH#

#define MAX_NODE_INFO_LENGTH
Value:
159

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


Definition at line 43 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

APPLICATION_INTERFACE_TRANSMIT_ENUM_OFFSET#

#define APPLICATION_INTERFACE_TRANSMIT_ENUM_OFFSET
Value:
(0x00)

Definition at line 45 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

APPLICATION_INTERFACE_COMMAND_ENUM_OFFSET#

#define APPLICATION_INTERFACE_COMMAND_ENUM_OFFSET
Value:
(0x40)

Definition at line 46 of file /mnt/raid/workspaces/ws.WDdsgIAV6/overlay/gsdk/protocol/z-wave/ZWave/API/ZW_application_transport_interface.h

APPLICATION_INTERFACE_RECEIVE_ENUM_OFFSET#

#define APPLICATION_INTERFACE_RECEIVE_ENUM_OFFSET
Value:
(0x80)

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

APPLICATION_INTERFACE_STATUS_ENUM_OFFSET#

#define APPLICATION_INTERFACE_STATUS_ENUM_OFFSET
Value:
(0xC0)

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