nayrnet/node-domoticz-mqtt


NodeJS Domoticz-MQTT Module

License: GPL-3.0

Language: JavaScript


node-domoticz-mqtt

GPL-3.0 npm node

NodeJS Module for communication with Domoticz via MQTT Interface.

Example:

#!/usr/bin/nodejs
var mqtt    = require('node-domoticz-mqtt');

// Options:
var options = {
    idx:        [ 1, 2, 3, 4 ],
    host:       'localhost',
    request:    true,
    log:        false
};

var domoticz = new mqtt.domoticz(options);

// Log anything matching our IDX
domoticz.on('data', function(data) {
    message = JSON.stringify(data)
    console.log(message.toString());
});

// Set IDX #1 to ON after connection and log our connection.
domoticz.on('connect', function() {
    domoticz.switch(1,100);
    domoticz.log('My example app connected.');
});

Functions:

// Callback for any devices from options. Data is json format.
domoticz.on('data', function(data){  });

// Callback on connect
domoticz.on('connect', function(){  });

// Callback on error
domoticz.on('error', function(error){  });

// Publish Switch:  level commands: 0 = Off/255 = On/-1 = Toggle/1-100 = Set Level
domoticz.switch(idx,level);

// Publish Contact Switch Open/Close:
domoticz.switchContact(idx,boolean);

// Publish uDevice: nvalue = int, svalue = string
domoticz.device(idx,nvalue,svalue);

// Publish Scene: cmd is optional, use "Off" for groups.
domoticz.scene(idx,cmd);

// Publish User Variable
domoticz.uservar(idx,value);

// Publish Domoticz Log Status
domoticz.log(message);

// Publish Notification: priority and sound are optional
domoticz.notify(subject,body,priority,sound);

// Request Device Status
domoticz.request(idx);

Options

  • idx - an array of device idx to watch and update on connect. defaults to none.
  • status - MQTT Path for reporting your app is online, optional.
  • host - Host of your MQTT Broker, defaults to localhost.
  • request - booolean to request updates for all IDX on connect, defaults to true.
  • log - boolean to show detailed logs, defaults to false.

More

About:

By: Ryan Hunt

Project Statistics

Sourcerank 3
Repository Size 29.3 KB
Stars 10
Forks 4
Watchers 4
Open issues 1
Dependencies 1
Contributors 1
Tags 0
Created
Last updated
Last pushed

Top Contributors See all

Ryan Hunt

Packages Referencing this Repo

node-domoticz-mqtt
Domoticz-MQTT Module
Latest release 1.2.2 - Updated - 10 stars

Something wrong with this page? Make a suggestion

Last synced: 2016-05-28 04:41:33 UTC

Login to resync this repository