mirror of
https://github.com/Fishwaldo/qt-openzwave.git
synced 2025-07-06 13:18:19 +00:00
update doco
This commit is contained in:
parent
326df3464c
commit
329248ac8d
3 changed files with 188 additions and 45 deletions
|
@ -2,5 +2,5 @@
|
||||||
A QT5 Wrapper for OpenZWave.
|
A QT5 Wrapper for OpenZWave.
|
||||||
|
|
||||||
## HASS MQTT Client Adapter
|
## HASS MQTT Client Adapter
|
||||||
Please see [doc/MQTT.md](doc/MQTT.md) for further information
|
Please see [docs/MQTT.md](docs/MQTT.md) for further information
|
||||||
|
|
||||||
|
|
229
docs/MQTT.md
229
docs/MQTT.md
|
@ -10,9 +10,63 @@ Start Container with the following command line:
|
||||||
|
|
||||||
(replace MQTT_SERVER with IP address of the MQTT Server and all /dev/ttyUSB0 entries with path to your USB Stick
|
(replace MQTT_SERVER with IP address of the MQTT Server and all /dev/ttyUSB0 entries with path to your USB Stick
|
||||||
|
|
||||||
## MQTT Commands
|
## MQTT Topic Structure
|
||||||
|
The MQTT Client for OZW will send messages to a MQTT Broker with a predifined topic structure. The structure of the messages are detailed in the sections below.
|
||||||
|
|
||||||
Most OZW "Commands" asyncronys meaning that the results of the command may not be immediatly available and require talking to the Device on your network.
|
All topics live under the `OpenZWave/` topic structure.
|
||||||
|
|
||||||
|
The MQTT Client allows for several different instances of OZW (and controllers) to run in parallel (thus manage several different networks). Different instances are indicated by a number and must be specified when starting the MQTT Client. Each instance will then publish to `OpenZWave/<instance/>`
|
||||||
|
|
||||||
|
The Status of the MQTT Client is published to the Status Topic as detailed in [MQTT Client Status](#mqtt-client-status)
|
||||||
|
|
||||||
|
Individual Nodes and the related values are published to the Nodes Topic
|
||||||
|
|
||||||
|
Statistics are published to either the Nodes Topic, or to the Instance Topic for OZW (if its Network wide Statistics)
|
||||||
|
|
||||||
|
Applications can communicate with the Network or control the MQTT Client via the [MQTT Commands](#mqtt-commands) and indvidual commands are documented in the [Commands List](#commands-list)
|
||||||
|
|
||||||
|
Network Related events or status changes to nodes (not relating to Values) are sent as [Notifications](#notifiations)
|
||||||
|
|
||||||
|
# MQTT Client Status
|
||||||
|
The MQTT Client status relays the status of the OZW Daemon and overall network status when starting up.
|
||||||
|
|
||||||
|
The Status is published to `OpenZWave/<instance>/status/` and payload is set to be retained by the MQTT Broker, so the payload should always indicate the most recent status of OZW.
|
||||||
|
|
||||||
|
The Payload is:
|
||||||
|
|
||||||
|
"Status" - Enum: Indicates what state the library is in as far as if its ready, active or starting up.
|
||||||
|
* *Offline* - The MQTT Daemon is not running. This is set as Will Message, and will be published when the MQTT Client disconnects from the Broker.
|
||||||
|
* *starting* - the MQTT Daemon is starting up. Its reading config files and initilizing. This does not indicate it is bringing the network online.
|
||||||
|
* *started* - The MQTT Daemon has started and will transition to the Ready state shortly.
|
||||||
|
* *stoped* - OZW has been stopped and the network is offline.
|
||||||
|
* *Ready* - OZW is up and running and ready to Start. The Client Application should send a "open" command to attach OZW to a serial port that is connected to a ZWave USB Dongle.
|
||||||
|
* *driverReady* - OZW has opened the Serial Port and is initilzing the USB Controller.
|
||||||
|
* *driverFailed* - OZW failed to start the Serial Port Driver or Initilize the USB Controller.
|
||||||
|
* *driverReset* - The Driver has been reset and OZW is offline.
|
||||||
|
* *driverRemoved* - The Driver has been removed. Usually emitted when shuting down, or executing the close command.
|
||||||
|
* *driverAllNodesQueriedSomeDead* - OZW has Initilized the Network and completed querying Devices on the Network. Some Nodes were detected as Dead and should be either removed or resurected after performing diagnostics on the affected nodes.
|
||||||
|
* *driverAllNodesQueried* - OZW has Initilized the Network and completed querying all devices on the Network.
|
||||||
|
* *driverAwakeNodesQueried* - OZW has Initilized the Network, and completed querying all "awake" or mains powered devices. Battery or Sleeping Devices may still be not fully initilized and need to be woken up before they are fully operational
|
||||||
|
|
||||||
|
"TimeStamp" - uint64: Timestamp when the Message was sent. Applications can use this to track when the status was updated
|
||||||
|
|
||||||
|
"homeID" - uint: Decimal Representation of the Network ID or Home ID when the ZWave Network is operational.
|
||||||
|
|
||||||
|
"ManufacturerSpecificDBReady" - Bool: Indicates that the Config Files have been loaded and are valid. A false reading here indicates a problem with the config files and OZW may not be able to function fully.
|
||||||
|
|
||||||
|
# Node and Value Topics
|
||||||
|
The MQTT Client publishes details about Nodes and their related Values in a hierarchical manner. The Node and Value topics are set to be retained by the MQTT Broker, so as long as the [Status message](#mqtt-client-status) is "driverAllNodesQueriedSomeDead", "driverAllNodesQueried" or "driverAwakeNodesQueried", then you can be assured it is the latest data.
|
||||||
|
|
||||||
|
When the MQTT Client initially connects to the Broker, it will clean up any previous Nodes/Values payloads that are stored on the Broker. Client Applications should not interpret this "cleanup" as Nodes or Values being deleted. (Applications should only take action on a Node/Value topic being removed when the Status Message indicates OZW is operational)
|
||||||
|
|
||||||
|
Node related information is published to `OpenZWave/<instance>/node/<nodeid>/`. See below for details on the most important parts of the Payload.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
# MQTT Commands
|
||||||
|
|
||||||
|
Most OZW "Commands" run asynchronously meaning that the results of the command may not be immediately available and require talking to the Device on your network.
|
||||||
|
|
||||||
The MQTT Client for OZW will usually report the status of each command it process in at least one stage, although some commands will return the progress of the command:
|
The MQTT Client for OZW will usually report the status of each command it process in at least one stage, although some commands will return the progress of the command:
|
||||||
|
|
||||||
|
@ -28,7 +82,7 @@ As OZW and Z-Wave in general operates in a asynchronous manner, feedback about m
|
||||||
|
|
||||||
In the Command List Section below, these immediate updates are indicated as "Returns" and are sent to the `OpenZWave/<instance>/event/<command>/` topic
|
In the Command List Section below, these immediate updates are indicated as "Returns" and are sent to the `OpenZWave/<instance>/event/<command>/` topic
|
||||||
|
|
||||||
For Commands that send subsequent updates, these are sent to the `OpenZWave/<instance>/event/Notification/` topic with the payload described below. Please note, that some "Notifications" maybe unsolicited, such as Timeout messages, or when commands are executed by another client application.
|
For Commands that send subsequent updates, these are sent as "Notifications" to the `OpenZWave/<instance>/event/<topic>/` topic with the payload described below. Please note, that some "Notifications" maybe unsolicited, such as Timeout messages, or when commands are executed by another client application, or changes in the Z-Wave Network. Please see the Notifications Section for details.
|
||||||
|
|
||||||
## Return Payload
|
## Return Payload
|
||||||
|
|
||||||
|
@ -42,16 +96,107 @@ The Payload for these returns are below. For commands where the result of a comm
|
||||||
|
|
||||||
"error" - Text - If present, a short description of why the command failed. Could be things like malformed JSON payload, missing Parameters, incorrect parameter types (a string instead of integer JSON value for example), or in some cases, invalid NodeID's passed to the command.
|
"error" - Text - If present, a short description of why the command failed. Could be things like malformed JSON payload, missing Parameters, incorrect parameter types (a string instead of integer JSON value for example), or in some cases, invalid NodeID's passed to the command.
|
||||||
|
|
||||||
## Notification Payload
|
# Notifications
|
||||||
|
|
||||||
Notifications are issued to update the application on the success/failure or action required by a user/application in response to a command. Some Notifications may be unsolicited (due to a event on the ZWave Network) while others are only sent in response to commands.
|
Notifications are issued to update the application on the success/failure or action required by a user/application in response to a command or something happening on the ZWave Network. Some Notifications may be unsolicited (due to a event on the ZWave Network) while others are only sent in response to commands.
|
||||||
|
|
||||||
#
|
Some commands will send further updates as the are executed on the Network. These are indicated as Notifications in the individual [Command Lists](#commands-lists) section.
|
||||||
|
|
||||||
Some commands will send further updates as the are executed on the Network. These are indicated as Notifications in the Command List.
|
Notifications are sent to a specific topic that relates to the type of Notification, or Command that triggered it. The Topic that a command may reply on are indicated in the CommmandList. Note, some Notifications may be sent even without a application executing a command. This may be due to another client application, or activity on the network.
|
||||||
|
The topics are located at `OpenZWave/<instance>/event/<topic>/`
|
||||||
|
|
||||||
Commands Lists
|
There are 3 General Types of Notifications:
|
||||||
==============
|
1. Controller Commands - These are Notifications that are generated by Commands Executed by the USB Controller
|
||||||
|
2. Generic Notifications - Usually Related to the state of individual nodes on the Network (such as Awake/Sleeping/Alive/Dead)
|
||||||
|
3. User Notifications - These are Generated by OZW and usually should be conveyed to the user in some mannoer.
|
||||||
|
|
||||||
|
## Controller Notifications
|
||||||
|
These commands related to some activity or action performed by a controller. Either Executed by a Application or a event on the Network.
|
||||||
|
|
||||||
|
"Node" - uint8: If applicable, the Node that this Notification is for.
|
||||||
|
|
||||||
|
"State" - Enum: Reports the progress, or state of a command being executed on the network. Not all States are applicable for all commands. The Possible Options are:
|
||||||
|
|
||||||
|
* *Ctrl_State_Normal* - OZW is in normal operations mode
|
||||||
|
* *Ctrl_State_Starting* - The Action is starting. OZW is now in Controller Mode.
|
||||||
|
* *Ctrl_State_Cancel* - The Action is canceled. OZW is returning to Network Mode.
|
||||||
|
* *Ctrl_State_Error* - A error occurred. Consult the Error field.
|
||||||
|
* *Ctrl_State_Waiting* - The Action is pending a User Activity, such as setting the device into inclusion/exclusion mode etc.
|
||||||
|
* *Ctrl_State_Sleeping* - The Device is Sleeping.
|
||||||
|
* *Ctrl_State_InProgress* - The Action is in progress.
|
||||||
|
* *Ctrl_State_Completed* - The Action completed. OZW is returning to Network Mode.
|
||||||
|
* *Ctrl_State_Failed* - The Action Failed. OZW is returning to Network Mode.
|
||||||
|
* *Ctrl_State_NodeOk* - The Node is marked as healthy.
|
||||||
|
* *Ctrl_State_NodeFailed* - The Node is marked as dead.
|
||||||
|
|
||||||
|
"Error" - Enum: When the Z-Wave Network returns a error for a command, This field will contain details about the error detected:
|
||||||
|
* *Ctrl_Error_None* - No Error Occurred.
|
||||||
|
* *Ctrl_Error_ButtonNotFound* - The Button was not found.
|
||||||
|
* *Ctrl_Error_NodeNotFound* - The Node was not found.
|
||||||
|
* *Ctrl_Error_NotBridge* - The Controller is not of a Bridge Type Controller.
|
||||||
|
* *Ctrl_Error_NotSUC* - The Node is not a SUC (Static Update Controller).
|
||||||
|
* *Ctrl_Error_NotSecondary* - The Controller is not a Secondary Controller.
|
||||||
|
* *Ctrl_Error_NotPrimary* - The Controller is not a Primary Controller.
|
||||||
|
* *Ctrl_Error_IsPrimary* - The Controller is a Primary Controller.
|
||||||
|
* *Ctrl_Error_NotFound* - The Node/Action etc was not Found.
|
||||||
|
* *Ctrl_Error_Busy* - The Network or Controller are busy and cannot perform the action requested.
|
||||||
|
* *Ctrl_Error_Failed* - The Command/Action Failed.
|
||||||
|
* *Ctrl_Error_Disabled* - The Command/Action is disabled by OZW or the controller.
|
||||||
|
* *Ctrl_Error_OverFlow* - The Controller has overflowed and cannot continue.
|
||||||
|
|
||||||
|
"Command" - Enum: For some cases, where a notification is related to a Command, this field will be present:
|
||||||
|
* *Ctrl_Cmd_None* - No Specific Command is related to this Notification.
|
||||||
|
* *Ctrl_Cmd_AddNode* - This notification is related to a AddNode Command.
|
||||||
|
* *Ctrl_Cmd_CreateNewPrimary* - This notification is related to a CreateNewPrimary Command.
|
||||||
|
* *Ctrl_Cmd_ReceiveConfiguration* - This notification is related to a ReceiveConfiguration Command (usually related to changing a Primary/Secondary Controller)
|
||||||
|
* *Ctrl_Cmd_RemoveNode* - This Notification is related to a Remove Node Command.
|
||||||
|
* *Ctrl_Cmd_RemoveFailedNode* - This Notification is related to a RemoveFailedNode Command.
|
||||||
|
* *Ctrl_Cmd_HasNodeFailed* - This Notification is related to a HasNodeFailed Command.
|
||||||
|
* *Ctrl_Cmd_ReplaceFailedNode* - This Notification is related to a ReplaceFailedNode Command.
|
||||||
|
* *Ctrl_Cmd_TransferPrimaryRole* - This Notifiation is related to a TransferPrimaryRole Command.
|
||||||
|
* *Ctrl_Cmd_RequestNetworkUpdate* - This Notification is related to a RequestNetworkUpdate Command.
|
||||||
|
* *Ctrl_Cmd_RequestNodeNeighborUpdate* - This Notification is related to a RequestNodeNeighborUpdate Command.
|
||||||
|
* *Ctrl_Cmd_AssignReturnRoute* - This Notification is related to a AssignReturnRoute Command.
|
||||||
|
* *Ctrl_Cmd_DeleteAllReturnRoute* - This Notification is related to a DeleteAllReturnRoute Notification.
|
||||||
|
* *Ctrl_Cmd_SendNodeInformation* - This Notification is related to a SendNodeInformation Command
|
||||||
|
* *Ctrl_Cmd_ReplicationSend* - This Notification is Related to Controller Replication Commands.
|
||||||
|
* *Ctrl_Cmd_CreateButton* - This Notification is related to CreateButton Commands.
|
||||||
|
* *Ctrl_Cmd_DeleteButton* - This Notification is related to DeleteButton Commands.
|
||||||
|
|
||||||
|
## Generic Notifications
|
||||||
|
These Notifications are sent to the `OpenZWave/<instance>/event/Notification/` topic and contain the following payload.
|
||||||
|
|
||||||
|
"Node" - uin8: The Node that this notification relates to
|
||||||
|
|
||||||
|
"Event" - Enum: The type of event that occurred:
|
||||||
|
* Notification_Code_MsgComplete - The Message Transaction is completed. This will only be sent if Enabled via the Options Class/Config File.
|
||||||
|
* Notification_Code_MsgTimeout - A Message to the Node Timed out. Could indicate a Network issue, or unsupported command on the Node
|
||||||
|
* Notification_Code_NoOperation - The Node Replied to a No Operation Packet.
|
||||||
|
* Notification_Code_NodeAwake - The Node is now awake.
|
||||||
|
* Notification_Code_NodeAsleep - The Node is now asleep
|
||||||
|
* Notification_Code_NodeDead - The Node has been marked as Dead.
|
||||||
|
* Notification_Code_NodeAlive - The Node has been marked as alive.
|
||||||
|
|
||||||
|
## User Notifications
|
||||||
|
These Notifications Related to events that should be conveyed to the user somehow to indicate activity or action that needs to be taken. These Notifications are sent to the `OpenZWave/<instance>/event/UserAlert/` topic and contain the following payload:
|
||||||
|
|
||||||
|
"Node" - uint8: The Node that this notification relates to
|
||||||
|
|
||||||
|
"Event" - Enum: The Type of Event that occurred:
|
||||||
|
* Notification_User_None - There is no Event.
|
||||||
|
* Notification_User_ConfigOutOfDate - A Config File is out of date and the user should consider executing the [downloadLatestConfigFileRevision](#downloadLatestConfigFileRevision) commannd to update it.
|
||||||
|
* Notification_User_MFSOutOfDate - The manufacturer_specific.xml file is out of date, and a user should consider executing the [downloadLatestMFSRevision](#downloadLatestMFSRevision) command to update it.
|
||||||
|
* Notification_User_ConfigFileDownloadFailed - A Config file failed to download.
|
||||||
|
* Notification_User_DNSError - A error occurred looking up the latest config file revisions
|
||||||
|
* Notification_User_NodeReloadRequired - The User should reload a node. This is often emmited after a new config file was downloaded. The user should consider executing [refreshNodeInfo](#refreshNodeInfo)
|
||||||
|
* Notification_User_UnsupportedController - The Controller is not supported by OZW.
|
||||||
|
* Notification_User_ApplicationStatus_Retry - The Node did not accept a update/packet and wants the application to retry. The delay the application should retry in is indicated in a "Retry" field present in the payload.
|
||||||
|
* Notification_User_ApplicationStatus_Queued - The Node has queued a update/packet for execution at a later time.
|
||||||
|
* Notification_User_ApplicationStatus_Rejected - The Node has rejected a update/packet.
|
||||||
|
|
||||||
|
|
||||||
|
# Commands Lists
|
||||||
|
This is a list of Commands that the MQTT Client will accept and process. As mentioned above, the Commands often return a status, and then subsequent notifications to indicate the progress or success/failure of the command.
|
||||||
|
|
||||||
## addNode
|
## addNode
|
||||||
|
|
||||||
|
@ -65,13 +210,11 @@ Commands Lists
|
||||||
|
|
||||||
**Notifications**:
|
**Notifications**:
|
||||||
|
|
||||||
Event "addNode" - Status if the Controller has sucessfully entered into Inclusion Mode or not.
|
topic "addNode" - Status if the Controller has successfully entered into Inclusion Mode or not.
|
||||||
|
|
||||||
Event "ControllerCommand" - When Controller enters and exits from Inclusion Mode
|
|
||||||
|
|
||||||
**Notes**:
|
**Notes**:
|
||||||
|
|
||||||
If a Node is succesfully added, its details will be progressively added to the Nodes topic with all applicable ValueID's
|
If a Node is successfully added, its details will be progressively added to the Nodes topic with all applicable ValueID's
|
||||||
|
|
||||||
**See Also**:
|
**See Also**:
|
||||||
[cancelControllerCommand](#cancelControllerCommand)
|
[cancelControllerCommand](#cancelControllerCommand)
|
||||||
|
@ -88,7 +231,7 @@ Commands Lists
|
||||||
|
|
||||||
**Notification**:
|
**Notification**:
|
||||||
|
|
||||||
Event "assignReturnRoute" - Status of the Controller after issuing the command to the Node.
|
topic "assignReturnRoute" - Status of the Controller after issuing the command to the Node.
|
||||||
|
|
||||||
**Notes**:
|
**Notes**:
|
||||||
|
|
||||||
|
@ -116,7 +259,7 @@ Commands Lists
|
||||||
|
|
||||||
**Params**:
|
**Params**:
|
||||||
|
|
||||||
"node" - uint8: Instructs OZW to check if it has hte latest version of the confile file for a particular node
|
"node" - uint8: Instructs OZW to check if it has the latest version of the config file for a particular node
|
||||||
|
|
||||||
**Returns**:
|
**Returns**:
|
||||||
|
|
||||||
|
@ -124,9 +267,9 @@ Commands Lists
|
||||||
|
|
||||||
**Notification**:
|
**Notification**:
|
||||||
|
|
||||||
"Notification" with the field "Event" set to Alert_ConfigOutOfDate if the Config file is out of date. Payload of the Message should include the Node in question
|
Topic "Notification" with the field "Event" set to Alert_ConfigOutOfDate if the Config file is out of date. Payload of the Message should include the Node in question
|
||||||
|
|
||||||
"Notification" with Event field set to "Alert_DNSError" - OZW could not get the latest version due to a DNS Failure.
|
Topic "Notification" with Event field set to "Alert_DNSError" - OZW could not get the latest version due to a DNS Failure.
|
||||||
|
|
||||||
**Note**:
|
**Note**:
|
||||||
OZW will check if the installation has the latest config file for a particular node.
|
OZW will check if the installation has the latest config file for a particular node.
|
||||||
|
@ -147,12 +290,12 @@ Commands Lists
|
||||||
|
|
||||||
**Notification**:
|
**Notification**:
|
||||||
|
|
||||||
"Notification" with the field "Event" set to Alert_MFSOutOfDate if the Manufacturer_specific.xml file is out of date.
|
Topic "Notification" with the field "Event" set to Alert_MFSOutOfDate if the Manufacturer_specific.xml file is out of date.
|
||||||
|
|
||||||
"Notification" with Event field set to "Alert_DNSError" - OZW could not get the latest version due to a DNS Failure.
|
Topic "Notification" with Event field set to "Alert_DNSError" - OZW could not get the latest version due to a DNS Failure.
|
||||||
|
|
||||||
**Note**:
|
**Note**:
|
||||||
OZW will check if the installation has the latest manufacturer_specific.xml file. Use this if you have a device that is not recongised but present in the latest release of OZW.
|
OZW will check if the installation has the latest manufacturer_specific.xml file. Use this if you have a device that is not recognized but present in the latest release of OZW.
|
||||||
|
|
||||||
**See Also**:
|
**See Also**:
|
||||||
[checkLastestConfigFileRevision](#checkLastestConfigFileRevision), [downloadLatestConfigFileRevision](#downloadLatestConfigFileRevision), [downloadLatestMSFRevision](#downloadLatestMSFRevision)
|
[checkLastestConfigFileRevision](#checkLastestConfigFileRevision), [downloadLatestConfigFileRevision](#downloadLatestConfigFileRevision), [downloadLatestMSFRevision](#downloadLatestMSFRevision)
|
||||||
|
@ -173,7 +316,7 @@ Commands Lists
|
||||||
|
|
||||||
**Note**:
|
**Note**:
|
||||||
|
|
||||||
As OZW shuts down, it will progressively delete values/notes and association information from the MQTT Topics. Applications should not treat the disappearance of these values as NodeDeleted or ValueDeleted once a "close" event is recieved
|
As OZW shuts down, it will progressively delete values/notes and association information from the MQTT Topics. Applications should not treat the disappearance of these values as NodeDeleted or ValueDeleted once a "close" event is received
|
||||||
|
|
||||||
**See Also**:
|
**See Also**:
|
||||||
|
|
||||||
|
@ -191,7 +334,7 @@ Commands Lists
|
||||||
|
|
||||||
**Notification**:
|
**Notification**:
|
||||||
|
|
||||||
deleteAllReturnRoute - Status of the command after OZW has processed it.
|
Topic "deleteAllReturnRoute" - Status of the command after OZW has processed it.
|
||||||
|
|
||||||
**Note**:
|
**Note**:
|
||||||
|
|
||||||
|
@ -208,9 +351,9 @@ Commands Lists
|
||||||
Event "downloadLatestConfigFileRevision" - if OZW accepted the command
|
Event "downloadLatestConfigFileRevision" - if OZW accepted the command
|
||||||
|
|
||||||
**Notification**:
|
**Notification**:
|
||||||
"Notification" with Event field set to "Alert_ConfigFileDownloadFailed" - The Download Failed for whatever reason
|
topic "Notification" with Event field set to "Alert_ConfigFileDownloadFailed" - The Download Failed for whatever reason
|
||||||
|
|
||||||
"Notification" with Event field set to "Alert_NodeReloadRequired" - The Node Information needs to be reloaded, via the [refreshNodeInfo](#refreshNodeInfo) Command.
|
topic "Notification" with Event field set to "Alert_NodeReloadRequired" - The Node Information needs to be reloaded, via the [refreshNodeInfo](#refreshNodeInfo) Command.
|
||||||
|
|
||||||
**Note**:
|
**Note**:
|
||||||
|
|
||||||
|
@ -232,7 +375,7 @@ Commands Lists
|
||||||
|
|
||||||
**Notification**:
|
**Notification**:
|
||||||
|
|
||||||
"Notification" with Event field set to "Alert_ConfigFileDownloadFailed" - The Download Failed for whatever reason.
|
topic "Notification" with Event field set to "Alert_ConfigFileDownloadFailed" - The Download Failed for whatever reason.
|
||||||
|
|
||||||
**Note**:
|
**Note**:
|
||||||
|
|
||||||
|
@ -260,7 +403,7 @@ Commands Lists
|
||||||
|
|
||||||
**Note**:
|
**Note**:
|
||||||
|
|
||||||
This will factory reset the Controller. All Nodes will need to be reincluded after this command. Applications should completely reset the state of Z-Wave.
|
This will factory reset the Controller. All Nodes will need to be re-included after this command. Applications should completely reset the state of Z-Wave.
|
||||||
|
|
||||||
**See Also**:
|
**See Also**:
|
||||||
[softResetController](#softResetController)
|
[softResetController](#softResetController)
|
||||||
|
@ -277,7 +420,7 @@ Commands Lists
|
||||||
|
|
||||||
**Notification**:
|
**Notification**:
|
||||||
|
|
||||||
"hasNodeFailed" - Sent after the Controller as tested the Node.
|
topic "hasNodeFailed" - Sent after the Controller as tested the Node.
|
||||||
|
|
||||||
**Note**:
|
**Note**:
|
||||||
|
|
||||||
|
@ -302,7 +445,7 @@ Commands Lists
|
||||||
None
|
None
|
||||||
|
|
||||||
**Note**:
|
**Note**:
|
||||||
This asks the Z-Wave Network to rediscover nodes, neighbours and routes on the Network. This command should only be used under the following circumstances:
|
This asks the Z-Wave Network to rediscover nodes, neighbors and routes on the Network. This command should only be used under the following circumstances:
|
||||||
1) Adding or Deleting Nodes
|
1) Adding or Deleting Nodes
|
||||||
2) Physically Moving a Device
|
2) Physically Moving a Device
|
||||||
If you have a pure Z-Wave+ (or ZWave+2) network, this command *should* not be used.
|
If you have a pure Z-Wave+ (or ZWave+2) network, this command *should* not be used.
|
||||||
|
@ -332,7 +475,7 @@ See Also:
|
||||||
|
|
||||||
**Notes**:
|
**Notes**:
|
||||||
|
|
||||||
Asks a Node to recalculate its neighbours and routes to other devices.
|
Asks a Node to recalculate its neighbors and routes to other devices.
|
||||||
See warning for [healNetwork](#healNetwork).
|
See warning for [healNetwork](#healNetwork).
|
||||||
|
|
||||||
**See Also**:
|
**See Also**:
|
||||||
|
@ -390,7 +533,7 @@ See Also:
|
||||||
|
|
||||||
**Returns**:
|
**Returns**:
|
||||||
|
|
||||||
"ping" - Field "pong" set to the value of the ping variabvle in the Command
|
"ping" - Field "pong" set to the value of the ping variable in the Command
|
||||||
|
|
||||||
**Notification**:
|
**Notification**:
|
||||||
|
|
||||||
|
@ -434,7 +577,7 @@ See Also:
|
||||||
|
|
||||||
**Notification**:
|
**Notification**:
|
||||||
|
|
||||||
"RemoveFailedNode" - The status of the Controller removing the failed node.
|
topic "RemoveFailedNode" - The status of the Controller removing the failed node.
|
||||||
|
|
||||||
**Notes**:
|
**Notes**:
|
||||||
|
|
||||||
|
@ -456,7 +599,7 @@ See Also:
|
||||||
|
|
||||||
**Notification**:
|
**Notification**:
|
||||||
|
|
||||||
"RemoveNode" - When the Controller has entered the Excluding Mode.
|
topic "RemoveNode" - When the Controller has entered the Excluding Mode.
|
||||||
|
|
||||||
**Notes**:
|
**Notes**:
|
||||||
|
|
||||||
|
@ -478,7 +621,7 @@ See Also:
|
||||||
|
|
||||||
**Notification**:
|
**Notification**:
|
||||||
|
|
||||||
"replaceFailedNode" - When the Controller has entered the replacefailednode state.
|
topic "replaceFailedNode" - When the Controller has entered the replacefailednode state.
|
||||||
|
|
||||||
**Notes**:
|
**Notes**:
|
||||||
|
|
||||||
|
@ -516,9 +659,9 @@ See Also:
|
||||||
|
|
||||||
**Params**:
|
**Params**:
|
||||||
|
|
||||||
"node" - uint8: the NodeID of the device yu wish to get a Config Param
|
"node" - uint8: the NodeID of the device you wish to get a Config Param
|
||||||
|
|
||||||
"param" - uint8: THe index of the Config Param you wish to get.
|
"param" - uint8: The index of the Config Param you wish to get.
|
||||||
|
|
||||||
**Returns**:
|
**Returns**:
|
||||||
|
|
||||||
|
@ -544,7 +687,7 @@ See Also:
|
||||||
|
|
||||||
**Returns**:
|
**Returns**:
|
||||||
|
|
||||||
"requestNetworkUpdate" - if OZW accpeted the command
|
"requestNetworkUpdate" - if OZW accepted the command
|
||||||
|
|
||||||
**Notification**:
|
**Notification**:
|
||||||
|
|
||||||
|
@ -584,11 +727,11 @@ See Also:
|
||||||
|
|
||||||
**Notification**:
|
**Notification**:
|
||||||
|
|
||||||
"requestNodeNeighborUpdate" - Once the Node has a updated Neighbour list.
|
topic "requestNodeNeighborUpdate" - Once the Node has a updated Neighbor list.
|
||||||
|
|
||||||
**Notes**:
|
**Notes**:
|
||||||
|
|
||||||
Synchronises the list of Neighbours a node has.
|
Synchronizes the list of Neighbors a node has.
|
||||||
|
|
||||||
|
|
||||||
## requestNodeState
|
## requestNodeState
|
||||||
|
@ -621,7 +764,7 @@ See Also:
|
||||||
|
|
||||||
**Notification**:
|
**Notification**:
|
||||||
|
|
||||||
"SendNodeInformation" - The status after sending a NIF to the device.
|
topic "SendNodeInformation" - The status after sending a NIF to the device.
|
||||||
|
|
||||||
**Notes**:
|
**Notes**:
|
||||||
|
|
||||||
|
@ -671,7 +814,7 @@ See Also:
|
||||||
|
|
||||||
**Notification**:
|
**Notification**:
|
||||||
|
|
||||||
"Notification" with Event Type set to "Code_NoOperation" - A Notification for each packet the Nodes Respond to, or a Notification with Event Type set to "Code_Timeout" if a Node failed to respond
|
topic "Notification" with Event Type set to *Code_NoOperation* - A Notification for each packet the Nodes Respond to, or a Notification with Event Type set to *Code_Timeout* if a Node failed to respond
|
||||||
|
|
||||||
**Notes**:
|
**Notes**:
|
||||||
|
|
||||||
|
@ -691,13 +834,13 @@ See Also:
|
||||||
|
|
||||||
**Returns**:
|
**Returns**:
|
||||||
|
|
||||||
"testNetworkNode" - if OZW accepted the command
|
"testNetworkNode" - if OZW accepted the command
|
||||||
|
|
||||||
**Notification**:
|
**Notification**:
|
||||||
|
|
||||||
"Notification" with a Event Type set to "Code_NoOperation" - a Notification for each packet the Node Responds to.
|
topic "Notification" with a Event Type set to *Code_NoOperation* - a Notification for each packet the Node Responds to.
|
||||||
|
|
||||||
"Notification" with Event Type set to "Code_Timeout" if the Node Failed to respond.
|
topic "Notification" with Event Type set to *Code_Timeout* if the Node Failed to respond.
|
||||||
|
|
||||||
**Notes**:
|
**Notes**:
|
||||||
|
|
||||||
|
|
|
@ -688,7 +688,7 @@ void mqttpublisher::ozwNotification(quint8 node, NotificationTypes::QTOZW_Notifi
|
||||||
this->sendCommandUpdate("Notification", js);
|
this->sendCommandUpdate("Notification", js);
|
||||||
}
|
}
|
||||||
void mqttpublisher::ozwUserAlert(quint8 node, NotificationTypes::QTOZW_Notification_User event, quint8 retry) {
|
void mqttpublisher::ozwUserAlert(quint8 node, NotificationTypes::QTOZW_Notification_User event, quint8 retry) {
|
||||||
qCDebug(ozwmp) << "Publishing Event ozwNotification";
|
qCDebug(ozwmp) << "Publishing Event ozwUserAlert";
|
||||||
rapidjson::Document js;
|
rapidjson::Document js;
|
||||||
QMetaEnum metaEnum = QMetaEnum::fromType<NotificationTypes::QTOZW_Notification_User>();
|
QMetaEnum metaEnum = QMetaEnum::fromType<NotificationTypes::QTOZW_Notification_User>();
|
||||||
QT2JS::SetUint(js, "Node", node);
|
QT2JS::SetUint(js, "Node", node);
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue