Update hap-nodejs to allow homebridge work with nodejs v4.x

This version requires node v5.10.0 or later.

README.md

@@ -29,7 +29,11 @@ You can also chat with us in our nascent [Slack instance](http://homebridge-slac
 
 Homebridge is published through [NPM](https://www.npmjs.com/package/homebridge) and should be installed "globally" by typing:
 
-    sudo npm install -g homebridge
+    sudo npm install -g --unsafe-perm homebridge
+
+You may need to use the `--unsafe-perm` flag if you receive an error similar to this:
+
+    gyp WARN EACCES user "root" does not have permission to access the dev dir "/root/.node-gyp/5.5.0"
 
 Now you should be able to run Homebridge:
 
@@ -45,9 +49,9 @@ Once you've installed a Plugin or two, you can run Homebridge again:
 
 However, Homebridge won't do anything until you've created a `config.json` file containing your accessories and/or platforms. You can start by copying and modifying the included `config-sample.json` file which includes declarations for some example accessories and platforms. Each Plugin will have its own expected configuration; the documentation for Plugins should give you some real-world examples for that plugin.
 
-**NOTE**: Your `config.json` file MUST live in your home directory inside `.homebridge`. The full error message will contain the exact path where your config is expected to be found.
+**NOTE**: Your `config.json` file MUST be inside of `.homebridge`, which is inside of your home folder.  On MacOS and Linux, the full path for your `config.json` would be `~/.homebridge/config.json`.  Any error messages will contain the exact path where your config is expected to be found.
 
-**REALLY IMPORTANT**: You must use a "plain text" editor to create or modify `config.json`. Do NOT use apps like TextEdit on Mac or Wordpad on Windows; these apps will corrupt the formatting of the file in hard-to-debug ways. I suggest using the free [Atom text editor](http://atom.io).
+**REALLY IMPORTANT**: You must use a "plain text" editor to create or modify `config.json`. Do NOT use apps like TextEdit on Mac or Wordpad on Windows.  Apps like these will corrupt the formatting of the file in hard-to-debug ways, making improper `"` signs is an example.  I suggest using the free [Atom text editor](http://atom.io).
 
 Once you've added your config file, you should be able to run Homebridge again:
 
@@ -79,15 +83,11 @@ You can explore all available plugins at the NPM website by [searching for the k
 
 # Adding Homebridge to iOS
 
-HomeKit is actually not an app; it's a "database" similar to HealthKit and PassKit. But where HealthKit has the companion _Health_ app and PassKit has _Passbook_, Apple has supplied no app for managing your HomeKit database (at least [not yet](http://9to5mac.com/2015/05/20/apples-planned-ios-9-home-app-uses-virtual-rooms-to-manage-homekit-accessories/)). However, the HomeKit API is open for developers to write their own apps for adding devices to HomeKit.
+HomeKit itself is actually not an app; it's a "database" similar to HealthKit and PassKit. Where HealthKit has the companion _Health_ app and PassKit has _Passbook_, HomeKit has the _Home_ app, introduced with iOS 10.
 
-Fortunately, there are now a few apps in the App Store that can manage your HomeKit devices. The most comprehensive one I've used is [MyTouchHome](https://itunes.apple.com/us/app/mytouchhome/id965142360?mt=8&at=11lvmd&ct=mhweb) which costs $2.
+If you are a member of the iOS developer program, you might also find Apple's [HomeKit Catalog](https://developer.apple.com/library/ios/samplecode/HomeKitCatalog/Introduction/Intro.html) app to be useful, as it provides straightforward and comprehensive management of all HomeKit database "objects".
 
-There are also some free apps that work OK. Try [Insteon+](https://itunes.apple.com/US/app/id919270334?mt=8) or [Lutron](https://itunes.apple.com/us/app/lutron-app-for-caseta-wireless/id886753021?mt=8) or a number of others.
+Using the Home app (or most other HomeKit apps), you should be able to add the single accessory "Homebridge", assuming that you're still running Homebridge and you're on the same Wifi network. Adding this accessory will automatically add all accessories and platforms defined in `config.json`.
-
-If you are a member of the iOS developer program, I highly recommend Apple's [HomeKit Catalog](https://developer.apple.com/library/ios/samplecode/HomeKitCatalog/Introduction/Intro.html) app, as it is reliable and comprehensive and free (and open source).
-
-Once you've gotten a HomeKit app running on your iOS device, it should "discover" the single accessory "Homebridge", assuming that you're still running Homebridge and you're on the same Wifi network. Adding this accessory will automatically add all accessories and platforms defined in `config.json`.
 
 When you attempt to add Homebridge, it will ask for a "PIN code". The default code is `031-45-154` (but this can be changed, see `config-sample.json`).
 

example-plugins/homebridge-samplePlatform/index.js

@@ -21,14 +21,15 @@ module.exports = function(homebridge) {
 // config may be null
 // api may be null if launched from old homebridge version
 function SamplePlatform(log, config, api) {
-  console.log("SamplePlatform Init");
+  log("SamplePlatform Init");
+  var platform = this;
   this.log = log;
   this.config = config;
   this.accessories = [];
 
   this.requestServer = http.createServer(function(request, response) {
     if (request.url === "/add") {
-      this.addAccessory();
+      this.addAccessory(new Date().toISOString());
       response.writeHead(204);
       response.end();
     }
@@ -47,7 +48,7 @@ function SamplePlatform(log, config, api) {
   }.bind(this));
 
   this.requestServer.listen(18081, function() {
-    console.log("Server Listening...");
+    platform.log("Server Listening...");
   });
 
   if (api) {
@@ -58,7 +59,7 @@ function SamplePlatform(log, config, api) {
       // 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() {
-        console.log("Plugin - DidFinishLaunching");
+        platform.log("DidFinishLaunching");
       }.bind(this));
   }
 }
@@ -67,7 +68,8 @@ function SamplePlatform(log, config, api) {
 // Developer can configure accessory at here (like setup event handler)
 // Update current value
 SamplePlatform.prototype.configureAccessory = function(accessory) {
-  console.log("Plugin - Configure Accessory: " + accessory.displayName);
+  this.log(accessory.displayName, "Configure Accessory");
+  var platform = this;
 
   // set the accessory to reachable if plugin can currently process the accessory
   // otherwise set to false and update the reachability later by invoking 
@@ -75,7 +77,7 @@ SamplePlatform.prototype.configureAccessory = function(accessory) {
   accessory.reachable = true;
 
   accessory.on('identify', function(paired, callback) {
-    console.log("Identify!!!");
+    platform.log(accessory.displayName, "Identify!!!");
     callback();
   });
 
@@ -83,7 +85,7 @@ SamplePlatform.prototype.configureAccessory = function(accessory) {
     accessory.getService(Service.Lightbulb)
     .getCharacteristic(Characteristic.On)
     .on('set', function(value, callback) {
-      console.log("Light -> " + value);
+      platform.log(accessory.displayName, "Light -> " + value);
       callback();
     });
   }
@@ -94,8 +96,8 @@ SamplePlatform.prototype.configureAccessory = function(accessory) {
 //Handler will be invoked when user try to config your plugin
 //Callback can be cached and invoke when nessary
 SamplePlatform.prototype.configurationRequestHandler = function(context, request, callback) {
-  console.log("Context: ", JSON.stringify(context));
+  this.log("Context: ", JSON.stringify(context));
-  console.log("Request: ", JSON.stringify(request));
+  this.log("Request: ", JSON.stringify(request));
 
   // Check the request response
   if (request && request.response && request.response.inputs && request.response.inputs.name) {
@@ -173,18 +175,15 @@ SamplePlatform.prototype.configurationRequestHandler = function(context, request
 
 // Sample function to show how developer can add accessory dynamically from outside event
 SamplePlatform.prototype.addAccessory = function(accessoryName) {
-  console.log("Add Accessory");
+  this.log("Add Accessory");
+  var platform = this;
   var uuid;
 
-  if (!accessoryName) {
-    accessoryName = "Test Accessory"
-  }
-
   uuid = UUIDGen.generate(accessoryName);
 
   var newAccessory = new Accessory(accessoryName, uuid);
   newAccessory.on('identify', function(paired, callback) {
-    console.log("Identify!!!");
+    platform.log(accessory.displayName, "Identify!!!");
     callback();
   });
   // Plugin can save context on accessory
@@ -194,7 +193,7 @@ SamplePlatform.prototype.addAccessory = function(accessoryName) {
   newAccessory.addService(Service.Lightbulb, "Test Light")
   .getCharacteristic(Characteristic.On)
   .on('set', function(value, callback) {
-    console.log("Light -> " + value);
+    platform.log(accessory.displayName, "Light -> " + value);
     callback();
   });
 
@@ -203,7 +202,7 @@ SamplePlatform.prototype.addAccessory = function(accessoryName) {
 }
 
 SamplePlatform.prototype.updateAccessoriesReachability = function() {
-  console.log("Update Reachability");
+  this.log("Update Reachability");
   for (var index in this.accessories) {
     var accessory = this.accessories[index];
     accessory.updateReachability(false);
@@ -212,8 +211,8 @@ SamplePlatform.prototype.updateAccessoriesReachability = function() {
 
 // Sample function to show how developer can remove accessory dynamically from outside event
 SamplePlatform.prototype.removeAccessory = function() {
-  console.log("Remove Accessory");
+  this.log("Remove Accessory");
   this.api.unregisterPlatformAccessories("homebridge-samplePlatform", "SamplePlatform", this.accessories);
 
   this.accessories = [];
-}
+}

lib/api.js

@@ -20,7 +20,7 @@ function API() {
   this._dynamicPlatforms = {}; // this._dynamicPlatforms[pluginName.platformName] = platform constructor
   
   // expose the homebridge API version
-  this.version = 2.0;
+  this.version = 2.1;
 
   // expose the User class methods to plugins to get paths. Example: homebridge.user.storagePath()
   this.user = User;
@@ -85,6 +85,18 @@ API.prototype.registerAccessory = function(pluginName, accessoryName, constructo
   }
 }
 
+API.prototype.publishCameraAccessories = function(pluginName, accessories) {
+  for (var index in accessories) {
+    var accessory = accessories[index];
+    if (!(accessory instanceof PlatformAccessory)) {
+      throw new Error(pluginName + " attempt to register an accessory that isn\'t PlatformAccessory!");
+    }
+    accessory._associatedPlugin = pluginName;
+  }
+
+  this.emit('publishCameraAccessories', accessories);
+}
+
 API.prototype.platform = function(name) {
   
   // if you passed the "short form" name like "Lockitron" instead of "homebridge-lockitron.Lockitron",

lib/logger.js

@@ -67,7 +67,7 @@ Logger.prototype.log = function(level, msg) {
   
   // prepend timestamp
   var date = new Date();
-  msg = chalk.black("[" + date.toLocaleString() + "]") + " " + msg;
+  msg = "[" + date.toLocaleString() + "]" + " " + msg;
 
   func(msg);
 }

lib/platformAccessory.js

@@ -130,9 +130,23 @@ PlatformAccessory.prototype.updateReachability = function(reachable) {
   }
 }
 
+PlatformAccessory.prototype.configureCameraSource = function(cameraSource) {
+  this.cameraSource = cameraSource;
+  for (var index in cameraSource.services) {
+    var service = cameraSource.services[index];
+    this.addService(service);
+  }
+}
+
 PlatformAccessory.prototype._prepareAssociatedHAPAccessory = function () {
   this._associatedHAPAccessory = new Accessory(this.displayName, this.UUID);
+
+  if (this.cameraSource) {
+    this._associatedHAPAccessory.configureCameraSource(this.cameraSource);
+  }
+
   this._associatedHAPAccessory._sideloadServices(this.services);
+  this._associatedHAPAccessory.category = this.category;
   this._associatedHAPAccessory.reachable = this.reachable;
   this._associatedHAPAccessory.on('identify', function(paired, callback) {
     if (this.listeners('identify').length > 0) {

lib/server.js

@@ -15,6 +15,7 @@ var PlatformAccessory = require("./platformAccessory").PlatformAccessory;
 var BridgeSetupManager = require("./bridgeSetupManager").BridgeSetupManager;
 var log = require("./logger")._system;
 var Logger = require('./logger').Logger;
+var mac = require("./util/mac");
 
 'use strict';
 
@@ -40,6 +41,10 @@ function Server(insecureAccess) {
     this._handleUnregisterPlatformAccessories(accessories);
   }.bind(this));
 
+  this._api.on('publishCameraAccessories', function(accessories) {
+    this._handlePublishCameraAccessories(accessories);
+  }.bind(this));
+
   this._plugins = this._loadPlugins(); // plugins[name] = Plugin instance
   this._config = this._loadConfig();  
   this._cachedPlatformAccessories = this._loadCachedPlatformAccessories();
@@ -47,6 +52,7 @@ function Server(insecureAccess) {
 
   this._activeDynamicPlugins = {};
   this._configurablePlatformPlugins = {};
+  this._publishedCameras = {};
   this._setupManager = new BridgeSetupManager();
   this._setupManager.on('newConfig', this._handleNewConfig.bind(this));
   
@@ -87,16 +93,27 @@ Server.prototype.run = function() {
 Server.prototype._publish = function() {
   // pull out our custom Bridge settings from config.json, if any
   var bridgeConfig = this._config.bridge || {};
+  
+  var info = this._bridge.getService(Service.AccessoryInformation);
+  if (bridgeConfig.manufacturer)
+    info.setCharacteristic(Characteristic.Manufacturer, bridgeConfig.manufacturer);
+  if (bridgeConfig.model)
+    info.setCharacteristic(Characteristic.Model, bridgeConfig.model);
+  if (bridgeConfig.serialNumber)
+    info.setCharacteristic(Characteristic.SerialNumber, bridgeConfig.serialNumber);
 
   this._printPin(bridgeConfig.pin);
+
+  this._bridge.on('listening', function(port) {
+    log.info("Homebridge is running on port %s.", port);
+  });
+
   this._bridge.publish({
     username: bridgeConfig.username || "CC:22:3D:E3:CE:30",
-    port: bridgeConfig.port || 51826,
+    port: bridgeConfig.port || 0,
     pincode: bridgeConfig.pin || "031-45-154",
     category: Accessory.Categories.BRIDGE
   }, this._allowInsecureAccess);
-
-  log.info("Homebridge is running on port %s.", bridgeConfig.port || 51826);
 }
 
 Server.prototype._loadPlugins = function(accessories, platforms) {
@@ -150,12 +167,13 @@ Server.prototype._loadConfig = function() {
 
   // Complain and exit if it doesn't exist yet
   if (!fs.existsSync(configPath)) {
+    log.warn("config.json (%s) not found.", configPath);
+    
     var config = {};
 
     config.bridge = {
       "name": "Homebridge",
       "username": "CC:22:3D:E3:CE:30",
-      "port": 51826,
       "pin": "031-45-154"
     };
 
@@ -444,6 +462,34 @@ Server.prototype._handleUnregisterPlatformAccessories = function(accessories) {
   this._updateCachedAccessories();
 }
 
+Server.prototype._handlePublishCameraAccessories = function(accessories) {
+  var accessoryPin = (this._config.bridge || {}).pin || "031-45-154";
+
+  for (var index in accessories) {
+    var accessory = accessories[index];
+
+    accessory._prepareAssociatedHAPAccessory();
+    var hapAccessory = accessory._associatedHAPAccessory;
+    var advertiseAddress = mac.generate(accessory.UUID);
+
+    if (this._publishedCameras[advertiseAddress]) {
+      throw new Error("Camera accessory " + accessory.displayName + " experienced an address collision.");
+    } else {
+      this._publishedCameras[advertiseAddress] = accessory;
+    }
+
+    hapAccessory.on('listening', function(port) {
+      log.info("%s is running on port %s.", accessory.displayName, port);
+    });
+
+    hapAccessory.publish({
+      username: advertiseAddress,
+      pincode: accessoryPin,
+      category: accessory.category
+    }, this._allowInsecureAccess);
+  }
+}
+
 Server.prototype._updateCachedAccessories = function() {
   var serializedAccessories = [];
 
@@ -466,7 +512,7 @@ Server.prototype._handleNewConfig = function(type, name, replace, config) {
       this._config.accessories.push(config);
     } else {
       var targetName;
-      if (name.indexOf('.') == -1) {
+      if (name.indexOf('.') !== -1) {
         targetName = name.split(".")[1];  
       }
       var found = false;
@@ -498,7 +544,7 @@ Server.prototype._handleNewConfig = function(type, name, replace, config) {
       this._config.platforms.push(config);
     } else {
       var targetName;
-      if (name.indexOf('.') == -1) {
+      if (name.indexOf('.') !== -1) {
         targetName = name.split(".")[1];  
       }
 

lib/util/mac.js

@@ -0,0 +1,18 @@
+var crypto = require('crypto');
+
+'use strict';
+
+module.exports = {
+  generate: generate
+}
+
+function generate(data) {
+  var sha1sum = crypto.createHash('sha1');
+  sha1sum.update(data);
+  var s = sha1sum.digest('hex');
+  var i = -1;
+  return 'xx:xx:xx:xx:xx:xx'.replace(/[x]/g, function(c) {
+    i += 1;
+    return s[i];
+  }).toUpperCase();
+};

package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge",
   "description": "HomeKit support for the impatient",
-  "version": "0.3.1",
+  "version": "0.4.8",
   "scripts": {
     "dev": "DEBUG=* ./bin/homebridge -D -P example-plugins/ || true"
   },
@@ -20,13 +20,13 @@
     "homebridge": "bin/homebridge"
   },
   "engines": {
-    "node": ">=0.12.0"
+    "node": ">=4.3.2"
   },
   "preferGlobal": true,
   "dependencies": {
     "chalk": "^1.1.1",
     "commander": "2.8.1",
-    "hap-nodejs": "0.2.7",
+    "hap-nodejs": "0.4.13",
     "semver": "5.0.3",
     "node-persist": "^0.0.8"
   }