jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-21 08:16:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update z-wave.markdown (#3133)

Browse Source 
Minor changes to fix typos.
This commit is contained in:
Ken Davidson 2017-08-04 11:05:01 -04:00 committed by Fabian Affolter
parent 2838888579
commit 07a95497cf
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
source/_docs/z-wave.markdown
View File

@ -12,7 +12,7 @@ redirect_from: /getting-started/z-wave/
[Z-Wave](http://www.z-wave.com/) integration for Home Assistant allows you to observe and control connected Z-Wave devices. Z-Wave support requires a [supported Z-Wave USB stick or module](https://github.com/OpenZWave/open-zwave/wiki/Controller-Compatibility-List) to be plugged into the host. [Z-Wave](http://www.z-wave.com/) integration for Home Assistant allows you to observe and control connected Z-Wave devices. Z-Wave support requires a [supported Z-Wave USB stick or module](https://github.com/OpenZWave/open-zwave/wiki/Controller-Compatibility-List) to be plugged into the host.
There is currently support for climate, covers, lights, locks, sensors, switches and thermostats. All will be picked up automatically after configuring this platform. There is currently support for climate, covers, lights, locks, sensors, switches, and thermostats. All will be picked up automatically after configuring this platform.
### {% linkable_title Installation %} ### {% linkable_title Installation %}
@ -35,7 +35,7 @@ zwave:
Configuration variables: Configuration variables:
- **usb_path** (*Optional*): The port where your device is connected to your Home Assistant host. - **usb_path** (*Optional*): The port where your device is connected to your Home Assistant host.
- **network_key** (*Optional*): The 16 byte network key in the form `"0x01,0x02..."` used in order to connect securely to compatible devices. - **network_key** (*Optional*): The 16-byte network key in the form `"0x01,0x02..."` used in order to connect securely to compatible devices.
- **config_path** (*Optional*): The path to the Python OpenZWave configuration files. Defaults to the 'config' that is installed by python-openzwave - **config_path** (*Optional*): The path to the Python OpenZWave configuration files. Defaults to the 'config' that is installed by python-openzwave
- **autoheal** (*Optional*): Allows disabling auto Z-Wave heal at midnight. Defaults to True. - **autoheal** (*Optional*): Allows disabling auto Z-Wave heal at midnight. Defaults to True.
- **polling_interval** (*Optional*): The time period in milliseconds between polls of a nodes value. Be careful about using polling values below 30000 (30 seconds) as polling can flood the zwave network and cause problems. - **polling_interval** (*Optional*): The time period in milliseconds between polls of a nodes value. Be careful about using polling values below 30000 (30 seconds) as polling can flood the zwave network and cause problems.
@ -54,7 +54,7 @@ To find the path of your Z-Wave USB stick or module, run:
$ ls /dev/ttyUSB* $ ls /dev/ttyUSB*
``` ```
Or, if there is no result try to find detailed USB connection info with: Or, if there is no result, try to find detailed USB connection info with:
```bash ```bash
$ dmesg | grep USB $ dmesg | grep USB
``` ```
@ -89,7 +89,7 @@ Depending on what's plugged into your USB ports, the name found above may change
To add a Z-Wave device to your system, go to the Z-Wave panel in the Home Assistant frontend and click the Add Node button in the Z-Wave Network Management card. This will place the controller in inclusion mode, after which you should activate your device to be included by following the instructions provided with the device. To add a Z-Wave device to your system, go to the Z-Wave panel in the Home Assistant frontend and click the Add Node button in the Z-Wave Network Management card. This will place the controller in inclusion mode, after which you should activate your device to be included by following the instructions provided with the device.
<p class='note'> <p class='note'>
Some Z-Wave controllers like Aeotec ZW090 Z-Stick Gen5 have ability to add devices to the network using their own contol buttons. This method should be avoided as it is prone to errors. Devices added to the Z-Wave network using this method may not function well. Some Z-Wave controllers, like Aeotec ZW090 Z-Stick Gen5, have ability to add devices to the network using their own contol buttons. This method should be avoided as it is prone to errors. Devices added to the Z-Wave network using this method may not function well.
</p> </p>
### {% linkable_title Adding Security Devices %} ### {% linkable_title Adding Security Devices %}
@ -105,7 +105,7 @@ cat /dev/urandom | tr -dc '0-9A-F' | fold -w 32 | head -n 1 | sed -e 's/\(..\)/0
#### {% linkable_title zwave.network_complete %} #### {% linkable_title zwave.network_complete %}
Home Assistant will trigger a event when the Z-Wave network is complete. Meaning all of the nodes on the network have been queried. This can take quite some time, depending on wakeup intervals on the battery powered devices on the network. Home Assistant will trigger an event when the Z-Wave network is complete, meaning all of the nodes on the network have been queried. This can take quite some time, depending on wakeup intervals on the battery-powered devices on the network.
```yaml ```yaml
- alias: Z-Wave network is complete - alias: Z-Wave network is complete
@ -116,7 +116,7 @@ Home Assistant will trigger a event when the Z-Wave network is complete. Meaning
#### {% linkable_title zwave.network_ready %} #### {% linkable_title zwave.network_ready %}
Home Assistant will trigger a event when the Z-Wave network is ready for use. Between `zwave.network_start` and `zwave.network_ready` Home Assistant will feel sluggish when trying to send commands to Z-Wave nodes. This is because the controller is requesting information from all of the nodes on the network. When this is triggered all awake nodes have been queried and sleeping nodes will be queried when they awake. Home Assistant will trigger an event when the Z-Wave network is ready for use. Between `zwave.network_start` and `zwave.network_ready` Home Assistant will feel sluggish when trying to send commands to Z-Wave nodes. This is because the controller is requesting information from all of the nodes on the network. When this is triggered, all awake nodes have been queried and sleeping nodes will be queried when they awake.
```yaml ```yaml
- alias: Z-Wave network is ready - alias: Z-Wave network is ready
@ -127,7 +127,7 @@ Home Assistant will trigger a event when the Z-Wave network is ready for use. Be
#### {% linkable_title zwave.network_start %} #### {% linkable_title zwave.network_start %}
Home Assistant will trigger a event when the Z-Wave network is set up to be started. Home Assistant will trigger an event when the Z-Wave network is set up to be started.
```yaml ```yaml
- alias: Z-Wave network is starting - alias: Z-Wave network is starting
@ -138,7 +138,7 @@ Home Assistant will trigger a event when the Z-Wave network is set up to be star
#### {% linkable_title zwave.network_stop %} #### {% linkable_title zwave.network_stop %}
Home Assistant will trigger a event when the Z-Wave network stopping. Home Assistant will trigger an event when the Z-Wave network is stopping.
```yaml ```yaml
- alias: Z-Wave network is stopping - alias: Z-Wave network is stopping
@ -148,7 +148,7 @@ Home Assistant will trigger a event when the Z-Wave network stopping.
``` ```
#### {% linkable_title zwave.node_event %} #### {% linkable_title zwave.node_event %}
Home Assistant will trigger a event when command_class_basic changes value on a node. This can be virtually anything, so tests have to be made to determine what value equals what. You can use this for automations. Home Assistant will trigger an event when command_class_basic changes value on a node. This can be virtually anything, so tests have to be made to determine what value equals what. You can use this for automations.
Example: Example:
@ -166,7 +166,7 @@ The *object_id* and *basic_level* of all triggered events can be seen in the con
#### {% linkable_title zwave.scene_activated %} #### {% linkable_title zwave.scene_activated %}
Some devices can also trigger scene activation events, which can be used in automation scripts (for example the press of a button on a wall switch): Some devices can also trigger scene activation events, which can be used in automation scripts (for example, the press of a button on a wall switch):
```yaml ```yaml
# Example configuration.yaml automation entry # Example configuration.yaml automation entry
@ -190,7 +190,7 @@ The `zwave` component exposes multiple services to help maintain the network.
| ------- | ----------- | | ------- | ----------- |
| add_node | Put the Z-Wave controller in inclusion mode. Allows one to add a new device to the Z-Wave network.| | add_node | Put the Z-Wave controller in inclusion mode. Allows one to add a new device to the Z-Wave network.|
| add_node_secure | Put the Z-Wave controller in secure inclusion mode. Allows one to add a new device with secure communications to the Z-Wave network. | | add_node_secure | Put the Z-Wave controller in secure inclusion mode. Allows one to add a new device with secure communications to the Z-Wave network. |
| cancel_command | Cancels a running Z-Wave command. If you have started a add_node or remove_node command, and decides you are not going to do it, then this must be used to stop the inclusion/exclusion command. | | cancel_command | Cancels a running Z-Wave command. If you have started a add_node or remove_node command, and decide you are not going to do it, then this must be used to stop the inclusion/exclusion command. |
| change_association | Add or remove an association in the Z-Wave network | | change_association | Add or remove an association in the Z-Wave network |
| heal_network | Tells the controller to "heal" the Z-Wave network. Basically asks the nodes to tell the controller all of their neighbors so the controller can refigure out optimal routing. | | heal_network | Tells the controller to "heal" the Z-Wave network. Basically asks the nodes to tell the controller all of their neighbors so the controller can refigure out optimal routing. |
| print_config_parameter | Prints Z-Wave node's config parameter value to the log. | | print_config_parameter | Prints Z-Wave node's config parameter value to the log. |
@ -200,16 +200,16 @@ The `zwave` component exposes multiple services to help maintain the network.
| remove_node | Put the Z-Wave controller in exclusion mode. Allows one to remove a device from the Z-Wave network.| | remove_node | Put the Z-Wave controller in exclusion mode. Allows one to remove a device from the Z-Wave network.|
| rename_node | Sets a node's name. Requires a `node_id` and `name` field. | | rename_node | Sets a node's name. Requires a `node_id` and `name` field. |
| rename_value | Sets a value's name. Requires a `node_id`, `value_id`, and `name` field. | | rename_value | Sets a value's name. Requires a `node_id`, `value_id`, and `name` field. |
| remove_failed_node | Remove a failed node from the network. The Node should be on the Controllers Failed Node List, otherwise this command will fail.| | remove_failed_node | Remove a failed node from the network. The Node should be on the controller's Failed Node List, otherwise this command will fail.|
| replace_failed_node | Replace a failed device with another. If the node is not in the controller's failed nodes list, or the node responds, this command will fail.| | replace_failed_node | Replace a failed device with another. If the node is not in the controller's Failed Node List, or the node responds, this command will fail.|
| reset_node_meters | Reset a node's meter values. Only works if the node supports this. | | reset_node_meters | Reset a node's meter values. Only works if the node supports this. |
| set_config_parameter | Let's the user set a config parameter to a node. NOTE: Use string for list values. For all others use integer. | | set_config_parameter | Lets the user set a config parameter to a node. NOTE: Use string for list values. For all others use integer. |
| soft_reset | Tells the controller to do a "soft reset". This is not supposed to lose any data, but different controllers can behave differently to a "soft reset" command.| | soft_reset | Tells the controller to do a "soft reset." This is not supposed to lose any data, but different controllers can behave differently to a "soft reset" command.|
| start_network | Starts the Z-Wave network.| | start_network | Starts the Z-Wave network.|
| stop_network | Stops the Z-Wave network.| | stop_network | Stops the Z-Wave network.|
| test_network | Tells the controller to send no-op commands to each node and measure the time for a response. In theory, this can also bring back nodes which have been marked "presumed dead".| | test_network | Tells the controller to send no-op commands to each node and measure the time for a response. In theory, this can also bring back nodes which have been marked "presumed dead."|
The `soft_reset` and `heal_network` commands can be used as part of an automation script to help keep a Z-Wave network running reliably as shown in the example below. By default, Home Assistant will run a `heal_network` at midnight. This is a configuration option for the `zwave` component, the option defaults to `true` but can be disabled by setting `autoheal` to false. Using the `soft_reset` function with some Z-Wave controllers can cause the Z-Wave network to hang. If you're having issues with your Z-Wave network try disabling this automation. The `soft_reset` and `heal_network` commands can be used as part of an automation script to help keep a Z-Wave network running reliably as shown in the example below. By default, Home Assistant will run a `heal_network` at midnight. This is a configuration option for the `zwave` component. The option defaults to `true` but can be disabled by setting `autoheal` to false. Using the `soft_reset` function with some Z-Wave controllers can cause the Z-Wave network to hang. If you're having issues with your Z-Wave network, try disabling this automation.
```yaml ```yaml
# Example configuration.yaml automation entry # Example configuration.yaml automation entry