Minimizing of the configuration sample (Z-Wave) (#1095)

* Minimizing of the configuration sample

* Update details
This commit is contained in:
Fabian Affolter 2016-10-04 17:16:15 +02:00 committed by Fredrik Lindqvist
parent acbcf6f426
commit ac6d12296a

View File

@ -30,7 +30,9 @@ $ sudo pip3 install --upgrade cython
```
Then get the OpenZWave files and switch to the `python3` branch:
<p class='note warning'>Do not use root to build python-openzwave as it will surely fail.</p>
```bash
$ git clone https://github.com/OpenZWave/python-openzwave.git
$ cd python-openzwave
@ -38,6 +40,7 @@ $ git checkout python3
$ PYTHON_EXEC=$(which python3) make build
$ sudo PYTHON_EXEC=$(which python3) make install
```
<p class='note'>
Instead of `make install`, you can alternatively build your own python-openzwave package which can be easily uninstalled:
@ -58,17 +61,12 @@ With this installation, your `config_path` needed below will resemble:
# Example configuration.yaml entry
zwave:
usb_path: /dev/ttyUSB0
config_path: /usr/local/share/python-openzwave/config
polling_interval: 60000
customize:
sensor.greenwave_powernode_6_port_energy_10:
polling_intensity: 1
```
Configuration variables:
- **usb_path** (*Required*): The port where your device is connected to your Home Assistant host.
- **config_path** (*Optional*): The path to the Python OpenZWave configuration files.
- **usb_path** (*Optional*): The port where your device is connected to your Home Assistant host.
- **config_path** (*Optional*): The path to the Python OpenZWave configuration files. Defaults to the folder `config` in your Python OpenZWave install directory.
- **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.
- **customize** (*Optional*): This attribute contains node-specific override values:
@ -121,6 +119,7 @@ You can replace these values with your own 16 byte network key. For more informa
### {% linkable_title Events %}
#### {% 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 som time, depending on wakeup intervals on the battery powered devices on the network.
```yaml
@ -131,6 +130,7 @@ Home Assistant will trigger a event when the Z-Wave network is complete. Meaning
```
#### {% 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.
```yaml
@ -141,6 +141,7 @@ Home Assistant will trigger a event when the Z-Wave network is ready for use. Be
```
#### {% linkable_title zwave.network_start %}
Home Assistant will trigger a event when the Z-Wave network is set up to be started.
```yaml
@ -151,6 +152,7 @@ Home Assistant will trigger a event when the Z-Wave network is set up to be star
```
#### {% linkable_title zwave.network_stop %}
Home Assistant will trigger a event when the Z-Wave network stopping.
```yaml
@ -180,6 +182,7 @@ Example:
The *object_id* and *basic_level* of all triggered events can be seen in the console output.
#### {% 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):
```yaml