homebridge-nhc-1 1.3.1

package/README.md

@@ -0,0 +1,19 @@
+# homebridge-nhc-1
+Homebridge plugin for Niko Home Control 1
+
+# Install
+     npm install -g homebridge-nhc-1
+
+[Configuration example](config.json)
+
+# Description
+
+This plugin load all your configuration from your local server Niko Home Control
+
+It manage `Lights`, `Dimmers` and `Blind`
+
+Blinds have a default time of 30s, this can be overridden for each one in config.
+
+It is possible to exclude IDs from accessories for scene by example.
+
+

package/index.js

@@ -0,0 +1,7 @@
+'use strict'
+
+const NikoHomeControlPlatform = require('./lib/NikoHomeControlPlatform')
+
+module.exports = function (homebridge) {
+  homebridge.registerPlatform('homebridge-nhc-1', 'NikoHomeControl', NikoHomeControlPlatform, true)
+}

package/lib/NikoHomeControlBlind.js

@@ -0,0 +1,179 @@
+'use strict';
+
+var BLIND_CMD_DOWN = 254;
+var BLIND_CMD_UP   = 255;
+var BLIND_CMD_STOP = 253;
+
+function NikoHomeControlBlind(platform, action = null) {
+    this.platform = platform;
+    this.Service = platform.api.hap.Service;
+    this.Characteristic = platform.api.hap.Characteristic;
+
+    var uuid = this.platform.api.hap.uuid.generate(action.name + action.id);
+    var foundAccessory = null;
+
+    this.platform.accessories.forEach((access) => {
+        if (access.UUID === uuid) {
+            foundAccessory = access;
+        }
+    });
+
+    if (foundAccessory === null) {
+        this.accessory = this.createAccessory(action);
+    } else {
+        this.accessory = foundAccessory;
+        this.updateAccessory(this.accessory, action);
+    }
+
+    this.accessory._id = action.id;
+
+    this.accessory.position = action.value1;
+    this.accessory.target = action.value1;
+    this.accessory.state = 2;
+
+    this.accessory.time = 30;
+
+    if (this.platform.config.time) {
+        this.platform.config.time.forEach((ActionTime) => {
+            if (ActionTime.id === action.id) {
+                this.accessory.time = ActionTime.time;
+            }
+        });
+    }
+
+    this.running = false;
+    this.timeout = null;
+}
+
+NikoHomeControlBlind.prototype.createAccessory = function(action) {
+    var uuid = this.platform.api.hap.uuid.generate(action.name + action.id);
+    var PlatformAccessory = this.platform.api.platformAccessory;
+
+    var accessory = new PlatformAccessory(action.name + action.id, uuid);
+
+    this.updateAccessory(accessory, action);
+
+    this.platform.accessories.push(accessory);
+    this.platform.api.registerPlatformAccessories("homebridge-nhc-1", "NikoHomeControl", [accessory]);
+
+    return accessory;
+}
+
+NikoHomeControlBlind.prototype.updateAccessory = function(accessory, action) {
+    accessory.on('identify', this.identify.bind(this));
+
+    var service = accessory.getService(accessory.displayName);
+
+    if (service == undefined) {
+        accessory.addService(this.Service.WindowCovering, accessory.displayName)
+    }
+
+    accessory.getService(accessory.displayName)
+        .getCharacteristic(this.Characteristic.PositionState)
+        .onGet(this.getState.bind(this))
+    ;
+
+    accessory.getService(accessory.displayName)
+        .getCharacteristic(this.Characteristic.CurrentPosition)
+        .onGet(this.getPosition.bind(this))
+    ;
+
+    accessory.getService(accessory.displayName)
+        .getCharacteristic(this.Characteristic.TargetPosition)
+        .onGet(this.getTarget.bind(this))
+        .onSet(this.setTarget.bind(this))
+        .on('change', this.changeTarget.bind(this))
+    ;
+}
+
+NikoHomeControlBlind.prototype.identify = function(callback) {
+    this.platform.log(this.accessory.displayName, "Identify!!!");
+    callback();
+}
+
+NikoHomeControlBlind.prototype.getState = function() {
+    this.platform.log("Get STATE " + this.accessory.displayName + " Blind -> " + this.accessory.state);
+    return this.accessory.state;
+}
+
+NikoHomeControlBlind.prototype.getPosition = function() {
+    this.platform.log("Get Position " + this.accessory.displayName + " Blind -> " + this.accessory.position);
+    return this.accessory.position;
+}
+
+NikoHomeControlBlind.prototype.getTarget = function() {
+    this.platform.log("Get Target " + this.accessory.displayName + " Blind -> " + this.accessory.target);
+    return this.accessory.target;
+}
+
+NikoHomeControlBlind.prototype.setTarget = function(value) {
+    this.accessory.target = value;
+
+    var cmd = this.accessory.target < this.accessory.position ? BLIND_CMD_DOWN : BLIND_CMD_UP;
+
+    this.running = true;
+    this.platform.niko.executeActions(this.accessory._id, cmd);
+    this.platform.log("Set Target " + this.accessory.displayName + " Blind -> " + this.accessory.target);
+}
+
+NikoHomeControlBlind.prototype.move = function() {
+    var that = this;
+    this.platform.log('move position => ', this.accessory.position, this.accessory.target);
+    var direction = this.accessory.target > this.accessory.position ? 1 : -1;
+
+    if (Math.abs(this.accessory.target - this.accessory.position) > 0) {
+        that.accessory.position += direction;
+        this.timeout = setTimeout(function(){
+            that.move();
+        }, this.accessory.time * 10);
+    } else {
+        this.platform.log('DONE');
+        this.running = false;
+        this.platform.niko.executeActions(this.accessory._id, BLIND_CMD_STOP);
+        this.accessory
+            .getService(this.accessory.displayName)
+            .getCharacteristic(this.Characteristic.CurrentPosition)
+            .updateValue(this.accessory.position);
+        this.accessory
+            .getService(this.accessory.displayName)
+            .getCharacteristic(this.Characteristic.PositionState)
+            .updateValue(2);
+    }
+}
+
+NikoHomeControlBlind.prototype.stop = function() {
+    if (this.timeout !== null) {
+        clearTimeout(this.timeout);
+        this.timeout = null;
+    }
+    this.running = false;
+}
+
+NikoHomeControlBlind.prototype.changeTarget = function(oldValue, newValue) {
+    this.platform.log('CHANGE Target');
+    if (newValue === undefined) {
+        return;
+    }
+
+    if (null === oldValue && false === this.running) {
+        this.accessory.position = newValue;
+        this.accessory.target = newValue;
+        this.accessory.state = 2;
+        this.accessory.getService(this.accessory.displayName).getCharacteristic(this.Characteristic.CurrentPosition).updateValue(this.accessory.position);
+        this.accessory.getService(this.accessory.displayName).getCharacteristic(this.Characteristic.TargetPosition).updateValue(this.accessory.target);
+        this.accessory.getService(this.accessory.displayName).getCharacteristic(this.Characteristic.PositionState).updateValue(this.accessory.state);
+
+        this.platform.log('EVENT');
+        return;
+    }
+
+    this.stop();
+    this.move();
+}
+
+NikoHomeControlBlind.prototype.changeValue = function(oldValue, newValue) {
+    this.platform.log('CHANGE VALUE', oldValue, newValue);
+    this.changeTarget(oldValue, newValue);
+}
+
+module.exports = NikoHomeControlBlind

