Z-Wave JS UI

https://github.com/zwave-js/zwave-js-ui
Admin
Full featured Z-Wave Control Panel UI and MQTT gateway. Built using Nodejs, and Vue/Vuetify
Tokens:37,599
Snippets:511
Trust Score:9.4
License:MIT
Update:3 months ago
Show doc for...
Tokens:
Raw
### Start Learn Mode

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Starts the controller's learn mode.

```ts
async startLearnMode(): Promise<JoinNetworkResult>;
```

```json
{
  "args": []
}
```

--------------------------------

### Install Z-Wave JS UI with Snap

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/getting-started/other-methods.md

Install the Z-Wave JS UI Snap package. This method requires Snapd to be installed and grants necessary permissions for USB and hardware access.

```bash
sudo snap install zwave-js-ui
```

```bash
sudo snap connect zwave-js-ui:raw-usb
```

```bash
sudo snap connect zwave-js-ui:hardware-observe
```

--------------------------------

### Start Z-Wave JS UI with Nginx Proxy

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docker/nginx/README.md

Use this command to launch the Z-Wave JS UI and Nginx proxy setup defined in the docker-compose file. Access the UI via HTTPS on the specified port.

```bash
docker-compose up -d
```

--------------------------------

### Install Plugin in Docker

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/plugins.md

Steps to clone, install dependencies, and prepare a local plugin within the Docker store directory. Ensure you navigate into the plugin's directory before running npm install.

```bash
cd /path/to/your/store/plugins
git clone https://github.com/kvaster/zwavejs-prom.git
cd zwavejs-prom
npm install
```

--------------------------------

### Build and run Z-Wave JS UI from GitHub source

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/getting-started/other-methods.md

Compile and run the latest Z-Wave JS UI code from its GitHub repository. This requires cloning the repository, installing dependencies, building the project, and then starting it.

```bash
git clone https://github.com/zwave-js/zwave-js-ui
cd zwave-js-ui
npm install
npm run build
npm start
```

--------------------------------

### Start Backend Development Server

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/development/intro.md

Run this command in a separate terminal to start the backend server. It includes inspect and auto-restart features for debugging.

```bash
npm run dev:server
```

--------------------------------

### Provision Smart Start Node API

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Method signature for provisioning a Smart Start node and the corresponding MQTT topic and payload structure.

```ts
async provisionSmartStartNode(entry: PlannedProvisioningEntry | string): Promise<PlannedProvisioningEntry>;
```

```json
{
	"args": [
		entry
	]
}
```

--------------------------------

### startLearnMode

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Starts the Z-Wave learn mode.

```APIDOC
## MQTT Topic: zwave/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/api/startLearnMode/set

### Description
Starts learn mode.

### Request Body
- **args** (array) - Required - Empty array
```

--------------------------------

### Start Frontend Development Server

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/development/intro.md

Run this command in a terminal to start the webpack-dev server for frontend development. It enables hot reloading on the specified port.

```bash
npm run dev
```

--------------------------------

### Run Backend Development Server

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/CLAUDE.md

Starts the backend development server. Use this for backend-related development.

```bash
npm run dev:server     # Backend dev server (port 8091)
```

--------------------------------

### Configure PM2 to run Z-Wave JS UI as a service

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/getting-started/other-methods.md

Set up PM2 to manage Z-Wave JS UI as a service. This involves installing PM2, creating an ecosystem configuration file, and starting the service.

```bash
npm install -g pm2
```

```javascript
module.exports = {
  apps : [
      {
        out_file: "/dev/null", // disable logs, use log to file when needed
        error_file: "/dev/null", // disable logs, use log to file when needed
        cwd: "~/",
        script: "zwave-js-ui",
        env: {
          STORE_DIR: "~/.zwave-js-ui",
        },
      },
  ]
}
```

```bash
pm2 start ecosystem.config.js
pm2 save
pm2 startup
```

--------------------------------

### Start Inclusion

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Starts the inclusion process to add a new node to the network.

```ts
async startInclusion(
	strategy: InclusionStrategy = InclusionStrategy.Default,
	options?: {
		forceSecurity?: boolean
		provisioning?: PlannedProvisioningEntry
		qrString?: string
		name?: string
		dsk?: string
		location?: string
	},
): Promise<boolean>;
```

```json
{
	"args": [
		strategy,
		options
	]
}
```

--------------------------------

### installConfigUpdate

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Checks for configs updates and installs them.

```APIDOC
## MQTT Topic: zwave/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/api/installConfigUpdate/set

### Description
Checks for configs updates and installs them.

### Request Body
- **args** (array) - Required - []
```

--------------------------------

### Run Frontend Development Server

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/CLAUDE.md

Starts the frontend development server. Ensure this is run for frontend development tasks.

```bash
npm run dev            # Frontend dev server (port 8092)
```

--------------------------------

### Install Z-Wave JS UI with NPM

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/getting-started/other-methods.md

Install Z-Wave JS UI globally using NPM. It is crucial to configure a custom storage path to prevent data loss on updates.

```bash
npm install -g zwave-js-ui
```

```bash
zwave-js-ui
```

```bash
STORE_DIR=~/.zwave-js-ui \
zwave-js-ui
```

--------------------------------

### Minimal External Client Example

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/socket-api.md

An example client script that connects, subscribes only to node events, and logs node updates, additions, and removals. This client will not receive events outside the 'nodes' channel.

