From 32a84f146696e9e24fe5cb16c617c7846667e92c Mon Sep 17 00:00:00 2001 From: Andrey Date: Sat, 17 Jun 2017 20:02:37 +0300 Subject: [PATCH] Add to zwave services descriptions (#8072) --- homeassistant/components/zwave/services.yaml | 21 ++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/homeassistant/components/zwave/services.yaml b/homeassistant/components/zwave/services.yaml index 4a7379fbf56..3ca72c7fdda 100644 --- a/homeassistant/components/zwave/services.yaml +++ b/homeassistant/components/zwave/services.yaml @@ -3,41 +3,46 @@ change_association: fields: association: description: Specify add or remove assosication + example: add node_id: description: Node id of the node to set association for. + example: 10 target_node_id: description: Node id of the node to associate to. + example: 42 group: description: Group number to set association for. instance: - description: (Optional) Instance of association. Defaults to 0. + description: (Optional) Instance of multichannel association. Defaults to 0. add_node: - description: Add a new node to the Z-Wave network. Refer to OZW.log for details. + description: Add a new (unsecure) node to the Z-Wave network. Refer to OZW.log for progress. add_node_secure: - description: Add a new node to the Z-Wave network with secure communications. Node must support this, and network key must be set. Refer to OZW.log for details. + description: Add a new node to the Z-Wave network with secure communications. Node must support this, and network key must be set. Note that unsecure devices can't directly talk to secure devices. Refer to OZW.log for progress. cancel_command: description: Cancel a running Z-Wave controller command. Use this to exit add_node, if you wasn't going to use it but activated it. heal_network: - description: Start a Z-Wave network heal. This might take a while and will slow down the Z-Wave network greatly while it is being processed. Refer to OZW.log for details. + description: Start a Z-Wave network heal. This might take a while and will slow down the Z-Wave network greatly while it is being processed. Refer to OZW.log for progress. remove_node: - description: Remove a node from the Z-Wave network. Refer to OZW.log for details. + description: Remove a node from the Z-Wave network. Refer to OZW.log for progress. remove_failed_node: - descsription: This command will remove a failed node from the network. The node should be on the controllers failed nodes list, otherwise this command will fail. Refer to OZW.log for details. + descsription: This command will remove a failed node from the network. The node should be on the controllers failed nodes list, otherwise this command will fail. Refer to OZW.log for progress. fields: node_id: description: Node id of the device to remove (integer). + example: 10 replace_failed_node: - descsription: Replace a failed node with another. If the node is not in the controller's failed nodes list, or the node responds, this command will fail. Refer to OZW.log for details. + descsription: Replace a failed node with another. If the node is not in the controller's failed nodes list, or the node responds, this command will fail. Refer to OZW.log for progress. fields: node_id: description: Node id of the device to replace (integer). + example: 10 set_config_parameter: description: Set a config parameter to a node on the Z-Wave network. @@ -97,7 +102,7 @@ soft_reset: description: This will reset the controller without removing its data. Use carefully because not all controllers support this. Refer to controllers manual. test_network: - description: This will send test to nodes in the Z-Wave network. This will greatly slow down the Z-Wave network while it is being processed. Refer to OZW.log for details. + description: This will send test to nodes in the Z-Wave network. This will greatly slow down the Z-Wave network while it is being processed. Refer to OZW.log for progress. rename_node: description: Set the name(s) of a node.