package/lib/NikoHomeControlDimmer.js

@@ -0,0 +1,141 @@
+'use strict';
+
+function NikoHomeControlDimmer(platform, action = null) {
+  this.platform = platform;
+  this.Service = platform.api.hap.Service;
+  this.Characteristic = platform.api.hap.Characteristic;
+
+  var uuid = this.platform.api.hap.uuid.generate(action.name + action.id);
+  var foundAccessory = null;
+
+  this.platform.accessories.forEach((access) => {
+    if (access.UUID === uuid) {
+      foundAccessory = access;
+    }
+  });
+
+  if (foundAccessory === null) {
+    this.accessory = this.createAccessory(action);
+  } else {
+    this.accessory = foundAccessory;
+    this.updateAccessory(this.accessory, action);
+  }
+
+  this.accessory._id = action.id;
+  this.accessory.value = this.convertValue(action.value1);
+}
+
+NikoHomeControlDimmer.prototype.createAccessory = function(action) {
+  var uuid = this.platform.api.hap.uuid.generate(action.name + action.id);
+  var PlatformAccessory = this.platform.api.platformAccessory;
+
+  var accessory = new PlatformAccessory(action.name + action.id, uuid);
+
+  this.updateAccessory(accessory, action);
+
+  this.platform.accessories.push(accessory);
+  this.platform.api.registerPlatformAccessories("homebridge-nhc-1", "NikoHomeControl", [accessory]);
+
+  return accessory;
+}
+
+NikoHomeControlDimmer.prototype.updateAccessory = function(accessory, action) {
+  accessory.on('identify', this.identify.bind(this));
+
+  var service = accessory.getService(accessory.displayName);
+
+  if (service == undefined) {
+    accessory.addService(this.Service.Lightbulb, accessory.displayName)
+  }
+
+  accessory.getService(accessory.displayName)
+    .getCharacteristic(this.Characteristic.On)
+    .onGet(this.getValue.bind(this))
+    .onSet(this.setValue.bind(this))
+    .on('change', this.changeValue.bind(this))
+  ;
+
+  accessory.getService(accessory.displayName)
+    .getCharacteristic(this.Characteristic.Brightness)
+    .onGet(this.getBrightness.bind(this))
+    .onSet(this.setBrightness.bind(this))
+    .on('change', this.changeValue.bind(this))
+  ;
+}
+
+NikoHomeControlDimmer.prototype.convertValue = function(value1) {
+  if (value1 === true) {
+    return 100;
+  } else if (value1 === false) {
+    return 0;
+  }
+  return value1;
+}
+
+NikoHomeControlDimmer.prototype.identify = function(callback) {
+  this.platform.log(this.accessory.displayName, "Identify!!!");
+
+  var initialValue = this.accessory.value;
+  var that = this;
+
+  if (initialValue > 0) {
+    this.platform.niko.executeActions(this.accessory._id, 0);
+  } else {
+    this.platform.niko.executeActions(this.accessory._id, 100);
+  }
+
+  setTimeout(function() {
+    that.platform.niko.executeActions(that.accessory._id, initialValue);
+  }, 2000);
+
+  callback();
+}
+
+NikoHomeControlDimmer.prototype.getValue = function() {
+  this.platform.log("Get " + this.accessory.displayName + " Dimmer -> " + this.accessory.value);
+
+  return this.accessory.value > 0;
+}
+
+NikoHomeControlDimmer.prototype.setValue = function(value) {
+  if (value === true && this.accessory.value === 0) {
+    this.platform.niko.executeActions(this.accessory._id, 100);
+  } else if (value === false && this.accessory.value > 0) {
+    this.platform.niko.executeActions(this.accessory._id, 0);
+  }
+}
+
+NikoHomeControlDimmer.prototype.getBrightness = function() {
+  this.platform.log("Get Brightness " + this.accessory.displayName + " Dimmer -> " + this.accessory.value);
+
+  return this.accessory.value;
+}
+
+NikoHomeControlDimmer.prototype.setBrightness = function(value) {
+  this.accessory.value = value;
+
+  this.platform.niko.executeActions(this.accessory._id, value);
+  this.platform.log("Set Brightness " + this.accessory.displayName + " Dimmer -> " + this.accessory.value);
+}
+
+NikoHomeControlDimmer.prototype.changeValue = function(oldValue, newValue) {
+  if (newValue === undefined) {
+    return;
+  }
+
+  var value = this.convertValue(newValue);
+
+  if (this.accessory.value !== value) {
+    this.accessory.value = value;
+
+    this.platform.log("Change " + this.accessory.displayName + " Dimmer -> " + this.accessory.value);
+    this.accessory.getService(this.accessory.displayName).getCharacteristic(this.Characteristic.Brightness).updateValue(this.accessory.value);
+    if (value === 0) {
+      this.accessory.getService(this.accessory.displayName).getCharacteristic(this.Characteristic.On).updateValue(false);
+    } else {
+      this.accessory.getService(this.accessory.displayName).getCharacteristic(this.Characteristic.On).updateValue(true);
+    }
+  }
+}
+
+module.exports = NikoHomeControlDimmer