```javascript
import { io } from "socket.io-client";

const socket = io("http://localhost:8091");

socket.on("connect", () => {
  // Subscribe only to what we need
  socket.emit("SUBSCRIBE", { channels: ["nodes"] });

  // Request initial state
  socket.emit("INITED", true, (state) => {
    console.log("Initial nodes:", Object.keys(state.nodes).length);
  });
});

socket.on("NODE_UPDATED", (node) => {
  console.log(`Node ${node.id} updated: ${node.name} (${node.status})`);
});

socket.on("NODE_ADDED", (node) => {
  console.log(`Node added: ${node.id}`);
});

socket.on("NODE_REMOVED", (node) => {
  console.log(`Node removed: ${node.id}`);
});
```

--------------------------------

### Minimal Custom Plugin Example

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/plugins.md

A basic implementation of a custom plugin class. It demonstrates how to access clients from the context and set up routes, MQTT messages, or Z-Wave event listeners.

```javascript
export default class MyPlugin {
  constructor(ctx) {
    this.zwave = ctx.zwave;
    this.mqtt = ctx.mqtt;
    this.logger = ctx.logger;
    this.express = ctx.app;

    // this.express.get('/my-route', (req, res) => { ... });
    // this.mqtt.publish(...);
    // this.zwave.on('valueChanged', this.onValueChanged);
    // ... add all the stuff you need here
  }

  async destroy() {
    // clean up event listeners, intervals, etc.
  }
}
```

--------------------------------

### Conventional Commit Examples

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/AGENTS.md

Examples of commit messages following the conventional commit format.

```text
feat(api): add device polling endpoint
fix(ui): resolve memory leak in node table
docs: update installation guide
test: add coverage for MQTT gateway
chore: update dependencies
```

--------------------------------

### Home Assistant Add-on Configuration

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/usage/setup.md

Example environment variables and JSON configuration for integrating Z-Wave JS UI within a Home Assistant add-on.

```bash
# Force controller port
ZWAVE_PORT=/dev/serial/by-id/usb-0658_0200-if00

# External settings for security keys and server config
ZWAVE_EXTERNAL_SETTINGS=/config/zwave-external-settings.json
```

```json
{
  "logEnabled": true,
  "logLevel": "info",
  "logToFile": false,
  "securityKeys": {
    "S0_Legacy": "<generated-by-addon>",
    "S2_Unauthenticated": "<generated-by-addon>",
    "S2_Authenticated": "<generated-by-addon>",
    "S2_AccessControl": "<generated-by-addon>"
  },
  "serverEnabled": true,
  "serverPort": 3000,
  "serverHost": "0.0.0.0"
}
```

--------------------------------

### Install Config Update MQTT API

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Checks for configs updates and installs them.

```ts
async installConfigUpdate(): Promise<boolean>;
```

```json
{
  "args": []
}
```

--------------------------------

### Execute Scene via MQTT

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Example payload for activating a scene with a specific ID.

```js
{
	"args": [
		1 // id of scene
	]
}
```

--------------------------------

### Get Scenes MQTT API

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Get all scenes.

```ts
_getScenes(): ZUIScene[];
```

```json
{
  "args": []
}
```

--------------------------------

### startInclusion

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Starts the inclusion process to add a new node.

```APIDOC
## MQTT Topic: zwave/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/api/startInclusion/set

### Description
Start inclusion.

### Request Body
- **args** (array) - Required - Contains [strategy, options]
```

--------------------------------

### Run Z-Wave JS UI using a Local Folder

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/getting-started/docker.md

This command starts the Z-Wave JS UI container, mapping ports and using a local directory for data persistence. Create the 'store' directory beforehand and replace the placeholder with your actual serial device path.

```bash
mkdir store
docker run --rm -it -p 8091:8091 -p 3000:3000 --device=/dev/serial/by-id/insert_stick_reference_here:/dev/zwave \
-v $(pwd)/store:/usr/src/app/store zwavejs/zwave-js-ui:latest
```

--------------------------------

### Install libseccomp2 on Raspbian Buster

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/troubleshooting/app_crash.md

These commands install the necessary `libseccomp2` package from Debian backports for Raspbian Buster users experiencing startup crashes with Z-Wave JS UI 8.2.0+.

```bash
sudo apt-key adv --keyserver hkps://keyserver.ubuntu.com:443 --recv-keys 04EE7237B7D453EC 648ACFD622F3D138\necho "deb http://httpredir.debian.org/debian buster-backports main contrib non-free" | sudo tee -a "/etc/apt/sources.list.d/debian-backports.list"\nsudo apt update\nsudo apt install libseccomp2 -t buster-backports
```

--------------------------------

### Run Mock Z-Wave Controller

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/CLAUDE.md

Starts a mock Z-Wave controller for testing purposes. Useful when a physical controller is unavailable.

```bash
npm run fake-stick     # Mock Z-Wave controller (port 5555)
```

--------------------------------

### Start Exclusion

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Starts the exclusion process to remove a node from the network.

```ts
async startExclusion(
	options: ExclusionOptions = {
		strategy: ExclusionStrategy.DisableProvisioningEntry,
	},
): Promise<boolean>;
```

```json
{
	"args": [
		options
	]
}
```

--------------------------------

### getInfo

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Get driver information.

```APIDOC
## MQTT Topic: zwave/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/api/getInfo/set

### Description
Get driver information.

### Request Body
- **args** (array) - Required - []
```

--------------------------------

### startExclusion

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Starts the exclusion process to remove a node.

```APIDOC
## MQTT Topic: zwave/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/api/startExclusion/set

### Description
Start exclusion.

### Request Body
- **args** (array) - Required - Contains [options]
```

--------------------------------

### Download and run Z-Wave JS UI packaged version

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/getting-started/other-methods.md

