mirror of https://github.com/YunoHost-Apps/zwave-js-ui_ynh.git synced 2024-09-03 18:06:00 +02:00

Fully configurable Z-Wave to MQTT Gateway and Control Panel

Find a file

Krakinou 9a2016b01c Temp : cron every 5 min		2022-12-17 13:28:00 +01:00
.github	Temp : cron every 5 min	2022-12-17 13:28:00 +01:00
conf	v8.6.0	2022-12-12 21:31:17 +01:00
doc	Update documentation	2022-11-26 17:50:07 +01:00
scripts	Add user to dialout/i2c/gpio	2022-11-26 18:26:31 +01:00
sources	Initial commit	2022-11-13 11:25:39 +01:00
.gitignore	Initial commit	2022-11-13 11:25:39 +01:00
.project	Initial commit	2022-11-13 11:25:39 +01:00
check_process	v8.6.0	2022-12-12 21:31:17 +01:00
LICENSE	Initial commit	2022-11-13 11:05:06 +01:00
manifest.json	v8.6.0	2022-12-12 21:31:17 +01:00
README.md	Auto-update README	2022-12-12 20:31:21 +00:00
README_fr.md	Auto-update README	2022-12-12 20:31:21 +00:00

README.md

Zwave-JS-UI for YunoHost

Lire ce readme en français.

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 domoticz with mqtt broker Mosquitto installed. Please refer to domoticz package for Yunohost for more information about how to set up domoticz and Mosquitto. You may also install both app separatly.

This app may also be usable with Home-Assistant package but I never tested it.

Shipped version: 8.6.0~ynh1

Disclaimers / important information

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.

During install, the whole app need to be recompile using yarn, this lead to long installation time. Also, a temporary swap file will be created if less than 2Gb of memory (RAM+Swap) are available : Be sure to have enough space on disk.

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 documentation for this app: https://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