package/lib/NikoHomeControlLight.js

@@ -0,0 +1,109 @@
+'use strict';
+
+function NikoHomeControlLight(platform, action = null) {
+  this.platform = platform;
+  this.Service = platform.api.hap.Service;
+  this.Characteristic = platform.api.hap.Characteristic;
+
+  var uuid = this.platform.api.hap.uuid.generate(action.name + action.id);
+  var foundAccessory = null;
+
+  this.platform.accessories.forEach((access) => {
+    if (access.UUID === uuid) {
+      foundAccessory = access;
+    }
+  });
+
+  if (foundAccessory === null) {
+    this.accessory = this.createAccessory(action);
+  } else {
+    this.accessory = foundAccessory;
+    this.updateAccessory(this.accessory, action);
+  }
+
+  this.accessory._id = action.id;
+  this.accessory.value = this.convertValue(action.value1);
+}
+
+NikoHomeControlLight.prototype.createAccessory = function(action) {
+  var uuid = this.platform.api.hap.uuid.generate(action.name + action.id);
+  var PlatformAccessory = this.platform.api.platformAccessory;
+
+  var accessory = new PlatformAccessory(action.name + action.id, uuid);
+
+  this.updateAccessory(accessory, action);
+
+  this.platform.accessories.push(accessory);
+  this.platform.api.registerPlatformAccessories("homebridge-nhc-1", "NikoHomeControl", [accessory]);
+
+  return accessory;
+}
+
+NikoHomeControlLight.prototype.updateAccessory = function(accessory, action) {
+  accessory.on('identify', this.identify.bind(this));
+
+  var service = accessory.getService(accessory.displayName);
+
+  if (service == undefined) {
+    accessory.addService(this.Service.Lightbulb, accessory.displayName)
+  }
+
+  accessory.getService(accessory.displayName)
+    .getCharacteristic(this.Characteristic.On)
+    .onGet(this.getValue.bind(this))
+    .onSet(this.setValue.bind(this))
+    .on('change', this.changeValue.bind(this))
+  ;
+}
+
+NikoHomeControlLight.prototype.convertValue = function(value1) {
+  return value1 === 100;
+}
+
+NikoHomeControlLight.prototype.identify = function(callback) {
+  this.platform.log(this.accessory.displayName, "Identify!!!");
+
+  var that = this;
+  var initialValue = this.accessory.value;
+
+  if (initialValue === true) {
+    this.platform.niko.executeActions(this.accessory._id, 0);
+  } else {
+    this.platform.niko.executeActions(this.accessory._id, 100);
+  }
+
+  setTimeout(function() {
+    that.platform.niko.executeActions(that.accessory._id, initialValue ? 100 : 0);
+  }, 2000);
+
+  callback();
+}
+
+NikoHomeControlLight.prototype.getValue = function() {
+  this.platform.log("Get " + this.accessory.displayName + " Light -> " + this.accessory.value);
+
+  return this.accessory.value;
+}
+
+NikoHomeControlLight.prototype.setValue = function(value) {
+  this.accessory.value = value;
+
+  this.platform.niko.executeActions(this.accessory._id, value ? 100 : 0);
+  this.platform.log("Set " + this.accessory.displayName + " Light -> " + this.accessory.value);
+}
+
+NikoHomeControlLight.prototype.changeValue = function(oldValue, newValue) {
+  if (newValue === undefined) {
+    return;
+  }
+
+  var value = this.convertValue(newValue);
+
+  if (this.accessory.value !== value) {
+    this.accessory.value = value;
+    this.platform.log("Change " + this.accessory.displayName + " Light -> " + this.accessory.value);
+    this.accessory.getService(this.accessory.displayName).getCharacteristic(this.Characteristic.On).updateValue(this.accessory.value);
+  }
+}
+
+module.exports = NikoHomeControlLight