Execute Z-Wave JS UI using its packaged version. This method does not require NodeJS or NPM to be installed. It involves downloading the latest release, unzipping, and running the executable.

```bash
cd ~
mkdir zwave-js-ui
cd zwave-js-ui
# download latest version
curl -s https://api.github.com/repos/zwave-js/zwave-js-ui/releases/latest  \
| grep "browser_download_url.*zip" \
| cut -d : -f 2,3 \
| tr -d \" \
| wget -i -
unzip zwave-js-ui-v*.zip
./zwave-js-ui
```

--------------------------------

### Send Command via MQTT

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Example payload for calling a specific Z-Wave command, such as startLevelChange.

```js
{ 
	"args": [
		{
			"nodeId": 23,
			"commandClass": 38,
			"endpoint": 0,
		},
		"startLevelChange",
		[{ duration: "1m"}] // this are the args of the command
  ]
}
```

--------------------------------

### _getScenes

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Get all scenes.

```APIDOC
## MQTT Topic: zwave/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/api/_getScenes/set

### Description
Get all scenes.

### Request Body
- **args** (array) - Required - []
```

--------------------------------

### Run Z-Wave JS UI as a Docker Service

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/getting-started/quick-start.md

Set up Z-Wave JS UI as a service using Docker Compose. Download the docker-compose.yml file and run the command to start the service in detached mode.

```bash
# As a service
wget https://raw.githubusercontent.com/zwave-js/zwave-js-ui/master/docker/docker-compose.yml
docker-compose up -d
```

--------------------------------

### MQTT Topic Structure for Multicast Groups

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/usage/groups.md

Example of the MQTT topic structure for a multicast group named 'Living Room Lights'.

```text
zwave/Living Room Lights/Multilevel Switch/endpoint_0/targetValue
zwave/Living Room Lights/Multilevel Switch/endpoint_0/targetValue/set
```

--------------------------------

### Broadcast Node Topic

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Example topic for sending a broadcast command to all nodes in the network.

```text
# Write to broadcast node (named topics)
zwave/Broadcast/Binary Switch/endpoint_0/targetValue/set
```

--------------------------------

### Get Info MQTT API

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Retrieve driver information.

```ts
getInfo(): ZUIDriverInfo;
```

```json
{
  "args": []
}
```

--------------------------------

### Identify Z-Wave Stick Path

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/troubleshooting/app_crash.md

Example output from `ls -l /dev/serial/by-id` showing how to recognize the Z-Wave stick and its corresponding path.

```bash
...\nlrwxrwx 1 root root 13 Oct 25 20:19 usb-Silicon_Labs_CP2102N_USB_to_UART_Bridge_Controller_8ad925bd7b84e911a7a1d6217343c2-if00-port0 -> ../../ttyUSB0
```

--------------------------------

### Run Z-Wave JS UI using Docker Volumes

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/getting-started/docker.md

This command starts the Z-Wave JS UI container, mapping ports and using a named Docker volume for data persistence. Ensure you replace the placeholder with your actual serial device path.

```bash
docker run --rm -it -p 8091:8091 -p 3000:3000 --device=/dev/serial/by-id/insert_stick_reference_here:/dev/zwave \
--mount source=zwave-js-ui,target=/usr/src/app/store zwavejs/zwave-js-ui:latest
```

--------------------------------

### Setting X-External-Path Header with Home Assistant Ingress

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/usage/reverse-proxy.md

Example of how to set the X-External-Path header dynamically using the $http_x_ingress_path variable, commonly used with Home Assistant's ingress.

```nginx
proxy_set_header X-External-Path $http_x_ingress_path;
```

--------------------------------

### Scene Get Values MQTT API

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Return all values of the scene with given sceneid.

```ts
_sceneGetValues(sceneid: number): ZUIValueIdScene[];
```

```json
{
	"args": [
		sceneid
	]
}
```

--------------------------------

### Docker Compose Healthcheck Configuration

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/getting-started/docker.md

Integrate the healthcheck into your Docker Compose setup. This defines the test command, interval, timeout, start period, and retries for the healthcheck.

```yaml
version: '3.7'
services:
    zwave-js-ui:
    # ..... other settings .....
      healthcheck:
          test: 'wget --no-verbose --spider --no-check-certificate --header "Accept: text/plain" https://localhost:8091/health || exit 1'
          interval: 1m
          timeout: 10s
          start_period: 30s
          retries: 3
```

--------------------------------

### Virtual Node Named Topics

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Example topic structure for reading and writing values to a named multicast group.

```text
# Published value (read)
zwave/Living Room Lights/Multilevel Switch/endpoint_0/targetValue

# Write to group (sends multicast command to all members)
zwave/Living Room Lights/Multilevel Switch/endpoint_0/targetValue/set
```

--------------------------------

### Get Available Firmware Updates

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Retrieves a list of available firmware updates for a specific node.

```ts
async getAvailableFirmwareUpdates(
	nodeId: number,
	options?: GetFirmwareUpdatesOptions,
): Promise<{ version: string; changelog: string; channel: "stable" | "beta"; files: FirmwareUpdateFileInfo[]; downgrade: boolean; normalizedVersion: string; region?: string; device: { manufacturerId: number; productType: number; productId: number; firmwareVersion: string; rfRegion?: RFRegion; }; }[]>;
```

```json
{
	"args": [
		nodeId,
		options
	]
}
```

--------------------------------

### Create and Inspect Buildx Builder Instance

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/development/custom-docker.md

Set up and verify a Docker buildx builder instance for multi-architecture image builds.

