homie-device/lib/homieNode.js

Homie Device for NodeJS

var _ = require('lodash');
var HomieProperty = require('./homieProperty');
var EventEmitter = require('events').EventEmitter;

var HomieNode = module.exports = function (homieDevice, name, friendlyName, type, startRange, endRange) {
  var t = this;
  t.props = {};
  t.name = name;
  t.type = type;
  t.friendlyName = friendlyName;
  t.homieDevice = homieDevice;
  t.mqttTopic = t.homieDevice.mqttTopic + '/' + t.name;
  t.isRange = false;
  if (startRange !== undefined && endRange !== undefined) {
    t.isRange = true;
    t.startRange = startRange;
    t.endRange = endRange;
  }
}

require('util').inherits(HomieNode, EventEmitter);
var proto = HomieNode.prototype;

proto.advertise = function (propName) {
  var t = this;
  return t.props[propName] = new HomieProperty(t, propName);
}

// Called on mqtt client connect
proto.onConnect = function () {
  var t = this;
  var mqttClient = t.homieDevice.mqttClient;

  // Announce properties to MQTT
  mqttClient.publish(t.mqttTopic + '/$type', t.type, {retain: true});
  mqttClient.publish(t.mqttTopic + '/$name', t.friendlyName, {retain: true});

  var ads = [];
  _.each(t.props, function (prop) {
    ads.push(prop.name);
  })
  mqttClient.publish(t.mqttTopic + '/$properties', ads.join(','), {retain: true});

  if (t.isRange) {
    mqttClient.publish(t.mqttTopic + '/$array', t.startRange + '-' + t.endRange, {retain: true});
  }

  _.each(t.props, function (prop) {
    prop.onConnect();
  })

  t.emit('connect');
}

// Called on mqtt client disconnect
proto.onDisconnect = function () {
  var t = this;
  t.emit('disconnect');
}

// Called on every stats interval
proto.onStatsInterval = function () {
  var t = this;
  t.emit('stats-interval');
}

// This name isn't very good (should be getProperty), but it matches the esp8266 homie implementation
proto.setProperty = proto.getProperty = function (propName) {
  var t = this;
  return t.props[propName];
}