Nebulous Puffy Marshmallows

    @homenet/plugin-zway
    TypeScript icon, indicating that this package has built-in type declarations

    2.1.2 • Public • Published

    homenet-plugin-zway

    Z-Way plugin for controlling Z-Wave devices through a Z-Way controller.

    Note: currently only supports locks, and only tested on a Yale lock (other locks might work slightly differently). Sensors and binary switches coming soon.

    Registering the Plugin

    Use the loadPlugin method on the core runtime:

    const core = require('@homenet/core');
    const zwayPlugin = require('@homenet/plugin-zway');
    const runtime = core.init(RED, myConfig);
    runtime.loadPlugin(zwayPlugin.ZwayPluginLoader);
    runtime.start();

    Configuration

    In the configuration file create a zway.controllers key and register each Z-Way controller:

    {
      "zway": {
        "controllers": [
          { "id": "main", "host": "192.168.0.123", "port": 8083, "user": "admin", "password": "mysecretpasswd" }
        ]
      }
    }

    Classes

    Currently only the lock class for Homenet is implemented.

    To add an instance use the type zway.

    For options specify the Z-Way deviceId (should be an integer), and the ID of the controller registered above.

    {
      "instances": [
        { "class": "lock", "id": "front-door", "type": "zway", "options": { "deviceId": 3, "controller": "main" } }
      ]
    }

    Example Config

    {
      "instances": [
        { "class": "lock", "id": "front-door", "type": "zway", "options": { "deviceId": 3, "controller": "main" } }
      ],
      "zway": {
        "controllers": [
          { "id": "main", "host": "192.168.0.123", "port": 8083, "user": "admin", "password": "mysecretpasswd" }
        ]
      }
    }

    Install

    npm i @homenet/plugin-zway

    DownloadsWeekly Downloads

    2

    Version

    2.1.2

    License

    MIT

    Last publish

    Collaborators

    • denwilliams
    • homenet