```bash
# create a builder instance
docker buildx create --use
docker buildx inspect --bootstrap
```

--------------------------------

### Node Information JSON Payload

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Example of the JSON payload structure returned for node information topics.

```json
{
	"id": 97,
	"deviceId": "271-4098-2049",
	"manufacturer": "Fibargroup",
	"manufacturerId": 271,
	"productType": 2049,
	"productId": 4098,
	"name": "Sensor",
	"loc": "Hallway",
	"neighbors": [29, 43, 63, 64, 65, 66, 67, 72, 74, 86],
	"ready": true,
	"available": true,
	"failed": false,
	"lastActive": 1610009585743,
	"firmwareVersion": "3.3",
	"supportsBeaming": true,
	"isSecure": false,
	"keepAwake": false,
	"maxBaudRate": null,
	"isRouting": true,
	"isFrequentListening": false,
	"isListening": false,
	"status": "Asleep",
	"interviewStage": "Complete",
	"productLabel": "FGMS001",
	"productDescription": "Motion Sensor",
	"zwaveVersion": 4,
	"deviceClass": {
		"basic": 4,
		"generic": 7,
		"specific": 1
	},
	"hexId": "0x010f-0x1002-0x0801"
}
```

--------------------------------

### Get Nodes MQTT API

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Get the nodes array.

```ts
getNodes(): ZUINode[];
```

```json
{
  "args": []
}
```

--------------------------------

### Docker Compose Volume Configuration

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/plugins.md

Example Docker Compose volume configuration to manage separate storage for Z-Wave JS UI data and third-party plugins. This ensures plugins persist independently.

```yaml
volumes:
  - ./store:/usr/src/app/store
  - ./plugins:/usr/src/app/plugins
```

--------------------------------

### Build Frontend and Backend

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/CLAUDE.md

Performs a full build of both the frontend and backend applications. Use this for production builds.

```bash
npm run build          # Full build (frontend + backend)
```

--------------------------------

### Package the Application

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/development/intro.md

Execute this command to package the Z-Wave JS UI application. Follow the on-screen prompts for further steps.

```bash
npm run pkg
```

--------------------------------

### getNodes

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Get the nodes array.

```APIDOC
## MQTT Topic: zwave/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/api/getNodes/set

### Description
Get the nodes array.

### Request Body
- **args** (array) - Required - []
```

--------------------------------

### provisionSmartStartNode

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Provisions a SmartStart node via MQTT.

```APIDOC
## MQTT Topic: zwave/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/api/provisionSmartStartNode/set

### Description
Provisions a new SmartStart node using the provided entry details.

### Request Body
- **args** (array) - Required - An array containing the `entry` (PlannedProvisioningEntry | string).
```

--------------------------------

### cancelGetSchedule

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Cancels a pending get schedule operation.

```APIDOC
## MQTT cancelGetSchedule

### Topic
`zwave/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/api/cancelGetSchedule/set`

### Request Body
- **args** (array) - Required - Empty array.
```

--------------------------------

### View Project Directory Structure

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/AGENTS.md

Overview of the repository layout and core module locations.

```text
zwave-js-ui/
├── api/                 # Backend (TypeScript)
│   ├── app.ts           # Express app
│   ├── config/          # Configuration
│   └── lib/             # Utilities
├── src/                 # Frontend (Vue 3)
│   ├── components/      # UI components
│   ├── views/           # Pages
│   ├── stores/          # Pinia stores
│   └── router/          # Vue Router
├── test/                # Tests
│   ├── backend/         # Backend tests
│   └── frontend/        # Frontend tests
├── docs/                # Documentation
├── .github/
│   ├── agents/          # Agent definitions
│   ├── instructions/    # Legacy instructions
│   └── workflows/       # CI/CD
├── dist/                # Built frontend (generated)
├── server/              # Built backend (generated)
└── store/               # Runtime data (logs, backups)
```

--------------------------------

### Get Groups API

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Retrieves all configured multicast groups.

```ts
_getGroups(): Group[]
```

```json
{
	"args": []
}
```

--------------------------------

### Execute Project Development Commands

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/AGENTS.md

Common npm scripts for development, building, testing, and quality assurance.

```bash
# Development
npm run dev              # Frontend dev server (port 8092)
npm run dev:server       # Backend dev server (port 8091)
npm run fake-stick       # Mock Z-Wave controller

# Building
npm run build            # Build everything (~24s)
npm run build:ui         # Frontend only (~17s)
npm run build:server     # Backend only (~2s)

# Testing
npm test                 # All tests (~3s)
npm run test:server      # Backend tests
npm run test:ui          # Frontend tests
npm run coverage         # Coverage report

# Quality
npm run lint-fix         # Auto-fix issues
npm run lint             # Validate code

# Documentation
npm run docs             # Serve docs (port 3000)
```

--------------------------------

### Get Priority Route

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Returns the priority route details for a specific node.

```ts
async getPriorityRoute(nodeId: number): Promise<{ routeKind: RouteKind.LWR | RouteKind.NLWR | RouteKind.Application; repeaters: number[]; routeSpeed: ZWaveDataRate; }>;
```

```json
{
	"args": [
		nodeId
	]
}
```

--------------------------------

### Get Custom Return Routes

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Retrieves custom return routes between two nodes.

```ts
getCustomReturnRoute(nodeId: number, destinationId: number): Route[];
```

```json
{
	"args": [
		nodeId,
		destinationId
	]
}
```

--------------------------------

### getProvisioningEntry

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Retrieves a specific SmartStart provisioning entry by DSK.

