Skip to content

Latest commit

 

History

History
147 lines (110 loc) · 6.33 KB

README.md

File metadata and controls

147 lines (110 loc) · 6.33 KB

Home Assistant Community Add-on: Z-Wave JS to MQTT

GitHub Release Project Stage License

Supports armhf Architecture Supports armv7 Architecture Supports aarch64 Architecture Supports amd64 Architecture Supports i386 Architecture

Github Actions Project Maintenance GitHub Activity

Discord Community Forum

Sponsor Frenck via GitHub Sponsors

Support Frenck on Patreon

Fully configurable Z-Wave JS to MQTT gateway and control panel.

Z-Wave JS to MQTT

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 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 software.

📚 Read the full add-on documentation

Support

Got questions?

You have several options to get them answered:

You could also open an issue here GitHub.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We have set up a separate document containing our contribution guidelines.

Thank you for being involved! 😍

Authors & contributors

The original setup of this repository is by Franck Nijhof.

For a full list of all authors and contributors, check the contributor's page.

We have got some Home Assistant add-ons for you

Want some more functionality to your Home Assistant instance?

We have created multiple add-ons for Home Assistant. For a full list, check out our GitHub Repository.

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.