zwave-js-ui_ynh/README.md

Zwave-JS-UI for YunoHost

Read this README in other languages.

This package allows you to install Zwave-JS-UI quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

Features

Integrate zwave-js-ui natively in Domoticz_ynh.

Zwave-JS-UI, also known under previous name ZWaveJS2MQTT, is a replacement for Openzwave. It exposes Z-Wave devices to an MQTT broker in a fully configurable manner.

To work correctly, this app require to install either

• Domoticz package with mqtt broker Mosquitto
• Home-Assistant package

For now, although the package is fully functional (install, remove, backup, restore...), it is not integrated with domoticz and mosquitto package, this means that all settings needs to be done manually from inside the app.

Shipped version: 9.14.0~ynh1

Documentation and resources

• Official app website: https://zwave-js.github.io/zwave-js-ui/#/
• Official user documentation: https://www.domoticz.com/wiki/Zwave-JS-UI
• Official admin documentation: https://zwave-js.github.io/zwave-js-ui/#/
• Upstream app code repository: https://github.com/zwave-js/zwave-js-ui
• YunoHost Store: https://apps.yunohost.org/app/zwave-js-ui
• Report a bug: https://github.com/YunoHost-Apps/zwave-js-ui_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that:

sudo yunohost app install https://github.com/YunoHost-Apps/zwave-js-ui_ynh/tree/testing --debug
or
sudo yunohost app upgrade zwave-js-ui -u https://github.com/YunoHost-Apps/zwave-js-ui_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps