Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

domoticz-api

Wifsimster65SEE LICENSE IN <LICENSE>1.0.9

Advanced api based on your current Domoticz api with well formated results ;)

domoticz, api

readme

JavaScript Domoticz API for Node.JS

A Node.JS module, which provides a simplified object oriented wrapper for the Domoticz API. No properties which begin with uppercase or a multitude of parameters !

This API can determine the specific type of your devices (WallPlug, PowerNode, ...).

Installation

      $ npm install domoticz-api      

Usage

Default usage :

var Domoticz = require('./api/domoticz');

var api = new Domoticz();

Or you can use params :

var Domoticz = require('./api/domoticz');

var api = new Domoticz({protocole: "https", host: "192.168.0.20", port: 8080, username: "wifsimster", password: "_password_"});

Get an existing device :

api.getDevice({
    idx: 134
}, function (error, device) {
    console.log(device);
});

Get all devices used :

api.getDevices({
    filter: 'all',
    used: 'true',
    order: 'Name'
}, function (error, devices) {
    console.log(devices);
});

Get the generic type of a device like Switch, Power, Thermometer, ...

console.log(api.getGenericType(device));

Get the number of device siblings, useful for OpenZWave devices

api.getNumberSiblings(device, function (count) {
    console.log(count + 'siblings found for this device !');
});

Licence

MIT license. See the LICENSE file for details.