zwave-js-ui_ynh/README.md

<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->

# Zwave-JS-UI for YunoHost

[![Integration level](https://dash.yunohost.org/integration/zwave-js-ui.svg)](https://dash.yunohost.org/appci/app/zwave-js-ui) ![Working status](https://ci-apps.yunohost.org/ci/badges/zwave-js-ui.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/zwave-js-ui.maintain.svg)  
[![Install Zwave-JS-UI with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=zwave-js-ui)

*[Lire ce readme en français.](./README_fr.md)*

> *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](https://yunohost.org/#/install) to learn how to install it.*

## Overview

** !! WORK IN PROGRESS !! - DO NOT INSTALL YET **

### 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](https://github.com/YunoHost-Apps/domoticz_ynh) for more information about how to set up domoticz and Mosquitto.

This app may also be usable with [Home-Assistant package](https://github.com/YunoHost-Apps/homeassistant_ynh) but I never tested it.

**Shipped version:** 8.4.1~ynh1
## Disclaimers / important information



*** !! WORK IN PROGRESS !! - DO NOT INSTALL YET ***

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


## 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](https://github.com/YunoHost-Apps/zwave-js-ui_ynh/tree/testing).

To try the testing branch, please proceed like that.

``` bash
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>