Skip to content

Commit 3da35e3

Browse files
sgaucheLandrash
sgauche
authored and
Landrash
committed
Update z-wave.markdown (home-assistant#917)
- Notes added to Z-wave `soft-reset` about known issues by @sgauche - Fixed usage of `zwave` component, Z-Wave for references to a Z-Wave network, and OpenZWave as a project name by @sgauche
1 parent 9e0512d commit 3da35e3

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

‎source/getting-started/z-wave.markdown

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ zwave:
6868
Configuration variables:
6969
7070
- **usb_path** (*Required*): The port where your device is connected to your Home Assistant host.
71-
- **config_path** (*Optional*): The path to the Python Open Z-Wave configuration files.
71+
- **config_path** (*Optional*): The path to the Python OpenZWave configuration files.
7272
- **autoheal** (*Optional*): Allows disabling auto ZWave heal at midnight. Defaults to True.
7373
- **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.
7474
- **customize** (*Optional*): This attribute contains node-specific override values:
@@ -115,40 +115,40 @@ You can replace these values with your own 16 byte network key. For more informa
115115
### {% linkable_title Events %}
116116

117117
#### {% linkable_title zwave.network_complete %}
118-
HomeAssistant will trigger a event when the zwave network is complete. Meaning all of the nodes on the network have been queried. This can take quite som time, depending on wakeup intervals on the battery powered devices on the network.
118+
HomeAssistant 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 som time, depending on wakeup intervals on the battery powered devices on the network.
119119

120120
```yaml
121-
- alias: ZWave network is complete
121+
- alias: Z-Wave network is complete
122122
trigger:
123123
platform: event
124124
event_type: zwave.network_complete
125125
```
126126
127127
#### {% linkable_title zwave.network_ready %}
128-
HomeAssistant will trigger a event when the zwave network is ready for use. Between `zwave.network_start` and `zwave.network_ready` HomeAssistant will feel sluggish when trying to send commands to zwave 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.
128+
HomeAssistant will trigger a event when the Z-Wave network is ready for use. Between `zwave.network_start` and `zwave.network_ready` HomeAssistant 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.
129129

130130
```yaml
131-
- alias: ZWave network is ready
131+
- alias: Z-Wave network is ready
132132
trigger:
133133
platform: event
134134
event_type: zwave.network_ready
135135
```
136136

137137
#### {% linkable_title zwave.network_start %}
138-
HomeAssistant will trigger a event when the zwave network is set up to be started.
138+
HomeAssistant will trigger a event when the Z-Wave network is set up to be started.
139139

140140
```yaml
141-
- alias: ZWave network is starting
141+
- alias: Z-Wave network is starting
142142
trigger:
143143
platform: event
144144
event_type: zwave.network_start
145145
```
146146

147147
#### {% linkable_title zwave.network_stop %}
148-
HomeAssistant will trigger a event when the zwave network stopping.
148+
HomeAssistant will trigger a event when the Z-Wave network stopping.
149149

150150
```yaml
151-
- alias: ZWave network is stopping
151+
- alias: Z-Wave network is stopping
152152
trigger:
153153
platform: event
154154
event_type: zwave.network_stop
@@ -192,21 +192,20 @@ The *object_id* and *scene_id* of all triggered events can be seen in the consol
192192

193193
### {% linkable_title Services %}
194194

195-
The Z-Wave component exposes seven services to help maintain the network.
195+
The `zwave` component exposes seven services to help maintain the network.
196196

197197
| Service | Description |
198198
| ------- | ----------- |
199-
| add_node | Put the zwave controller in inclusion mode. Allows one to add a new device to the zwave network.|
200-
| add_node_secure | Put the zwave controller in secure inclusion mode. Allows one to add a new device with secure communications to the zwave network. |
201-
| cancel_command | Cancels a running zwave 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. |
202-
| heal_network | Tells the controller to "heal" the network. Bascially asks the nodes to tell the controller all of their neighbors so the controller can refigure out optimal routing. |
203-
| remove_node | Put the zwave controller in exclusion mode. Allows one to remove a device from the zwave network.|
199+
| add_node | Put the Z-Wave controller in inclusion mode. Allows one to add a new device to the Z-Wave network.|
200+
| 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. |
201+
| 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. |
202+
| heal_network | Tells the controller to "heal" the Z-Wave network. Bascially asks the nodes to tell the controller all of their neighbors so the controller can refigure out optimal routing. |
203+
| remove_node | Put the Z-Wave controller in exclusion mode. Allows one to remove a device from the zwave network.|
204204
| 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.|
205205
| 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".|
206206
| rename_node | Sets a node's name. Requires an `entity_id` and `name` field. |
207207

208-
The soft_reset and heal_network commands can be used as part of an automation script
209-
to help keep a zwave network running relliably. For example:
208+
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 `auto_heal` 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.
210209

211210
```yaml
212211
# Example configuration.yaml automation entry

0 commit comments

Comments
 (0)