Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
- linkify part of the instructions
- add explicit callout of how to change versions of OZW/OZWCP
  • Loading branch information
jkeljo authored Apr 7, 2018
1 parent 575f007 commit 8cba991
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion ozwcp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ For most purposes, the ZWave configuration UI embedded in Home Assistant is just

**IMPORTANT**: OZWCP and Home Assistant cannot both be accessing the ZWave controller and Open ZWave cache at the same time. The add-on will stop Home Assistant before starting OZWCP, but it's up to you to close OZWCP's connection to the ZWave controller before starting Home Assistant again.

1. Add `https://github.com/jkeljo/hassio-addons` to your Hass.io instance as a repository
1. [Add `https://github.com/jkeljo/hassio-addons` to your Hass.io instance as a repository](https://www.home-assistant.io/hassio/installing_third_party_addons/)
2. Install the OZWCP addon. This is a local-build addon, so installation can take **a long time** (10 minutes or more). Be patient! :-)

## Use
Expand All @@ -17,3 +17,7 @@ For most purposes, the ZWave configuration UI embedded in Home Assistant is just
4. Start Home Assistant again by [`ssh`ing into the host](https://community.home-assistant.io/t/community-hass-io-add-on-ssh/33820?u=frenck) and running `hassio homeassistant start`
5. Manually stop the OZWCP addon so you won't accidentally try to use it while Home Assistant is running

## Changing the version of OpenZWave and/or OZWCP
`build.json` specifies which repository and which commit to use for OpenZWave and OZWCP, so it's easy to update for a newer version or even to use a fork. I'll happily accept PRs to pick up new versions.

If you've got customizations to OpenZWave and wish to use your fork, you can do that too! Just fork this repo and set your Home Assistant to install from there. Then you can change `build.json` to use your OpenZWave and/or OZWCP fork.

0 comments on commit 8cba991

Please sign in to comment.