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 b558454b93 remove compile information		2023-05-07 15:21:57 +02:00
.github	fix autoupdater : venv folder	2023-04-21 13:18:40 +02:00
conf	Use already compiled sources	2023-05-07 15:08:57 +02:00
doc	remove compile information	2023-05-07 15:21:57 +02:00
scripts	Use already compiled sources	2023-05-07 15:08:57 +02: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
LICENSE	Initial commit	2022-11-13 11:05:06 +01:00
manifest.toml	Use already compiled sources	2023-05-07 15:08:57 +02:00
README.md	Auto-update README	2023-04-21 11:20:11 +00:00
README_fr.md	Auto-update README	2023-04-21 11:20:11 +00:00
tests.toml	Initial Commit to v2 packaging	2023-02-24 00:06:37 +01: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 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.

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.

Shipped version: 8.14.1~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 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