Z-Wave Application Transport Interface#
Modules#
SCommandClearNetworkStatistics
SCommandSetSmartStartLearnMode
SCommandPMSetPowerDownCallback
SCommandRequestNodeNeighborUpdate
SCommandRequestNodeTypeNeighborUpdate
Enumerations#
Transmit Type enum used by SZwaveTransmitPackage.
Learn mode status updates.
Z-Wave Command Types.
Z-Wave Command Status Type used by SZwaveCommandStatusPackage.
Z-Wave Receive type.
Typedefs#
Transmit Type enum used by SZwaveTransmitPackage.
Learn mode status updates.
Z-Wave Command Types.
Z-Wave Command Status Type used by SZwaveCommandStatusPackage.
Z-Wave Receive type.
Network Update Request.
List of Command Classes supported when device is not included, included insecurely or included securely.
Generates true random word.
Controller API.
Protocol Info data.
Network Info.
This allows "nulling" a pointer while modifying a virtual slave node info Or changing pointer to point to a different one.
Contains info related to sending an INIF.
The Z Wave protocol MAY notify an application by sending SReceiveNodeUpdate when a Node Information Frame has been received.
Transmit Parameters Union used by SZwaveTransmitPackage.
Command Status Union used by SZwaveCommandStatusPackage.
Z-Wave Command Status Package.
Macros#
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.
Numbers of nodes we can support when sending multicast frames on LR channel.
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 | |
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. |
EInclusionState_t#
EInclusionState_t
| Enumerator | |
|---|---|
| EINCLUSIONSTATE_EXCLUDED | |
| EINCLUSIONSTATE_UNSECURE_INCLUDED | |
| EINCLUSIONSTATE_SECURE_INCLUDED | |
EListenBeforeTalkThreshold_t#
EListenBeforeTalkThreshold_t
| Enumerator | |
|---|---|
| ELISTENBEFORETALKTRESHOLD_DEFAULT | |
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_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. |
| EZWAVETRANSMITTYPE_NLS | EZWAVETRANSMITTYPE_NLS. |
| NUM_EZWAVETRANSMITTYPE | NUM_EZWAVETRANSMITTYPE. |
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. |
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 | |
| EZWAVECOMMANDTYPE_TRANSFER_PROTOCOL_CC | |
| EZWAVECOMMANDTYPE_ENABLE_NODE_NLS | |
| EZWAVECOMMANDTYPE_GET_NODE_NLS_STATE | |
| EZWAVECOMMANDTYPE_SEND_PROTOCOL_DATA_CB | |
| NUM_EZWAVECOMMANDTYPE | |
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. |
| EZWAVECOMMANDSTATUS_GET_NODE_NLS_STATE | EZWAVECOMMANDSTATUS_GET_NODE_NLS_STATE. |
| EZWAVECOMMANDSTATUS_ENABLE_NODE_NLS | EZWAVECOMMANDSTATUS_ENABLE_NODE_NLS. |
| NUM_EZWAVECOMMANDSTATUS | NUM_EZWAVECOMMANDSTATUS. |
| EZWAVECOMMANDSTATUS_INVALID | |
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. |
| EZWAVERECEIVETYPE_REQUEST_ENCRYPTION_FRAME | EZWAVERECEIVETYPE_REQUEST_ENCRYPTION_FRAME. |
| NUM_EZWAVERECEIVETYPE | NUM_EZWAVERECEIVETYPE. |
| EZWAVERECEIVETYPE_INVALID | |
EProtocolEvent#
EProtocolEvent
| Enumerator | |
|---|---|
| EPROTOCOLEVENT_RFRXBEAM | |
| EPROTOCOLEVENT_RFTXCOMPLETE | |
| EPROTOCOLEVENT_RFRX | |
| EPROTOCOLEVENT_RFTXBEAM | |
| EPROTOCOLEVENT_RFTXFAILLBT | |
| EPROTOCOLEVENT_RFTXFAIL | |
| EPROTOCOLEVENT_RFRXABORT | |
| EPROTOCOLEVENT_TIMER | |
| EPROTOCOLEVENT_EXPLORE | |
| EPROTOCOLEVENT_APP_TX | |
| EPROTOCOLEVENT_APP_COMMAND | |
| EPROTOCOLEVENT_NETWORKID_UPDATE | |
| EPROTOCOLEVENT_CHANGE_RADIO_PHY | |
| EPROTOCOLEVENT_RADIO_ASSERT | |
| EPROTOCOLEVENT_RADIO_TX_TIMEOUT | |
| EPROTOCOLEVENT_RADIO_CALIBRATE | |
| NUM_EPROTOCOLEVENT | |
ERequestEncryptionEvent#
ERequestEncryptionEvent
| Enumerator | |
|---|---|
| ERPCCEEVENT_SERIALAPI_FAIL | |
| ERPCCEEVENT_SERIALAPI_OK | |
ELearnMode#
ELearnMode
| Enumerator | |
|---|---|
| ELEARNMODE_DISABLED | |
| ELEARNMODE_CLASSIC | |
| ELEARNMODE_NETWORK_WIDE_INCLUSION | |
| ELEARNMODE_NETWORK_WIDE_EXCLUSION | |
Typedef Documentation#
EZwaveTransmitType#
typedef enum EZwaveTransmitType EZwaveTransmitType
Transmit Type enum used by SZwaveTransmitPackage.
EZwaveCommandStatusType#
typedef enum EZwaveCommandStatusType EZwaveCommandStatusType
Z-Wave Command Status Type used by SZwaveCommandStatusPackage.
SNetworkUpdateRequest#
typedef struct SNetworkUpdateRequest SNetworkUpdateRequest
Network Update Request.
SCommandClassSet_t#
typedef struct SCommandClassSet_t SCommandClassSet_t
List of Command Classes supported when device is not included, included insecurely or included securely.
SCommandGenerateRandom#
typedef struct SCommandGenerateRandom SCommandGenerateRandom
Generates true random word.
SCommandClearNetworkStatistics#
typedef struct SCommandClearNetworkStatistics SCommandClearNetworkStatistics
SCommandSetSmartStartLearnMode#
typedef struct SCommandSetSmartStartLearnMode SCommandSetSmartStartLearnMode
SCommandPMSetPowerDownCallback#
typedef struct SCommandPMSetPowerDownCallback SCommandPMSetPowerDownCallback
SCommandSetMaxInclReqInterval#
typedef struct SCommandSetMaxInclReqInterval SCommandSetMaxInclReqInterval
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
STransmitProtocolFrameConfig#
typedef struct STransmitProtocolFrameConfig STransmitProtocolFrameConfig
SIncludedNodeInfo#
typedef struct SIncludedNodeInfo SIncludedNodeInfo
Contains info related to sending an INIF.
SRequestNewRouteDestinations#
typedef struct SRequestNewRouteDestinations SRequestNewRouteDestinations
SCommandNetworkManagementDSK#
typedef struct SCommandNetworkManagementDSK SCommandNetworkManagementDSK
SZWaveInvalidTxRequestStatus#
typedef struct SZWaveInvalidTxRequestStatus SZWaveInvalidTxRequestStatus
SCommandRequestNodeNeighborUpdate#
typedef struct SCommandRequestNodeNeighborUpdate SCommandRequestNodeNeighborUpdate
SCommandRequestNodeTypeNeighborUpdate#
typedef struct SCommandRequestNodeTypeNeighborUpdate SCommandRequestNodeTypeNeighborUpdate
SZWaveGetPriorityRouteStatus#
typedef struct SZWaveGetPriorityRouteStatus SZWaveGetPriorityRouteStatus
SZWaveSetPriorityRouteStatus#
typedef struct SZWaveSetPriorityRouteStatus SZWaveSetPriorityRouteStatus
SZWaveGetBackgroundRssiStatus#
typedef struct SZWaveGetBackgroundRssiStatus SZWaveGetBackgroundRssiStatus
SZWaveNetworkManagementStatus#
typedef struct SZWaveNetworkManagementStatus SZWaveNetworkManagementStatus
SCommandGetNodeNLSStateStatus#
typedef struct SCommandGetNodeNLSStateStatus SCommandGetNodeNLSStateStatus
SReceiveNodeUpdate#
typedef struct SReceiveNodeUpdate SReceiveNodeUpdate
The Z Wave protocol MAY notify an application by sending SReceiveNodeUpdate when a Node Information Frame has been received.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| [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 .
UTransmitParameters#
typedef union UTransmitParameters UTransmitParameters
Transmit Parameters Union used by SZwaveTransmitPackage.
UCommandStatus#
typedef union UCommandStatus UCommandStatus
Command Status Union used by SZwaveCommandStatusPackage.
SZwaveCommandStatusPackage#
typedef struct SZwaveCommandStatusPackage SZwaveCommandStatusPackage
Z-Wave Command Status Package.