# Zwave-js-ui

Zwave-js-ui is a self-hosted home automation app. A fully configurable Z-Wave control panel and MQTT gateway built with Node.js and Vue, giving home-automation users an easy web interface to include, manage, and automate Z-Wave devices across their network. It is open source and self-hosted, installable on Docker Hub, Proxmox, Unraid and TrueNAS.

Canonical page: https://ourlocalhost.com/app/558/zwave-js-ui

## Description

A fully configurable Z-Wave control panel and MQTT gateway built with Node.js and Vue, giving home-automation users an easy web interface to include, manage, and automate Z-Wave devices across their network.

## Platform availability

Available on 3 of 9 platforms: Unraid, TrueNAS, Proxmox.

## Health score

78/100 (Good), based on 3 of 4 factors.
- Maintained: 100 (last commit 21 days ago)
- Popular: 62 (1,243 GitHub stars)
- Easy to install: 55 (3 install platforms, install notes, Docker image)

## Links

- Docker Hub: https://hub.docker.com/r/zwavejs/zwave-js-ui
- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=zwave-js-ui
- Unraid: https://ca.unraid.net/apps/zwave-js-ui-1i9ghot1u7qx7d?q=zwave-js-ui
- Official website: https://zwave-js.github.io/zwave-js-ui
- GitHub: https://github.com/zwave-js/zwave-js-ui
- TrueNAS: https://apps.truenas.com/catalog/zwave-js-ui/

## Common questions

### How should I pass a Z-Wave USB adapter to zwave-js-ui?

Use a stable serial/by-id path for the adapter instead of a short generic path. Find the correct path with a terminal command such as ls -l /dev/serial/by-id.

### Which storage folder should I back up for zwave-js-ui?

Back up the STORE_DIR storage folder, which holds your settings and paired Z-Wave devices. If it is lost during an update or reinstall, you may have to pair everything again.

### Why do new Z-Wave devices not appear in zwave-js-ui?

You need to use inclusion or learn mode to pair a device. This puts the controller into pairing mode, and without it new devices will not join.

### How does the Home Assistant integration connect to zwave-js-ui?

The Home Assistant integration connects to the websocket exposed by the Z-Wave JS UI server component. That server component talks to the hardware and exposes the devices.

### Why won't an older zwave-js-ui add-on load after a rollback?

An older zwave-js-ui add-on may fail to start after rolling back Home Assistant. It can complain that it cannot find the older version through GitHub.

---
Source: Our Local Host (https://ourlocalhost.com/app/558/zwave-js-ui), the self-hosted and open-source app directory.