domoticz.js

/*
 This module handles the communication with Domoticz
 */
// TODO allow overriding auto generated idx

// https://www.npmjs.com/package/mqtt
var mqtt = require('mqtt');
var mqttOpts = {
  connectTimeout: 5 * 1000 // Time out after 5 seconds
};

// https://github.com/najaxjs/najax
var najax = require('najax');

var MQTT_HARDWARE = 43;
    
// Constants with names of Virtual Sensor devices used for Landroid 
var DEVICE_NAME_PREFIX = "Worx Landroid ";
var BATTERY_PERCENT_DEVICE_NAME = DEVICE_NAME_PREFIX + "Battery"; 
var TOTAL_MOWING_HOURS_DEVICE_NAME = DEVICE_NAME_PREFIX + "Mowing Hours";
var NO_OF_ALARMS_DEVICE_NAME = DEVICE_NAME_PREFIX + "No Of Alarms";
var ALERT_DEVICE_NAME = DEVICE_NAME_PREFIX + "Alert";
var MESSAGE_DEVICE_NAME = DEVICE_NAME_PREFIX + "Message";

// Constants for sensor types, see https://www.domoticz.com/wiki/Domoticz_API/JSON_URL%27s#Create_a_Virtual_Sensor
var TYPE_PERCENTAGE = 2;
var TYPE_TEXT = 5;
var TYPE_ALERT = 7;
var TYPE_RFXMETER = 113; // Subtype counter is hard coded

var ALL_DEVICES = {};
ALL_DEVICES[BATTERY_PERCENT_DEVICE_NAME] = TYPE_PERCENTAGE;
ALL_DEVICES[TOTAL_MOWING_HOURS_DEVICE_NAME] = TYPE_RFXMETER;
ALL_DEVICES[NO_OF_ALARMS_DEVICE_NAME] = TYPE_RFXMETER;
ALL_DEVICES[ALERT_DEVICE_NAME] = TYPE_ALERT;
ALL_DEVICES[MESSAGE_DEVICE_NAME] = TYPE_TEXT;

var AlertLevel = {
  GRAY: 0,
  GREEN: 1,
  YELLOW: 2,
  ORANGE: 3,
  RED: 4
};

function Domoticz(options) {
  if(options) {
    this.mqttBrokerUrl = options.mqttBrokerUrl;
    this.domoticzUrl = options.domoticzUrl;
  }
  this.idxByName = {};
}

/** Connect to MTTQ broker */
Domoticz.prototype.connect = function (callback) {
  console.log("Connecting to MQTT broker at " + this.mqttBrokerUrl + "...");
  this.client = mqtt.connect(this.mqttBrokerUrl, mqttOpts);
  this.client.on('connect', function() {
    console.log("Connected to MQTT broker");
    callback();
  });
};

/** 
 * Send battery percentage to Domoticz via MQTT
 * @param name Name of device to update
 * @param svalue The string value to send
 * @param nvalue Optional numeric value to send
 * */
Domoticz.prototype.sendValue = function(name, svalue, nvalue) {
  var idx = this.idxByName[name];
  if(! idx)
    throw ("No idx for " + name);
  
  var message = {
    "idx": idx,
    "nvalue": nvalue ? nvalue : 0,
    "svalue": (typeof svalue != "undefined") ? svalue.toString() : ""
  };

  this.client.publish('domoticz/in', JSON.stringify(message), /* mqttOpts, */ function () {
    // console.log("Done publishing " + JSON.stringify(message) + " to idx " + idx );
  });
};

/**
 * Make AJAX call to Domoticz
 * @param query
 * @param callback
 */
Domoticz.prototype.ajax = function(query, callback) {
  if(! this.domoticzUrl)
    throw "domoticzUrl must be set";

  var self = this;
  najax({
      url: self.domoticzUrl + "/json.htm?" + query,
      dataType: "json",
      success: function(response) {
        if(! self.isResponseOk(response))
          console.error("Response to " + query + ": " + JSON.stringify(response));// Enable for more logging
        // else console.log("Response to " + query + ": " + JSON.stringify(response));// Enable for more logging
        callback(response);
      },
      error: function (response) {
        console.error("Error communicating with Domoticz");
      }  
    });
};

/** Check if JSON response seems ok */
Domoticz.prototype.isResponseOk = function (response) {
  return response && response.status == "OK";
};

/** Prepare Domoticz by adding MQTT broker as hardware */
Domoticz.prototype.initHardware = function (name, server, port) {
  
  var self = this;

  this.ajax("type=hardware", function(response) {
    var matchingHardware;

    if(self.isResponseOk(response) && response.result) {
      response.result.forEach(function(hardware) {
        if(hardware.Type == MQTT_HARDWARE) {
          // console.log("MQTT hardware: " + JSON.stringify(hardware));
          if(hardware.Address == server && hardware.Port == port) {
            matchingHardware = hardware;
          }
        }
      });
    }
    
    if(typeof matchingHardware == "undefined") {
      console.log("Adding MQTT as Domoticz hardware");

      self.ajax("type=command&param=addhardware&enabled=true&htype=" + MQTT_HARDWARE + "&name=" + encodeURIComponent(name) + 
                "&address=" + server + "&port=" + port, function(response) {
        if(self.isResponseOk(response)) {
          console.log("Successfully added MQTT broker as Domoticz hardware: '" + name + "' @ " + server + ":" + port);
        }
      });
    }
    else
      console.log("MQTT hardware found in Domoticz");
  });
};

/** Get the devices defined in Domoticz */
Domoticz.prototype.getDevices = function(callback) {
  this.ajax("type=devices&filter=all", function(response) {
    callback(response ? response.result : null);
  });
};

