Skip to content

Commit 04c2a96

Browse files
authored
Update z-wave.markdown
fixed usage of `zwave` component, Z-Wave for references to a Z-Wave network, and OpenZWave as a project name
1 parent 150566a commit 04c2a96

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

source/getting-started/z-wave.markdown

Lines changed: 16 additions & 16 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:
@@ -109,40 +109,40 @@ You can replace these values with your own 16 byte network key. For more informa
109109
### {% linkable_title Events %}
110110

111111
#### {% linkable_title zwave.network_complete %}
112-
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.
112+
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.
113113

114114
```yaml
115-
- alias: ZWave network is complete
115+
- alias: Z-Wave network is complete
116116
trigger:
117117
platform: event
118118
event_type: zwave.network_complete
119119
```
120120
121121
#### {% linkable_title zwave.network_ready %}
122-
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.
122+
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.
123123

124124
```yaml
125-
- alias: ZWave network is ready
125+
- alias: Z-Wave network is ready
126126
trigger:
127127
platform: event
128128
event_type: zwave.network_ready
129129
```
130130

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

134134
```yaml
135-
- alias: ZWave network is starting
135+
- alias: Z-Wave network is starting
136136
trigger:
137137
platform: event
138138
event_type: zwave.network_start
139139
```
140140

141141
#### {% linkable_title zwave.network_stop %}
142-
HomeAssistant will trigger a event when the zwave network stopping.
142+
HomeAssistant will trigger a event when the Z-Wave network stopping.
143143

144144
```yaml
145-
- alias: ZWave network is stopping
145+
- alias: Z-Wave network is stopping
146146
trigger:
147147
platform: event
148148
event_type: zwave.network_stop
@@ -186,20 +186,20 @@ The *object_id* and *scene_id* of all triggered events can be seen in the consol
186186

187187
### {% linkable_title Services %}
188188

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

191191
| Service | Description |
192192
| ------- | ----------- |
193-
| add_node | Put the zwave controller in inclusion mode. Allows one to add a new device to the zwave network.|
194-
| 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. |
195-
| 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. |
196-
| 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. |
197-
| remove_node | Put the zwave controller in exclusion mode. Allows one to remove a device from the zwave network.|
193+
| add_node | Put the Z-Wave controller in inclusion mode. Allows one to add a new device to the Z-Wave network.|
194+
| 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. |
195+
| 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. |
196+
| 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. |
197+
| remove_node | Put the Z-Wave controller in exclusion mode. Allows one to remove a device from the zwave network.|
198198
| 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.|
199199
| 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".|
200200
| rename_node | Sets a node's name. Requires an `entity_id` and `name` field. |
201201

202-
The `soft_reset` and `heal_network` commands can be used as part of an automation script to help keep a zwave 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.
202+
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.
203203

204204
```yaml
205205
# Example configuration.yaml automation entry

0 commit comments

Comments
 (0)