package/lib/NikoHomeControlPlatform.js

@@ -0,0 +1,112 @@
+'use strict';
+
+const niko = require('niko-home-control');
+
+var NikoHomeControlLight = require('./NikoHomeControlLight');
+var NikoHomeControlDimmer = require('./NikoHomeControlDimmer');
+var NikoHomeControlBlind = require('./NikoHomeControlBlind');
+
+module.exports = NikoHomeControlPlatform
+
+// Platform constructor
+// config may be null
+// api may be null if launched from old homebridge version
+function NikoHomeControlPlatform(log, config, api) {
+  log("NikoHomeControl Init");
+
+  this.accessories = [];
+  this.controllers = [];
+  this.niko = niko;
+
+  this.log = log;
+  this.config = config;
+
+  if (api) {
+      // Save the API object as plugin needs to register new accessory via this object
+      this.api = api;
+
+      // Listen to event "didFinishLaunching", this means homebridge already finished loading cached accessories.
+      // Platform Plugin should only register new accessory that doesn't exist in homebridge after this event.
+      // Or start discover new accessories.
+      this.api.on('didFinishLaunching', function() {
+        this.log("DidFinishLaunching");
+        this.run();
+      }.bind(this));
+  }
+}
+
+// Function invoked when homebridge tries to restore cached accessory.
+// Developer can configure accessory at here (like setup event handler).
+// Update current value.
+NikoHomeControlPlatform.prototype.configureAccessory = function(accessory) {
+  this.log(accessory.displayName, "Configure Accessory");
+  var platform = this;
+
+  this.accessories.push(accessory);
+}
+
+NikoHomeControlPlatform.prototype.run = function() {
+  this.log("Run");
+
+  if (!this.config.ip) {
+    this.log("ERROR: No IP address configured. Please add 'ip' to your config.json.");
+    return;
+  }
+
+  this.niko.init({
+    ip: this.config.ip,
+    port: 8000,
+    timeout: 2000,
+    events: true
+  });
+
+  niko.events.on('listactions', this.onEventAction.bind(this));
+
+  niko
+    .listActions()
+    .then(this.listActions.bind(this))
+    .catch((err) => {
+      this.log("Error connecting to Niko Home Control: " + err);
+      this.log("Retrying in 30 seconds...");
+      setTimeout(this.run.bind(this), 30000);
+    });
+}
+
+NikoHomeControlPlatform.prototype.listActions = function(response) {
+  var actions = response.data;
+
+  actions.forEach((action) => {
+    // exclude
+    if (this.config.exclude && this.config.exclude.indexOf(action.id) !== -1) {
+      return;
+    }
+
+    switch(action.type) {
+      case 1:
+        this.addAccessory(NikoHomeControlLight, null, action);
+        break;
+      case 2:
+        this.addAccessory(NikoHomeControlDimmer, null, action);
+        break;
+      case 4:
+        this.addAccessory(NikoHomeControlBlind, null, action);
+        break;
+      default:
+        this.log('UNKNOWN ' + action.name + ' type ' + action.type);
+    }
+  });
+}
+
+NikoHomeControlPlatform.prototype.addAccessory = function(className, accessory = null, action = null) {
+  this.log("Add " + action.name);
+  var controller = new className(this, action);
+  this.controllers[action.id] = controller;
+}
+
+NikoHomeControlPlatform.prototype.onEventAction = function(event) {
+  event.data.forEach((action) => {
+    if (this.controllers.hasOwnProperty(action.id)) {
+      this.controllers[action.id].changeValue(null, action.value1);
+    }
+  });
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "displayName": "Homebridge NikoHomeControl",
+  "name": "homebridge-nhc-1",
+  "version": "1.3.1",
+  "description": "Homebridge plugin for Niko Home Control",
+  "license": "MIT",
+  "keywords": [
+    "homebridge-plugin",
+    "Niko",
+    "Niko Home",
+    "Niko Home Control"
+  ],
+  "homepage": "https://github.com/hmodateresyc/homebridge-nhc-1#readme",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/hmodateresyc/homebridge-nhc-1.git"
+  },
+  "bugs": {
+    "url": "http://github.com/hmodateresyc/homebridge-nhc-1/issues"
+  },
+  "engines": {
+    "node": "^18.20.4 || ^20.15.1 || ^22",
+    "homebridge": "^1.6.0 || ^2.0.0"
+  },
+  "dependencies": {
+    "niko-home-control": "0.4.3"
+  },
+  "peerDependencies": {
+    "homebridge": "^1.6.0 || ^2.0.0"
+  }
+}