zwave: Split more documentation (#1299)

This commit is contained in:
Joakim Sørensen
2020-05-11 19:45:15 +02:00
committed by GitHub
parent 224e3eafa5
commit aba00b2dc7
3 changed files with 49 additions and 46 deletions

View File

@@ -1,20 +0,0 @@
# How to use
## Configuration
Add-on configuration:
```yaml
device: /dev/ttyUSB0
network_key:
```
### Option `device`
### Option `network_key`
## Known issues and limitations
- You hardware need to be compatible with OpenZwave library

49
zwave/DOCS.md Normal file
View File

@@ -0,0 +1,49 @@
# Home Assistant Add-on: OpenZwave
## Installation
Follow these steps to get the add-on installed on your system:
1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**.
2. Find the "OpenZwave" add-on and click it.
3. Click on the "INSTALL" button.
## How to use
## Configuration
Add-on configuration:
```yaml
device: /dev/ttyUSB0
network_key:
```
### Option `device`
### Option `network_key`
## Known issues and limitations
- You hardware need to be compatible with OpenZwave library
## Support
Got questions?
You have several options to get them answered:
- The [Home Assistant Discord Chat Server][discord].
- The Home Assistant [Community Forum][forum].
- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]
In case you've found a bug, please [open an issue on our GitHub][issue].
[discord]: https://discord.gg/c5DvZ4e
[forum]: https://community.home-assistant.io
[issue]: https://github.com/home-assistant/hassio-addons/issues
[reddit]: https://reddit.com/r/homeassistant

View File

@@ -4,35 +4,9 @@ Allow Home Assistant to talk to a Z-Wave Network via a USB Controller.
![Supports aarch64 Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield] ![Supports i386 Architecture][i386-shield]
## About
## Installation
Follow these steps to get the add-on installed on your system:
1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**.
2. Find the "OpenZwave" add-on and click it.
3. Click on the "INSTALL" button.
## Support
Got questions?
You have several options to get them answered:
- The [Home Assistant Discord Chat Server][discord].
- The Home Assistant [Community Forum][forum].
- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]
In case you've found a bug, please [open an issue on our GitHub][issue].
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
[discord]: https://discord.gg/c5DvZ4e
[forum]: https://community.home-assistant.io
[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
[issue]: https://github.com/home-assistant/hassio-addons/issues
[reddit]: https://reddit.com/r/homeassistant