```APIDOC
## MQTT Topic: zwave/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/api/getProvisioningEntry/set

### Description
Fetches a single provisioning entry based on the DSK.

### Request Body
- **args** (array) - Required - Contains [dsk].
```

--------------------------------

### Get Priority Return Route

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Retrieves the priority return route between two nodes.

```ts
getPriorityReturnRoute(nodeId: number, destinationId: number): Route;
```

```json
{
	"args": [
		nodeId,
		destinationId
	]
}
```

--------------------------------

### unprovisionSmartStartNode

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Removes a SmartStart provisioning entry.

```APIDOC
## MQTT Topic: zwave/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/api/unprovisionSmartStartNode/set

### Description
Unprovisions a node using its DSK or Node ID.

### Request Body
- **args** (array) - Required - Contains [dskOrNodeId].
```

--------------------------------

### getProvisioningEntries

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Retrieves all SmartStart provisioning entries.

```APIDOC
## MQTT Topic: zwave/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/api/getProvisioningEntries/set

### Description
Fetches the list of SmartStart provisioning entries.

### Request Body
- **args** (array) - Required - Empty array.
```

--------------------------------

### Get Node Neighbors via MQTT

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Retrieves the neighbor list for a specific node.

```ts
async getNodeNeighbors(
	nodeId: number,
	preventThrow = false,
	emitNodeUpdate = true,
): Promise<readonly number[]>;
```

```json
{
	"args": [
		nodeId,
		preventThrow,
		emitNodeUpdate
	]
}
```

--------------------------------

### getProvisioningEntry MQTT API

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Retrieves a specific SmartStart provisioning entry by DSK.

```ts
getProvisioningEntry(dsk: string): SmartStartProvisioningEntry | undefined;
```

```json
{
	"args": [
		dsk
	]
}
```

--------------------------------

### Home Assistant MQTT Light Configuration

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/homeassistant/homeassistant-mqtt.md

Manual configuration for a light entity using MQTT in Home Assistant. Includes topics for state, command, and availability, along with payload definitions for on/off states.

```yaml
light:
  - platform: mqtt
    name: 'Office Light'
    state_topic: 'zwave/office_light/37/0/currentValue'
    command_topic: 'zwave/office_light/37/0/targetValue/set'
    availability_topic: 'zwave/office_light/status'
    payload_available: 'true'
    payload_not_available: 'false'
    payload_on: 'true'
    payload_off: 'false'
    optimistic: false
    qos: 0
    retain: true
```

--------------------------------

### Get Custom SUC Return Routes

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Retrieves custom return routes from a node to the controller.

```ts
getCustomSUCReturnRoute(nodeId: number): Route[];
```

```json
{
	"args": [
		nodeId
	]
}
```

--------------------------------

### Get Priority SUC Return Route

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Retrieves the priority return route from a node to the controller.

```ts
getPrioritySUCReturnRoute(nodeId: number): Route;
```

```json
{
	"args": [
		nodeId
	]
}
```

--------------------------------

### Home Assistant MQTT Configuration

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/homeassistant/homeassistant-mqtt.md

Configure MQTT settings in Home Assistant's configuration.yaml to enable discovery and set up birth/will messages.

```yaml
mqtt:
  discovery: true
  discovery_prefix: <your_discovery_prefix>
  broker: [YOUR MQTT BROKER] # Remove if you want to use builtin-in MQTT broker
  birth_message:
    topic: 'homeassistant/status'
    payload: 'online'
  will_message:
    topic: 'homeassistant/status'
    payload: 'offline'
```

--------------------------------

### Build Custom Docker Image from Local Sources

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/development/custom-docker.md

Build a custom Docker image using a local copy of the zwave-js-ui repository and its Dockerfile.contrib, specifying 'local-copy-src' as the source.

```bash
DOCKER_BUILDKIT=1 docker build --build-arg SRC=local-copy-src --no-cache -f zwave-js-ui/docker/Dockerfile.contrib -t zwave-js-ui .
```

--------------------------------

### parseQRCodeString

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Parses a SmartStart QR code string via MQTT.

```APIDOC
## MQTT Topic: zwave/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/api/parseQRCodeString/set

### Description
Parses a provided QR code string to extract provisioning information.

### Request Body
- **args** (array) - Required - An array containing the `qrString` (string).
```

--------------------------------

### Deploy Z-Wave JS UI with Kubernetes

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/getting-started/other-methods.md

Apply the Kustomization configuration to deploy Z-Wave JS UI in a Kubernetes environment. Ensure the serial device reference in deployment.yaml is updated.

```bash
kubectl apply -k https://raw.githubusercontent.com/zwave-js/zwave-js-ui/master/kustomization.yaml
```

--------------------------------

### getProvisioningEntries MQTT API

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Retrieves all SmartStart provisioning entries.

```ts
async getProvisioningEntries(): Promise<SmartStartProvisioningEntry[]>;
```

```json
{
  "args": []
}
```

--------------------------------

### Get Associations API Definition and Usage

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

API definition and MQTT payload for retrieving node associations.

```ts
async getAssociations(
	nodeId: number,
	refresh = false,
): Promise<ZUIGroupAssociation[]>;
```

```json
{
	"args": [
		nodeId,
		refresh
	]
}
```

--------------------------------

### Get Schedules API Definition and Usage

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

API definition and MQTT payload for retrieving node schedules.

```ts
async getSchedules(
	nodeId: number,
	opts: { mode?: ZUIScheduleEntryLockMode; fromCache: boolean } = {
		fromCache: true,
	},
): Promise<ZUISchedule>;
```

