Merge pull request #166 from nfarina/home-assistant

Home Assistant Shim

README.md

@@ -11,7 +11,7 @@ Since Siri supports devices added through HomeKit, this means that with Homebrid
  * _Siri, turn off the Speakers._ ([Sonos](http://www.sonos.com))
  * _Siri, turn on the Dehumidifier._ ([WeMo](http://www.belkin.com/us/Products/home-automation/c/wemo-home-automation/))
  * _Siri, turn on Away Mode._ ([Xfinity Home](http://www.comcast.com/home-security.html))
- * _Siri, turn on the living room lights._ ([Wink](http://www.wink.com), [SmartThings](http://www.smartthings.com), [X10](http://github.com/edc1591/rest-mochad), [Philips Hue](http://meethue.com), [LimitlessLED/MiLight/Easybulb](http://www.limitlessled.com/), [LIFx](http://www.lifx.com/))
+ * _Siri, turn on the living room lights._ ([Wink](http://www.wink.com), [SmartThings](http://www.smartthings.com), [X10](http://github.com/edc1591/rest-mochad), [Philips Hue](http://meethue.com), [Home Assistant](http://home-assistant.io) [LimitlessLED/MiLight/Easybulb](http://www.limitlessled.com/), [LIFx](http://www.lifx.com/))
  * _Siri, set the movie scene._ ([Logitech Harmony](http://myharmony.com/))
 
 If you would like to support any other devices, please write a shim and create a pull request and I'd be happy to add it to this official list.

config-sample.json

@@ -89,6 +89,12 @@
             "delay": 30,
             "repeat": 3,
             "zones":["Kitchen Lamp","Bedroom Lamp","Living Room Lamp","Hallway Lamp"]
+         },
+         {
+             "platform": "HomeAssistant",
+             "name": "HomeAssistant",
+             "host": "http://192.168.1.10:8123",
+             "password": "XXXXX"
          }
     ],
 

platforms/HomeAssistant.js

@@ -0,0 +1,304 @@
+// Home Assistant
+//
+// Current Support: lights
+//
+// This is a shim to publish lights maintained by Home Assistant.
+// Home Assistant is an open-source home automation platform.
+// URL:     http://home-assistant.io
+// GitHub:  https://github.com/balloob/home-assistant
+//
+// Remember to add platform to config.json. Example:
+// "platforms": [
+//    {
+//        "platform": "HomeAssistant",
+//        "name": "HomeAssistant",
+//        "host": "http://192.168.1.50:8123",
+//        "password": "xxx"
+//    }
+// ]
+//
+// When you attempt to add a device, it will ask for a "PIN code".
+// The default code for all HomeBridge accessories is 031-45-154.
+
+var Service = require("HAP-NodeJS").Service;
+var Characteristic = require("HAP-NodeJS").Characteristic;
+var url = require('url')
+var request = require("request");
+
+var communicationError = new Error('Can not communicate with Home Assistant.')
+
+function HomeAssistantPlatform(log, config){
+
+  // auth info
+  this.host = config["host"];
+  this.password = config["password"];
+
+  this.log = log;
+}
+
+HomeAssistantPlatform.prototype = {
+  _request: function(method, path, options, callback) {
+    var self = this
+    var requestURL = this.host + '/api' + path
+    options = options || {}
+    options.query = options.query || {}
+
+    var reqOpts = {
+      url: url.parse(requestURL),
+      method: method || 'GET',
+      qs: options.query,
+      body: JSON.stringify(options.body),
+      headers: {
+        'Accept': 'application/json',
+        'Content-Type': 'application/json',
+        'x-ha-access': this.password
+      }
+    }
+
+    request(reqOpts, function onResponse(error, response, body) {
+      if (error) {
+        callback(error, response)
+        return
+      }
+
+      if (response.statusCode === 401) {
+        callback(new Error('You are not authenticated'), response)
+        return
+      }
+
+      json = JSON.parse(body)
+      callback(error, response, json)
+    })
+
+  },
+  fetchState: function(entity_id, callback){
+    this._request('GET', '/states/' + entity_id, {}, function(error, response, data){
+      if (error) {
+        callback(null)
+      }else{
+        callback(data)
+      }
+    })
+  },
+  callService: function(domain, service, service_data, callback){
+    var options = {}
+    options.body = service_data
+
+    this._request('POST', '/services/' + domain + '/' + service, options, function(error, response, data){
+      if (error) {
+        callback(null)
+      }else{
+        callback(data)
+      }
+    })
+  },
+  accessories: function(callback) {
+    this.log("Fetching HomeAssistant devices.");
+
+    var that = this;
+    var foundAccessories = [];
+    var lightsRE = /^light\./i
+    var switchRE = /^switch\./i
+
+
+    this._request('GET', '/states', {}, function(error, response, data){
+
+      for (var i = 0; i < data.length; i++) {
+        entity = data[i]
+        var accessory = null
+
+        if (entity.entity_id.match(lightsRE)) {
+          accessory = new HomeAssistantLight(that.log, entity, that)
+        }else if (entity.entity_id.match(switchRE)){
+          accessory = new HomeAssistantSwitch(that.log, entity, that)
+        }
+
+        if (accessory) {
+          foundAccessories.push(accessory)
+        }
+      }
+
+      callback(foundAccessories)
+    })
+
+  }
+}
+
+function HomeAssistantLight(log, data, client) {
+  // device info
+  this.domain = "light"
+  this.data = data
+  this.entity_id = data.entity_id
+  if (data.attributes && data.attributes.friendly_name) {
+    this.name = data.attributes.friendly_name
+  }else{
+    this.name = data.entity_id.split('.').pop().replace(/_/g, ' ')
+  }
+
+  this.client = client
+  this.log = log;
+}
+
+HomeAssistantLight.prototype = {
+  getPowerState: function(callback){
+    this.log("fetching power state for: " + this.name);
+
+    this.client.fetchState(this.entity_id, function(data){
+      if (data) {
+        powerState = data.state == 'on'
+        callback(null, powerState)
+      }else{
+        callback(communicationError)
+      }
+    }.bind(this))
+  },
+  getBrightness: function(callback){
+    this.log("fetching brightness for: " + this.name);
+
+    this.client.fetchState(this.entity_id, function(data){
+      if (data && data.attributes) {
+        brightness = ((data.attributes.brightness || 0) / 255)*100
+        callback(null, brightness)
+      }else{
+        callback(communicationError)
+      }
+    }.bind(this))
+  },
+  setPowerState: function(powerOn, callback) {
+    var that = this;
+    var service_data = {}
+    service_data.entity_id = this.entity_id
+
+    if (powerOn) {
+      this.log("Setting power state on the '"+this.name+"' to on");
+
+      this.client.callService(this.domain, 'turn_on', service_data, function(data){
+        if (data) {
+          that.log("Successfully set power state on the '"+that.name+"' to on");
+          callback()
+        }else{
+          callback(communicationError)
+        }
+      }.bind(this))
+    }else{
+      this.log("Setting power state on the '"+this.name+"' to off");
+
+      this.client.callService(this.domain, 'turn_off', service_data, function(data){
+        if (data) {
+          that.log("Successfully set power state on the '"+that.name+"' to off");
+          callback()
+        }else{
+          callback(communicationError)
+        }
+      }.bind(this))
+    }
+  },
+  setBrightness: function(level, callback) {
+    var that = this;
+    var service_data = {}
+    service_data.entity_id = this.entity_id
+
+    service_data.brightness = 255*(level/100.0)
+
+    this.log("Setting brightness on the '"+this.name+"' to " + level);
+
+    this.client.callService(this.domain, 'turn_on', service_data, function(data){
+      if (data) {
+        that.log("Successfully set brightness on the '"+that.name+"' to " + level);
+        callback()
+      }else{
+        callback(communicationError)
+      }
+    }.bind(this))
+  },
+  getServices: function() {
+    var lightbulbService = new Service.Lightbulb();
+
+    lightbulbService
+      .getCharacteristic(Characteristic.On)
+      .on('get', this.getPowerState.bind(this))
+      .on('set', this.setPowerState.bind(this));
+
+    lightbulbService
+      .addCharacteristic(Characteristic.Brightness)
+      .on('get', this.getBrightness.bind(this))
+      .on('set', this.setBrightness.bind(this));
+
+    return [lightbulbService];
+  }
+
+}
+
+function HomeAssistantSwitch(log, data, client) {
+  // device info
+  this.domain = "switch"
+  this.data = data
+  this.entity_id = data.entity_id
+  if (data.attributes && data.attributes.friendly_name) {
+    this.name = data.attributes.friendly_name
+  }else{
+    this.name = data.entity_id.split('.').pop().replace(/_/g, ' ')
+  }
+
+  this.client = client
+  this.log = log;
+}
+
+HomeAssistantSwitch.prototype = {
+  getPowerState: function(callback){
+    this.log("fetching power state for: " + this.name);
+
+    this.client.fetchState(this.entity_id, function(data){
+      if (data) {
+        powerState = data.state == 'on'
+        callback(null, powerState)
+      }else{
+        callback(communicationError)
+      }
+    }.bind(this))
+  },
+  setPowerState: function(powerOn, callback) {
+    var that = this;
+    var service_data = {}
+    service_data.entity_id = this.entity_id
+
+    if (powerOn) {
+      this.log("Setting power state on the '"+this.name+"' to on");
+
+      this.client.callService(this.domain, 'turn_on', service_data, function(data){
+        if (data) {
+          that.log("Successfully set power state on the '"+that.name+"' to on");
+          callback()
+        }else{
+          callback(communicationError)
+        }
+      }.bind(this))
+    }else{
+      this.log("Setting power state on the '"+this.name+"' to off");
+
+      this.client.callService(this.domain, 'turn_off', service_data, function(data){
+        if (data) {
+          that.log("Successfully set power state on the '"+that.name+"' to off");
+          callback()
+        }else{
+          callback(communicationError)
+        }
+      }.bind(this))
+    }
+  },
+  getServices: function() {
+    var switchService = new Service.Switch();
+
+    switchService
+      .getCharacteristic(Characteristic.On)
+      .on('get', this.getPowerState.bind(this))
+      .on('set', this.setPowerState.bind(this));
+
+    return [switchService];
+  }
+
+}
+
+module.exports.accessory = HomeAssistantLight;
+module.exports.accessory = HomeAssistantSwitch;
+module.exports.platform = HomeAssistantPlatform;