Skip to content

About

Fully configurable Z-wave JS Control Panel and Z-Wave to MQTT Gateway

Resources

Stars

16 stars

Watchers

3 watching

Forks

Repository files navigation

Z-Wave JS UI

Full-featured Z-Wave control panel and MQTT gateway compatible with 500 and 700 series Z-Wave controller adapters. Z-Wave JS runs on many platforms and provides a modern web UI plus flexible integration options.

Get it from the Snap Store Donate with PayPal

About This Package

This repository contains a snap package for Z-Wave JS UI, making installation straightforward and enabling automatic updates via the Snap Store.

If you find this snap package useful, please consider:

Getting started

sudo snap install zwave-js-ui
sudo zwave-js-ui.enable          # the service is disabled until you enable it

Then open http://<host>:8091. zwave-js-ui.help shows the settings and commands; sudo zwave-js-ui.ui is an interactive navigator for settings, service, interfaces and logs. Settings are snap config: sudo snap set zwave-js-ui server.port=8092 (the service restarts itself when a setting it uses changes; sudo snap unset zwave-js-ui <key> restores the default).

Release Channels

The snap uses different channels in the latest track to give you control over update frequency:

  • latest/stable — Latest version of the previous major release. Updates only once per major release cycle, typically near the end. For example, when version b.0.0 is released, version a.x.y (the last release of the previous major version) becomes available in stable.

  • latest/candidate — Latest minor or patch release of the current major version. Updates when version a.b.c changes to a.b.d (patch) or a.c.0 (minor). This is a rolling release channel for users who want regular updates without major version changes.

  • latest/edge — Development builds. Every build, including experimental and test versions, may be pushed to this channel. It is intended for maintainers and testers only.

For users who want full control and prefer not to receive automatic updates between major and minor releases, use a specific version track (for example, v9.11). This allows you to stay on a particular major.minor version and only receive patch updates.

To see all available tracks and channels:

snap info zwave-js-ui | awk '/channels:/,/^$/' | grep -v '\^' | awk 'NR==1 {h=$0; next} BEGIN{p=""; n=0} {split($1,a,"/"); c=a[1]; if(p!="" && c!=p) lines[n++]="---------------------------"; p=c; lines[n++]=$0} END {print h; for(i=n-1;i>=0;i--) print lines[i]}'

To find the default channel:

snap info zwave-js-ui | awk '/channels:/,/^$/' | grep -v '\^' | awk 'NR==2 {print $1}'

To install from a specific channel:

sudo snap install zwave-js-ui --channel=latest/candidate

To switch to a specific version track:

sudo snap refresh zwave-js-ui --channel=v9.11

To switch between channels within a track:

sudo snap refresh zwave-js-ui --channel=latest/stable

Main Features

Control Panel UI

Manage your Z-Wave network from the web interface:

  • Nodes management: add, remove, and configure nodes
  • Firmware updates: apply manufacturer firmware files when available
  • Group associations: manage direct node associations
  • Full Z-Wave JS API access via the UI

Gateway & Integration

  • Z-Wave to MQTT gateway with configurable exposure of devices
  • Backend driver compatible with Home Assistant's official integration
  • Home Assistant MQTT discovery support
  • Domoticz compatibility via MQTT autodiscovery (beta)

Security & Management

  • HTTPS and user authentication support
  • Scene management with MQTT trigger support and timeouts
  • Automatic and scheduled backups of NVM and store directory, with optional backups before include/exclude/replace operations

Monitoring & Debugging

  • View debug logs from the UI
  • Access files in the persistent store from the UI
  • Network graph that visualizes node communication paths

Snap-Specific Features

This snap includes features that simplify running and managing Z-Wave JS UI on systems that use snaps:

  • Read logs from the terminal regardless of whether the application logs to file (zwave-js-ui.logs)
  • Optional integration with the code-server snap to edit files in the persistent store

Interfaces

The service needs hardware-observe and one of raw-usb or serial-port. It refuses to start without them: sudo zwave-js-ui.enable and zwave-js-ui.restart print which interface is missing and the command that connects it.

  • raw-usb (auto-connected from the Snap Store) — USB Z-Wave controller sticks.
  • hardware-observe (auto-connected) — lets the UI discover devices on the host.
  • serial-port (manual; needs snapd's experimental hotplug) — a serial controller instead of raw-usb.
  • log-observe (manual) — zwave-js-ui.logs reads journald for any log not written to file; without it the command exits with the fix: sudo snap connect zwave-js-ui:log-observe.

Manual connections (needed after snap install --dangerous of a local build):

sudo snap connect zwave-js-ui:raw-usb
sudo snap connect zwave-js-ui:hardware-observe

Notes:

  • Depending on your distribution you may need to adjust USB device permissions for the controller.
  • raw-usb grants broad USB access; connect it only if you trust the snap source.

Reporting Issues

Z-Wave JS UI (front-end)

For UI or front-end related issues, report at:

Z-Wave JS (driver)

For issues with the Z-Wave JS driver, report at:

Before reporting, please:

  1. Set the relevant component's log level to DEBUG.
  2. Enable logging to file.
  3. Attach the log file(s) to your issue.

If you're unsure where to report an issue, choose either repo and attach logs for both packages. The issue can be transferred to the correct tracker if needed.

Snap Package (this repository)

For problems specific to this snap packaging, report at:

About

Fully configurable Z-wave JS Control Panel and Z-Wave to MQTT Gateway

Resources

Stars

16 stars

Watchers

3 watching

Forks

Sponsor this project

Contributors

Languages

⌂ 换网址