Domoticz.prototype.getIdxToDevice = function (callback) {
  var self = this;
  this.getDevices(function(devices) {
    var output = {}; // Map from Idx to device name will be the output

    if(devices) {
      devices.forEach(function (device) {
        output[device.idx] = device;
      });
      callback(output);
    }
    else {
      callback(null);
    }
  });
}; 

/** Find or create Domoticz Virtual Sensor Devices to be used */
Domoticz.prototype.initDevices = function(callback) {
  console.log("Initializing devices on " + this.domoticzUrl);
  
  var self = this;
  
  this.getIdxToDevice(function (idxToDevice) {
    if(idxToDevice) {
      // console.log("All devices: " + JSON.stringify(idxToDevice));
      Object.keys(idxToDevice).forEach(function (idx) {
        self.idxByName[idxToDevice[idx].Name] = parseInt(idx);
      });

      console.log("Devices identified: " + JSON.stringify(self.idxByName));

    }
    else
      console.log("No existing devices found");

    self.createMissingDevices(0, idxToDevice, callback);
  });
};

Domoticz.prototype.createMissingDevices = function(index, idxToDevice, callback) {
  var self = this;
  
  // NOTE! That we must wait until the previous device has finished processing, or there will be conflicts

  var deviceNames = Object.keys(self.idxByName);
  var allDeviceNames = Object.keys(ALL_DEVICES);
  if(index < allDeviceNames.length) {
    var deviceName = allDeviceNames[index];
    console.log("Making sure device exists: " + deviceName);
    if(deviceNames.indexOf(deviceName) < 0) { // Does not exist
      console.log("Device missing, needs to be created: " + deviceName);
      
      self.createVirtualSensor(deviceName, function(idx) {
        self.idxByName[deviceName] = idx;
        self.setUsed(idx, deviceName);
        
        self.createMissingDevices(index + 1, idxToDevice); // Continue with next device
      });
    }
    else {
      var idx = self.idxByName[deviceName];
      if(! idxToDevice[idx].Used) {
        console.log("Device exists but needs to be used: " + deviceName);
        // console.log("Making sure idx " + idx + " '" + deviceName + "' is use");
        self.setUsed(idx, deviceName);
      }
      self.createMissingDevices(index + 1, idxToDevice, callback); // Continue with next device immediately, as there is no risk of mixup
    }
  }
  else { // We are done
    console.log("Done initializing Domoticz devices");
    if(callback)
      callback();    
  }
};

Domoticz.prototype.createVirtualSensor = function (name, callback) {
  var type = ALL_DEVICES[name];
  if(! type)
    throw "Cannot create device without type: " + name;

  var self = this;
  
  console.log("Creating device " + name + " with type " + type);
  
  // idx=0 causes auto generation of new idx
  this.ajax("type=createvirtualsensor&idx=0&sensortype=" + type + "&sensorname=" + encodeURIComponent(name), function (response) {
    if(! self.isResponseOk(response))
      throw "Error creating sensor '" + name + "': " + response.status;
    else {
      console.log("New device created, looking for its idx");
      self.getIdxToDevice(function(idxToDevice) {
        // console.log("Devices after create: " + JSON.stringify(idxToDevice));
        var idxToUse = -1;
        Object.keys(idxToDevice).forEach(function (idx) {
          idx = parseInt(idx);
          if(idxToDevice[idx].Name == "Unknown" || // Domoticz 2.x cannot set name during creation 
             idxToDevice[idx].Name == name) { // Domoticz 3.x will set name during creation
            if(idx > idxToUse) {
              console.log("Found '" + idxToDevice[idx].Name + "' device with idx: " + idx);
              idxToUse = idx;
            }
          }
        });
        
        console.log("New device for '" + name + "' idx: " + idxToUse);
        callback(idxToUse);
      });
    }
  });
};

/**
 * Make device in use and (re)set the name
 * @param idx
 * @param name
 */
Domoticz.prototype.setUsed = function (idx, name) {
  var self = this;
  var subtype = (ALL_DEVICES[name] == TYPE_RFXMETER) ? "&switchtype=3" : ""; // 3 = Counter
  self.ajax("type=setused&idx=" + idx + "&name=" + encodeURIComponent(name) + subtype + "&used=true", function(response) {
    // This seems to always return error, even though the intended operation is performed
    /*
    if(self.isResponseOk(response))
      console.log("Enabled idx " + idx + ": " + name);
    else
      console.error("Error making " + idx + " used");
    */
  });
};

Domoticz.prototype.setBatteryPercentage = function(batteryPercentage) {
  if(typeof batteryPercentage != "undefined")
    this.sendValue(BATTERY_PERCENT_DEVICE_NAME, batteryPercentage);
};

Domoticz.prototype.setTotalMowingHours = function(totalMowingHours) {
  if(typeof totalMowingHours != "undefined")
    this.sendValue(TOTAL_MOWING_HOURS_DEVICE_NAME, Math.round(totalMowingHours)); // Domoticz doesn't handle decimals in counters well
};

/*
Domoticz.prototype.setMessage = function(alertMessage) {
  this.sendValue(MESSAGE_DEVICE_NAME, alertMessage);
};
*/

Domoticz.prototype.setNoOfAlarms = function(noOfAlarms) {
  if(typeof noOfAlarms != "undefined")
    this.sendValue(NO_OF_ALARMS_DEVICE_NAME, noOfAlarms);
};

Domoticz.prototype.setError = function(error) {
  this.setAlert(AlertLevel.RED, error ? error : "Unknown error");
};

Domoticz.prototype.setAlert = function (level, message) {
  this.sendValue(ALERT_DEVICE_NAME, message, level);
  this.sendValue(MESSAGE_DEVICE_NAME, message);
};

module.exports = Domoticz;
module.exports.AlertLevel = AlertLevel;