```json
{
	"args": [
		nodeId,
		opts
	]
}
```

--------------------------------

### Execute Scene via MQTT Switch

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/homeassistant/homeassistant-mqtt.md

Create a switch in Home Assistant to trigger a scene activation using MQTT APIs. This requires specifying the MQTT prefix, name, and the scene ID to activate.

```yaml
switch:
  - platform: mqtt
    name: Doorbell Scene
    unique_id: zwavedoorbellscene
    command_topic: '<mqtt_prefix>/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/api/_activateScene/set'
    payload_on: '{ "args": [ <sceneId> ] }'
```

--------------------------------

### Cancel Get Schedule API Definition and Usage

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

API definition and MQTT payload for canceling a schedule retrieval request.

```ts
cancelGetSchedule(): void;
```

```json
{
  "args": []
}
```

--------------------------------

### Run Z-Wave JS UI with Docker (Local Folder Persistence)

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/getting-started/quick-start.md

This Docker command runs Z-Wave JS UI using a local folder for persistence. Create a 'store' directory first and replace the placeholder with your Z-Wave stick's serial device.

```bash
# Using a local folder as persistence
mkdir store
docker run --rm -it -p 8091:8091 -p 3000:3000 --device=/dev/serial/by-id/insert_stick_reference_here:/dev/zwave \
-v $(pwd)/store:/usr/src/app/store zwavejs/zwave-js-ui:latest
```

--------------------------------

### Virtual Node Value ID Topics

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Example topic structure for reading and writing values using a numeric group ID.

```text
# Published value (read)
zwave/4096/38/0/targetValue

# Write to group
zwave/4096/38/0/targetValue/set
```

--------------------------------

### Build Multi-Architecture Docker Containers

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/development/custom-docker.md

Build Docker images for multiple platforms (e.g., ARM64, AMD64, ARMv7) using Docker buildx.

```bash
# build the containers
docker buildx build \
    --platform linux/arm64,linux/amd64,linux/arm/v7 \
    -t zwavejs/zwave-js-ui:latest \
    -f docker/Dockerfile \
    .
```

--------------------------------

### beginRebuildingRoutes MQTT API

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Initiates network route rebuilding. The payload requires an options object.

```ts
beginRebuildingRoutes(options?: RebuildRoutesOptions): boolean;
```

```json
{
	"args": [
		options
	]
}
```

--------------------------------

### Subscribe to Channels

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/socket-api.md

Subscribes to specific event channels. Use the acknowledgement callback to get the current list of active subscriptions. Subscriptions are additive.

```javascript
socket.emit("SUBSCRIBE", { channels: ["nodes", "values"] });
```

```javascript
socket.emit("SUBSCRIBE", { channels: ["nodes", "values"] }, (data) => {
  console.log("Subscribed to:", data.channels);
  // e.g. ['nodes', 'values']
});
```

```javascript
// Already subscribed to ['nodes', 'values']
socket.emit("SUBSCRIBE", { channels: ["statistics"] });
// Now subscribed to ['nodes', 'values', 'statistics']
```

--------------------------------

### MQTT Topics

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Overview of available MQTT topics for gateway and node status monitoring.

```APIDOC
## MQTT Topics

### App Version
- **Topic**: `<mqtt_prefix>/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/version`
- **Payload**: Time-value JSON format containing the application version string.

### MQTT Status
- **Topic**: `<mqtt_prefix>/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/status`
- **Payload**: Time-value JSON format; `true` if connected, `false` otherwise.

### Node Status
- **Topic**: `<mqtt_prefix>/<?node_location>/<node_name>/status`
- **Payload**: `true` if ready, `false` otherwise. If JSON, includes `status` property (e.g., 'Alive', 'Awake', 'Dead').

### Node Last Active
- **Topic**: `<mqtt_prefix>/<?node_location>/<node_name>/lastActive`
- **Payload**: Timestamp of the last packet received from the node.

### Node Information
- **Topic**: `<mqtt_prefix>/<?node_location>/<node_name>/nodeinfo`
- **Payload**: JSON object containing node details (manufacturer, ready status, firmware, etc.).
```

--------------------------------

### Docker Run Healthcheck Command

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/getting-started/docker.md

Add the healthcheck configuration directly when running a Docker container. This includes the health command and start period.

```bash
docker run <other options here> --health-cmd="wget --no-verbose --spider --no-check-certificate --header "Accept: text/plain" https://localhost:8091/health || exit 1" --health-start-period=30s
```

--------------------------------

### Configure External Settings Path

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/usage/setup.md

Set the environment variable to point to the JSON file containing external settings.

```bash
ZWAVE_EXTERNAL_SETTINGS=/path/to/external-settings.json
```

--------------------------------

### Entire ValueId Object Payload Format

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/usage/setup.md

The payload structure containing the full Z-Wave value information, including examples for standard values and those with states.

```js
{
  id: "38-0-targetValue",
  nodeId: 8,
  commandClass: 38,
  commandClassName: "Multilevel Switch",
  endpoint: 0,
  property: "targetValue",
  propertyName: "targetValue",
  propertyKey: undefined,
  type: "number",
  readable: true,
  writeable: true,
  description: undefined,
  label: "Target value",
  default: undefined,
  genre: "user",
  min: 0,
  max: 99,
  step: undefined,
  unit: undefined,
  list: false,
  value: undefined,
  lastUpdate: 1604044669393,
}
```

