npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

node-zway

v0.2.3

Published

Node JS interface for Z-Way (Razberry)

Downloads

10

Readme

Z-Way Client

Client library for the Z-Way Device API, allows for easy polling for changes, running commands, and events.

Overview

Initializing

var zway = require('node-zway');

// without password
var deviceApi = new zway.DeviceApi('192.168.0.123');

// with password
var deviceApi = new zway.DeviceApi({ host: '192.168.0.123', user: 'admin', password: 'mypass' });

Manually Refreshing

deviceApi.refresh()
.then(() => {
    console.log('Done!');
});

Polling

Rather than manually refreshing for updates you can just start polling at a defined interval.

var interval = 1000; // ms
deviceApi.poll(interval);

Events

The main reason to poll is to receive events. The client uses EventEmitter2 that supports wildcard events. The event format is device_id.command_class_id.eventname.

deviceApi.on('5.98.*', data => {
    console.log('event data:', data);
});

For debugging:

deviceApi.onAny(() => {
    console.log('event data:', data);
});

Reading Device Data

var device1 = deviceApi.getDevice(1, 98);
console.log(device1.DoorLock.get('mode'));

Running Device Commands

var device1 = deviceApi.getDevice(1, 98);
console.log(device1.DoorLock.lock());

Command Class Info

37 - SwitchBinary

Commands:

  • activate();
  • deactivate();
  • toggle();
  • refresh();

Queries:

  • TODO: isActivated();

48 - SensorBinary

Events:

  • onChange();

Queries:

  • getItems();

49 - SensorMultilevel

Commands:

  • refresh();

Events:

  • onChange();

Queries:

  • getItems();

98 - DoorLock

Commands:

  • lock();
  • unlock();
  • refresh();

Queries:

  • isLocked();

113 - Alarm

Events:

  • on();

Notes

Have also looked at using the JS API (/ZAutomation) but the authentication system for this is limited and impractical.

TODO

  • Make it more flexible to reference everything by either command class name or ID (decimal or hex).
  • Add more command class info