Skip to content

Zwave js

services.zwave-js.enable

Whether to enable the zwave-js server on boot. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/zwave-js.nix

services.zwave-js.extraFlags

Extra flags to pass to command

Type: list of string

Default

[ ]

Example

["--mock-driver"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/zwave-js.nix

services.zwave-js.package

The zwave-js-server package to use. Type: package

Default

pkgs.zwave-js-server

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/zwave-js.nix

services.zwave-js.port

Port for the server to listen on.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

3000

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/zwave-js.nix

services.zwave-js.secretsConfigFile

JSON file containing secret keys. A dummy example:

{
  "securityKeys": {
    "S0_Legacy": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
    "S2_Unauthenticated": "BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB",
    "S2_Authenticated": "CCCCCCCCCCCCCCCCCCCCCCCCCCCCCCCC",
    "S2_AccessControl": "DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD"
  }
}

See https://zwave-js.github.io/node-zwave-js/#/getting-started/security-s2 for details. This file will be merged with the module-generated config file (taking precedence).

Z-Wave keys can be generated with:

{command}< /dev/urandom tr -dc A-F0-9 | head -c32 ;echo

::: {.warning} A file in the nix store should not be used since it will be readable to all users. :::

Type: path

Example

"/secrets/zwave-js-keys.json"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/zwave-js.nix

services.zwave-js.serialPort

Serial port device path for Z-Wave controller.

Type: path

Example

"/dev/ttyUSB0"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/zwave-js.nix

services.zwave-js.settings

Configuration settings for the generated config file.

Type: JSON value

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/zwave-js.nix

services.zwave-js.settings.storage.cacheDir

Cache directory Type: path

Default

"/var/cache/zwave-js"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/home-automation/zwave-js.nix