diff --git a/README.md b/README.md index 7d54c453..77ed90cc 100644 --- a/README.md +++ b/README.md @@ -1166,10 +1166,10 @@ SOFTWARE. [wireguard-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [wireguard-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [wireguard-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-zwave2mqtt]: https://github.com/hassio-addons/addon-zwave2mqtt/tree/v0.6.0 -[addon-doc-zwave2mqtt]: https://github.com/hassio-addons/addon-zwave2mqtt/blob/v0.6.0/README.md +[addon-zwave2mqtt]: https://github.com/hassio-addons/addon-zwave2mqtt/tree/v0.7.0 +[addon-doc-zwave2mqtt]: https://github.com/hassio-addons/addon-zwave2mqtt/blob/v0.7.0/README.md [zwave2mqtt-issue]: https://github.com/hassio-addons/addon-zwave2mqtt/issues -[zwave2mqtt-version-shield]: https://img.shields.io/badge/version-v0.6.0-blue.svg +[zwave2mqtt-version-shield]: https://img.shields.io/badge/version-v0.7.0-blue.svg [zwave2mqtt-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/zwave2mqtt-armhf.svg [zwave2mqtt-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [zwave2mqtt-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/zwave2mqtt/CHANGELOG.md b/zwave2mqtt/CHANGELOG.md index fe64cb87..fd0d3682 100644 --- a/zwave2mqtt/CHANGELOG.md +++ b/zwave2mqtt/CHANGELOG.md @@ -1,24 +1,16 @@ [Full Changelog][changelog] -Due to an issue with the upstream ZWave2Mqtt project, it might that the ZWave configurations database isn't loaded. - -If that happens, make sure you set the device database config path in: -**Settings** -> **Zwave** -> **Config Path**: `/etc/openzwave`. - ### 🔨 Changes -- :hammer: Update community forum links -- :arrow_up: Upgrades base image to v7.1.0 -- :arrow_up: Upgrades Zwave2Mqtt to v3.0.2 (#39) -- :ambulance: Use correct webUI protocol depending on config (#43) -- :ambulance: Symlink addition database location -- :hammer: Disable Docker init -- :arrow_up: Upgrades open-zwave database to e3bae88 -- :ambulance: Correct database paths -- :ambulance: Change database path again, update documentation with known issue -- :arrow_up: Upgrades git to 2.24.2-r0 +- ⬆ Upgrades git to 2.24.3-r0 +- ⬆ Upgrades openssl to 1.1.1g-r0 +- ⬆ Upgrades add-on base image to v7.2.0 +- 🔨 Implement OCI image specification on labels +- ✏ Split add-on documentation +- ⬆ Upgrades open-zwave database to 2a76bdcd04513aa02618cc34432f8d5242fc73d1 +- ⬆ Upgrades Zwave2Mqtt to v3.2.2 -[changelog]: https://github.com/hassio-addons/addon-zwave2mqtt/compare/v0.5.0...v0.6.0 +[changelog]: https://github.com/hassio-addons/addon-zwave2mqtt/compare/v0.6.0...v0.7.0 Questions? Join our Discord server! https://discord.me/hassioaddons Enjoying my add-ons? Consider supporting my work: https://patreon.com/frenck \ No newline at end of file diff --git a/zwave2mqtt/DOCS.md b/zwave2mqtt/DOCS.md new file mode 100644 index 00000000..37858f62 --- /dev/null +++ b/zwave2mqtt/DOCS.md @@ -0,0 +1,190 @@ +# Home Assistant Community Add-on: Z-Wave to MQTT + +The Z-Wave to MQTT add-on allows you to decouple your Z-Wave network from +your Home Assistant instance by leveraging your MQTT broker. It ships with +a web-based control panel, allowing you to configure every aspect of your +Z-Wave network and how they are published in MQTT. + +Some advantages and use-cases for this are: + +- Your Z-Wave network will keep running between Home Assistant restarts. +- You can directly use things like Node-RED with your Z-Wave network, while + it is available for Home Assistant at the same time. +- Allow [ESPHome.io][esphome] based ESP devices to directly respond or work + with your Z-Wave network. + +This add-on uses the [Zwave2Mqtt][zwave2mqtt] software provided by OpenZWave. + +## Installation + +The installation of this add-on is pretty straightforward and not different in +comparison to installing any other Home Assistant add-on. + +1. Search for the "Z-Wave to MQTT" add-on in the Supervisor add-on store + and install it. +1. Start the "Z-Wave to MQTT" add-on. +1. Check the logs of the "Z-Wave to MQTT" add-on to see if everything went well. +1. Click the "OPEN WEB UI" button. +1. Enjoy the add-on! + +**NOTE**: The upstream project has documentation on using the software itself: + + +## Configuration + +**Note**: _Remember to restart the add-on when the configuration is changed._ + +Example add-on configuration: + +```yaml +log_level: info +ssl: true +certfile: fullchain.pem +keyfile: privkey.pem +``` + +**Note**: _This is just an example, don't copy and paste it! Create your own!_ + +### Option: `log_level` + +The `log_level` option controls the level of log output by the addon and can +be changed to be more or less verbose, which might be useful when you are +dealing with an unknown issue. Possible values are: + +- `trace`: Show every detail, like all called internal functions. +- `debug`: Shows detailed debug information. +- `info`: Normal (usually) interesting events. +- `warning`: Exceptional occurrences that are not errors. +- `error`: Runtime errors that do not require immediate action. +- `fatal`: Something went terribly wrong. Add-on becomes unusable. + +Please note that each level automatically includes log messages from a +more severe level, e.g., `debug` also shows `info` messages. By default, +the `log_level` is set to `info`, which is the recommended setting unless +you are troubleshooting. + +### Option: `ssl` + +Enables/Disables SSL on the control panel. Set it `true` to enable it, +`false` otherwise. + +### Option: `certfile` + +The certificate file to use for SSL. + +**Note**: _The file MUST be stored in `/ssl/`, which is the default_ + +### Option: `keyfile` + +The private key file to use for SSL. + +**Note**: _The file MUST be stored in `/ssl/`, which is the default_ + +### Option: `leave_front_door_open` + +Adding this option to the add-on configuration allows you to disable +authentication on the add-on by setting it to `true` and leaving the +username and password empty. + +**Note**: _We STRONGLY suggest, not to use this, even if this add-on is +only exposed to your internal network. USE AT YOUR OWN RISK!_ + +## Embedding into Home Assistant + +It is possible to embed the Z-Wave to MQTT control panel web interface directly +into Home Assistant, allowing you to access it through the Home Assistant +frontend. + +Home Assistant provides the `panel_iframe` integration, for these purposes. + +Example configuration: + +```yaml +panel_iframe: + zwave2mqtt: + title: Z-Wave to MQTT + icon: mdi:z-wave + url: http://addres.to.your.hass.io:8091 +``` + +## Known issues and limitations + +- This add-on is currently unable to support Hass.io Ingress. This is due to + technical limitations of the zwave2mqtt control panel web interface. +- If the OpenZwave device database doesn't seem to be loaded. Device names + and options are missing: Go to Settings -> Zwave -> Config Path and set it + to `/etc/openzwave`. + +## Changelog & Releases + +This repository keeps a change log using [GitHub's releases][releases] +functionality. The format of the log is based on +[Keep a Changelog][keepchangelog]. + +Releases are based on [Semantic Versioning][semver], and use the format +of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented +based on the following: + +- ``MAJOR``: Incompatible or major changes. +- ``MINOR``: Backwards-compatible new features and enhancements. +- ``PATCH``: Backwards-compatible bugfixes and package updates. + +## Support + +Got questions? + +You have several options to get them answered: + +- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on + support and feature requests. +- The [Home Assistant Discord chat server][discord-ha] for general Home + Assistant discussions and questions. +- The Home Assistant [Community Forum][forum]. +- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] + +You could also [open an issue here][issue] GitHub. + +## Authors & contributors + +The original setup of this repository is by [Franck Nijhof][frenck]. + +For a full list of all authors and contributors, +check [the contributor's page][contributors]. + +## License + +MIT License + +Copyright (c) 2019-2020 Franck Nijhof + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. + +[contributors]: https://github.com/hassio-addons/addon-zwave2mqtt/graphs/contributors +[discord-ha]: https://discord.gg/c5DvZ4e +[discord]: https://discord.me/hassioaddons +[esphome]: https://esphome.io/components/mqtt.html#on-message-trigger +[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg +[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-z-wave-to-mqtt/115899?u=frenck +[frenck]: https://github.com/frenck +[issue]: https://github.com/hassio-addons/addon-zwave2mqtt/issues +[keepchangelog]: http://keepachangelog.com/en/1.0.0/ +[reddit]: https://reddit.com/r/homeassistant +[releases]: https://github.com/hassio-addons/addon-zwave2mqtt/releases +[semver]: http://semver.org/spec/v2.0.0.htm +[zwave2mqtt]: https://github.com/OpenZWave/Zwave2Mqtt diff --git a/zwave2mqtt/README.md b/zwave2mqtt/README.md index 79df4b38..3f2433b7 100644 --- a/zwave2mqtt/README.md +++ b/zwave2mqtt/README.md @@ -27,8 +27,6 @@ Some advantages and use-cases for this are: - Allow [ESPHome.io][esphome] based ESP devices to directly respond or work with your Z-Wave network. -[Click here for the full documentation][docs] - ## WARNING! THIS IS A BETA VERSION! This Home Assistant Add-ons repository contains beta releases of add-ons. @@ -47,7 +45,6 @@ If you are more interested in stable releases of our add-ons: [discord-shield]: https://img.shields.io/discord/478094546522079232.svg [discord]: https://discord.me/hassioaddons -[docs]: https://github.com/hassio-addons/addon-zwave2mqtt/blob/v0.6.0/README.md [esphome]: https://esphome.io/components/mqtt.html#on-message-trigger [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-z-wave-to-mqtt/115899?u=frenck @@ -58,5 +55,5 @@ If you are more interested in stable releases of our add-ons: [patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png [patreon]: https://www.patreon.com/frenck [project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg -[release-shield]: https://img.shields.io/badge/version-v0.6.0-blue.svg -[release]: https://github.com/hassio-addons/addon-zwave2mqtt/tree/v0.6.0 \ No newline at end of file +[release-shield]: https://img.shields.io/badge/version-v0.7.0-blue.svg +[release]: https://github.com/hassio-addons/addon-zwave2mqtt/tree/v0.7.0 \ No newline at end of file diff --git a/zwave2mqtt/config.json b/zwave2mqtt/config.json index 906ba295..51118019 100644 --- a/zwave2mqtt/config.json +++ b/zwave2mqtt/config.json @@ -1,6 +1,6 @@ { "name": "Z-Wave to MQTT", - "version": "0.6.0", + "version": "0.7.0", "slug": "zwave2mqtt", "description": "Fully configurable Z-Wave to MQTT gateway and control panel", "url": "https://github.com/hassio-addons/addon-zwave2mqtt",