diff --git a/zwavejs2mqtt/CHANGELOG.md b/zwavejs2mqtt/CHANGELOG.md deleted file mode 100644 index 9bb9777f..00000000 --- a/zwavejs2mqtt/CHANGELOG.md +++ /dev/null @@ -1,6 +0,0 @@ -## What’s changed - -## ⬆️ Dependency updates - -- ⬆️ Upgrades add-on base image to 12.2.4 @frenck (#412) -- ⬆️ Upgrades zwavejs2mqtt to v7.2.0 @frenck (#413) diff --git a/zwavejs2mqtt/DOCS.md b/zwavejs2mqtt/DOCS.md deleted file mode 100644 index 6bcafdca..00000000 --- a/zwavejs2mqtt/DOCS.md +++ /dev/null @@ -1,189 +0,0 @@ -# Home Assistant Community Add-on: Z-Wave JS to MQTT - -The Z-Wave JS 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. - -**Note**: Unlike the title of the software suggests, you don't need to -use MQTT part (it is even disabled by default). It will work directly -without MQTT using the Home Assistant integration. The add-on will provide -a nice secondairy and extensive Z-Wave JS control interface in such cases. - -Some advantages and use-cases: - -- Compatible with the Home Assistant Z-Wave JS integration. -- 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. -- Pre-configures itself with the Mosquitto add-on when found. - -This add-on uses the [Zwavejs2Mqtt][zwavejs2mqtt] software. - -## Installation - -The installation of this add-on is pretty straightforward and not different in -comparison to installing any other Home Assistant add-on. - -1. Click the Home Assistant My button below to open the add-on on your Home - Assistant instance. - - [![Open this add-on in your Home Assistant instance.][addon-badge]][addon] - -1. Click the "Install" button to install the add-on. -1. Check the logs of the "Z-Wave JS 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: - - -## Setting up the Home Assistant Z-Wave JS integration - -By default the Home Assistant Z-Wave JS integration will try to set up the -official "Z-Wave JS" add-on from the official add-on store. - -**It is recommended to use the official add-on instead of this one!** - -However, this add-on will provide an add-on UI and has the ability to -send/receive data over MQTT as well. So, if that is your thing, this -add-on might be for you. - -After starting the add-on successfully, it is time to hook it up with -Home Assistant. - -To do this: - -1. Open the Z-Wave JS to MQTT control panel by clikcing the "OPEN WEB UI" - button on the add-on page in the Supervisor. -1. In the control panel, go to "Settings" in the menu and click on the "Zwave" - bar that shows up on the right. -1. Enter the following information: - - Serial Port (e.g., `/dev/serial/by-id/usb-0658_0200_if00`) - - Network Key (e.g., `2232666D100F795E5BB17F0A1BB7A146`) - -Now click the "SAVE" button and navigate to the "Control Panel" in the menu. -If you had devices paired already, you should see the showing up slowly. - -Now it is time to set up Home Assistant: - -1. Go to the Configuration panel and click "Integrations". -1. In the bottom left, click "+ Add Integration". -1. Select the "Z-Wave JS" integration from the list. -1. A dialog box will show, asking to use the add-on: - - **UNCHECK** that box, it will install the officia add-on. - - Again, the official add-on is recommended, so... -1. In the next dialog it will ask for the server. Enter: - `ws://a0d7b954-zwavejs2mqtt:3000` -1. Confirm and done! - -## Configuration - -**Note**: _Remember to restart the add-on when the configuration is changed._ - -Example add-on configuration: - -```yaml -log_level: info -``` - -### 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. - -## Known issues and limitations - -- Z-Wave JS to MQTT supports Home Assistant Discovery over MQTT. It is - **STRONGLY** recommended **NOT** to use that option. Use the Z-Wave JS - integration as documented above instead. - -## Changelog & Releases - -This repository keeps a change log using [GitHub's releases][releases] -functionality. - -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) 2021 - 2022 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. - -[addon-badge]: https://my.home-assistant.io/badges/supervisor_addon.svg -[addon]: https://my.home-assistant.io/redirect/supervisor_addon/?addon=a0d7b954_zwavejs2mqtt&repository_url=https%3A%2F%2Fgithub.com%2Fhassio-addons%2Frepository -[contributors]: https://github.com/hassio-addons/addon-zwavejs2mqtt/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/?u=frenck -[frenck]: https://github.com/frenck -[issue]: https://github.com/hassio-addons/addon-zwavejs2mqtt/issues -[reddit]: https://reddit.com/r/homeassistant -[releases]: https://github.com/hassio-addons/addon-zwavejs2mqtt/releases -[semver]: http://semver.org/spec/v2.0.0.htm -[zwavejs2mqtt]: https://github.com/zwave-js/zwavejs2mqtt diff --git a/zwavejs2mqtt/README.md b/zwavejs2mqtt/README.md deleted file mode 100644 index 578b92ff..00000000 --- a/zwavejs2mqtt/README.md +++ /dev/null @@ -1,52 +0,0 @@ -# Home Assistant Community Add-on: Z-Wave JS to MQTT - -[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield] - -[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum] - -[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors] - -[![Support Frenck on Patreon][patreon-shield]][patreon] - -Fully configurable Z-Wave JS to MQTT gateway and control panel. - -![Z-Wave JS to MQTT][logo] - -## About - -The Z-Wave JS 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. - -**Note**: Unlike the title of the software suggests, you don't need to -use MQTT part (it is even disabled by default). It will work directly -without MQTT using the Home Assistant integration. The add-on will provide -a nice secondairy and extensive Z-Wave JS control interface in such cases. - -Some advantages and use-cases: - -- Compatible with the Home Assistant Z-Wave JS integration. -- 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. -- Pre-configures itself with the Mosquitto add-on when found. - -This add-on uses the [Zwavejs2Mqtt][zwavejs2mqtt] software. - -[discord-shield]: https://img.shields.io/discord/478094546522079232.svg -[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/?u=frenck -[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png -[github-sponsors]: https://github.com/sponsors/frenck -[logo]: https://github.com/hassio-addons/addon-zwavejs2mqtt/raw/main/zwavejs2mqtt/logo.png -[maintenance-shield]: https://img.shields.io/maintenance/yes/2022.svg -[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.47.0-blue.svg -[release]: https://github.com/hassio-addons/addon-zwavejs2mqtt/tree/v0.47.0 \ No newline at end of file diff --git a/zwavejs2mqtt/config.yaml b/zwavejs2mqtt/config.yaml deleted file mode 100644 index e3709c9d..00000000 --- a/zwavejs2mqtt/config.yaml +++ /dev/null @@ -1,35 +0,0 @@ -arch: -- aarch64 -- amd64 -- armhf -- armv7 -- i386 -codenotary: codenotary@frenck.dev -description: Fully configurable Z-Wave JS to MQTT gateway and control panel; based - on Zwavejs2Mqtt -discovery: -- zwave_js -image: ghcr.io/hassio-addons/zwavejs2mqtt/{arch} -ingress: true -ingress_stream: true -init: false -map: -- share:rw -name: Z-Wave JS to MQTT -panel_icon: mdi:z-wave -panel_title: Z-Wave JS -ports: - 3000/tcp: null -ports_description: - 3000/tcp: Z-Wave JS communication -schema: - log_level: list(trace|debug|info|notice|warning|error|fatal)? -services: -- mqtt:want -slug: zwavejs2mqtt -startup: system -uart: true -udev: true -url: https://github.com/hassio-addons/addon-zwavejs2mqtt -version: 0.47.0 -watchdog: http://[HOST]:[PORT:8099]/health/zwave diff --git a/zwavejs2mqtt/icon.png b/zwavejs2mqtt/icon.png deleted file mode 100644 index 360d704d..00000000 Binary files a/zwavejs2mqtt/icon.png and /dev/null differ diff --git a/zwavejs2mqtt/logo.png b/zwavejs2mqtt/logo.png deleted file mode 100644 index a5933418..00000000 Binary files a/zwavejs2mqtt/logo.png and /dev/null differ diff --git a/zwavejs2mqtt/translations/en.yaml b/zwavejs2mqtt/translations/en.yaml deleted file mode 100644 index f7ca4fba..00000000 --- a/zwavejs2mqtt/translations/en.yaml +++ /dev/null @@ -1,8 +0,0 @@ ---- -configuration: - log_level: - name: Log level - description: >- - Controls the level of log details the add-on provides. -network: - 3000/tcp: Z-Wave JS server port