```js
{
  id: "112-0-200",
  nodeId: 8,
  commandClass: 112,
  commandClassName: "Configuration",
  endpoint: 0,
  property: 200,
  propertyName: "Partner ID",
  propertyKey: undefined,
  type: "number",
  readable: true,
  writeable: true,
  description: undefined,
  label: "Partner ID",
  default: 0,
  genre: "config",
  min: 0,
  max: 1,
  step: undefined,
  unit: undefined,
  list: true,
  states: [
    {
      text: "Aeon Labs Standard Product",
      value: 0,
    },
    {
      text: "others",
      value: 1,
    },
  ],
  value: 0,
  lastUpdate: 1604044675644,
}
```

--------------------------------

### Build Custom Docker Image from Remote Dockerfile.contrib

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/development/custom-docker.md

Build a custom Docker image by fetching Dockerfile.contrib remotely and specifying node-zwave-js and zwave-js-ui branches.

```bash
curl -s https://raw.githubusercontent.com/zwave-js/zwave-js-ui/master/docker/Dockerfile.contrib | \
DOCKER_BUILDKIT=1 docker build - --build-arg SRC=git-clone-src --no-cache \
--build-arg ZWJ_BRANCH=master --build-arg ZUI_BRANCH=master -t zwave-js-ui
```

--------------------------------

### Run Quality Checks

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/AGENTS.md

Execute linting and test suites to ensure code quality before committing changes.

```bash
npm run lint-fix && npm run lint
npm test
```

--------------------------------

### Home Assistant MQTT Binary Sensor Configuration

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/homeassistant/homeassistant-mqtt.md

Manual configuration for a binary sensor (e.g., motion sensor) using MQTT in Home Assistant. Specifies topics for state, availability, and device class.

```yaml
binary_sensor:
  - platform: mqtt
    name: 'Hall Motion Sensor'
    state_topic: 'zwave/hall/48/0/Motion'
    payload_on: 'true'
    payload_off: 'false'
    availability_topic: 'zwave/hall_motion_sensor/status'
    payload_available: 'true'
    payload_not_available: 'false'
    qos: 0
    device_class: motion
```

--------------------------------

### beginRebuildingRoutes

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Initiates the process of rebuilding Z-Wave network routes.

```APIDOC
## MQTT Topic: zwave/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/api/beginRebuildingRoutes/set

### Description
Starts the network route rebuilding process.

### Request Body
- **args** (array) - Required - Contains the RebuildRoutesOptions object.
```

--------------------------------

### Build Latest Stable Docker Image

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/development/custom-docker.md

Clone the repository, checkout a specific branch, and build the latest stable Docker image using the project's Dockerfile.

```bash
git clone https://github.com/zwave-js/zwave-js-ui.git
cd zwave-js-ui
git checkout -b [the branch that you want]
docker build -f docker/Dockerfile -t zwavejs/zwave-js-ui:latest .
```

--------------------------------

### Configure MQTT Temperature Sensor

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/homeassistant/homeassistant-mqtt.md

Set up a sensor entity in Home Assistant to display temperature readings from a multi-sensor device via MQTT. Specify the state topic and unit of measurement.

```yaml
sensor:
  - platform: mqtt
    state_topic: 'zwave/kitchen_motion_sensor/49/0/Air_temperature'
    name: 'Temperature'
    unit_of_measurement: 'F'
```

--------------------------------

### Create Scene MQTT API

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Creates a new scene with a specific label and stores it in scenes.json.

```ts
async _createScene(label: string): Promise<boolean>;
```

```json
{
	"args": [
		label
	]
}
```

--------------------------------

### Configure MQTT Fan Switch

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/homeassistant/homeassistant-mqtt.md

Set up a switch entity in Home Assistant to control a fan via MQTT. This requires defining state and command topics, availability, and payload mappings.

```yaml
switch:
  - platform: mqtt
    name: 'Fan Switch'
    state_topic: 'zwave/bathroom_fan/37/0/currentValue'
    command_topic: 'zwave/bathroom_fan/37/0/targetValue/set'
    availability_topic: 'zwave/bathroom_fan/status'
    payload_available: 'true'
    payload_not_available: 'false'
    payload_on: 'true'
    payload_off: 'false'
    state_on: 'true'
    state_off: 'false'
    optimistic: false
    qos: 0
    retain: true
```

--------------------------------

### Create Plugin Directory in Docker

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/plugins.md

Command to create a directory for plugins within the Z-Wave JS UI Docker store volume. This is a prerequisite for using local plugins in a Dockerized environment.

```bash
mkdir -p /path/to/your/store/plugins
```

--------------------------------

### Configure Plugin Path in UI (Docker)

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/plugins.md

Specifies the path to enter in the Z-Wave JS UI settings to load a local plugin when running in Docker. This path must be relative to the container's filesystem.

```text
/usr/src/app/store/plugins/zwavejs-prom
```

--------------------------------

### Backup NVM Raw Data

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/usage/driver_function.md

This snippet demonstrates how to back up the raw NVM data from the Z-Wave controller. It requires the 'fs-extra' module and app configuration for the store directory. The backup is saved as 'NVM.bin'.

```javascript
const fs = this.require('fs-extra')
const { storeDir } = this.require('../config/app')
const data = await driver.controller.backupNVMRaw()
await fs.writeFile(storeDir + '/NVM.bin', data, 'binary')
```

--------------------------------

### Run Z-Wave JS UI with Docker (Volume Persistence)

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/getting-started/quick-start.md

Use this command to run Z-Wave JS UI with Docker, utilizing named volumes for data persistence. Ensure you replace the placeholder with your Z-Wave stick's serial device.

```bash
# Using volumes as persistence
docker run --rm -it -p 8091:8091 -p 3000:3000 --device=/dev/serial/by-id/insert_stick_reference_here:/dev/zwave \
--mount source=zwave-js-ui,target=/usr/src/app/store zwavejs/zwave-js-ui:latest
```

--------------------------------

### _setScenes

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Imports scenes Array in scenes.json.

```APIDOC
## MQTT Topic: zwave/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/api/_setScenes/set

### Description
Imports scenes Array in scenes.json.

### Request Body
- **args** (array) - Required - [scenes (ZUIScene[])]
```

--------------------------------

### Check Overall Health with wget

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/healthcheck.md

Use this command to check if both the MQTT and Z-Wave clients are connected. Requires the 'Accept: text/plain' header.

```bash
wget --no-verbose --spider --no-check-certificate --header "Accept: text/plain" http://localhost:8091/health
```

--------------------------------

### Clone Local Repositories for Custom Build

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/development/custom-docker.md

Clone node-zwave-js and zwave-js-ui repositories locally to customize branches or code before building a Docker image.

```bash
mkdir -p testing && cd testing
git clone https://github.com/zwave-js/node-zwave-js
git clone https://github.com/zwave-js/zwave-js-ui
## Checkout repos to any branch/commit you need to test
cd ../node-zwave-js
git checkout <branch, sha or tag>
cd zwave-js-ui
git checkout <branch, sha or tag>
cd ..

```

--------------------------------

### _createScene

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Creates a new scene with a specific label and stores it in scenes.json.

```APIDOC
## MQTT Topic: zwave/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/api/_createScene/set

### Description
Creates a new scene with a specific label and stores it in scenes.json.

### Request Body
- **args** (array) - Required - [label (string)]
```

--------------------------------

### Run All Tests

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/CLAUDE.md

Executes all defined tests in the project. Essential for verifying code correctness.

```bash
npm run test           # Run all tests
```

--------------------------------

### Set Value

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Sets a device value via MQTT.

```APIDOC
## MQTT Topic: zwave/<location>/<node_name>/<command_class>/<endpoint>/<value_id>/set

### Description
Writes a value to a specific Z-Wave device property.

### Request Body
- **value** (any) - Required - The value to set.
- **options** (object) - Optional - Additional options like `transitionDuration` or `volume`.
```

--------------------------------

### Set Value via MQTT

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Standard payload format for setting a device value by publishing to the /set topic.

```json
{
	"value": 100
}
```

--------------------------------

### Configure Docsify for Z-Wave JS UI

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/index.html

This snippet shows how to configure the Docsify documentation generator for the Z-Wave JS UI project. It sets the project name, repository link, sidebar loading, maximum subheading level, search namespace, and copy-to-clipboard settings.

```javascript
window.$docsify = {
  name: 'Z-Wave JS UI',
  repo: 'https://github.com/zwave-js/zwave-js-ui',
  loadSidebar: true,
  subMaxLevel: 3,
  search: {
    namespace: 'zwave-js-ui',
  },
  copyCode: {
    buttonText: 'Copy to clipboard',
    errorText: 'Error',
    successText: 'Copied'
  },
  plugins: [
    EditOnGithubPlugin.create('https://github.com/zwave-js/zwave-js-ui/blob/master/docs/', null, null)
  ],
  'flexible-alerts': {
    style: 'flat'
  }
}
```

--------------------------------

### Sync Node Date and Time via MQTT

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

Sets the date and time on a node using supported Command Classes.

```ts
syncNodeDateAndTime(nodeId: number, date = new Date()): Promise<boolean>;
```

```json
{
	"args": [
		nodeId,
		date
	]
}
```

--------------------------------

### MQTT API Execution

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/guide/mqtt.md

General pattern for executing Z-Wave APIs via MQTT by publishing a JSON payload to the API topic.

```APIDOC
## MQTT API Call

### Description
Execute a Z-Wave API method by publishing a JSON object containing the arguments to the corresponding MQTT topic.

### Topic
`<mqtt_prefix>/_CLIENTS/ZWAVE_GATEWAY-<mqtt_name>/api/<api_name>/set`

### Request Body
- **args** (array) - Required - An array containing the arguments for the API call in order.

### Request Example
{
  "args": [2, 1]
}
```

--------------------------------

### Docker Compose Configuration for Z-Wave JS UI

Source: https://github.com/zwave-js/zwave-js-ui/blob/master/docs/getting-started/docker.md

This Docker Compose configuration sets up Z-Wave JS UI to run as a persistent service. It maps ports, defines devices, and uses a named volume for data storage. Uncomment the TZ environment variable to set your timezone.

```yaml
version: '3.7'
services:
    zwave-js-ui:
        container_name: zwave-js-ui
        image: zwavejs/zwave-js-ui:latest
        restart: always
        tty: true
        stop_signal: SIGINT
        environment:
            - SESSION_SECRET=mysupersecretkey
            # Uncomment if you want log times and dates to match your timezone instead of UTC
            # Available at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
            #- TZ=America/New_York
        networks:
            - zwave
        devices:
            # Do not use /dev/ttyUSBX serial devices, as those mappings can change over time.
            # Instead, use the /dev/serial/by-id/X serial device for your Z-Wave stick.
            - '/dev/serial/by-id/insert_stick_reference_here:/dev/zwave'
        volumes:
            - zwave-config:/usr/src/app/store
        # Or by using local folder
        # - ./store:/usr/src/app/store
        ports:
            - '8091:8091' # port for web interface
            - '3000:3000' # port for Z-Wave JS websocket server
networks:
    zwave:
volumes:
    zwave-config:
        name: zwave-config
```
Tokens:
Raw