Merge branch 'master' into bugfix-custom-functions

Author: norman-thomas

.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 .nyc_output/
 coverage/
+.DS_Store

README.md

@@ -52,7 +52,8 @@ In this version, I have made some changes from the older version. Mainly the plu
             "name": "Kitchen Temperature",
             "type": "temperaturesensor",
             "device_id": "<<device id>>",
-            "event_name": "tvalue"
+            "event_name": "tvalue",
+            "split_character": ":"
           }
         ]
       }
@@ -70,3 +71,10 @@ The `devices` array contains all the accessories. You can see the accessory obje
  - **event_name** - The name of the event to listen for sensor value update. This is only valid if the accessory is a sensor (i.e. currently `temperaturesensor` or `humiditysensor`). The plugin listens for events published from a Particle Device (using `Particle.publish`). The device firmware should publish the sensor values as a raw number.
  - **function_name** - The name of the particle function that will be called when an action is triggered via HomeKit. If there is no function provided, the default `power` will be used. This is only valid if the accessory is an actor (i.e. `lightbulb` or `switchaccessory`).
 
+**Particle Event Data Format**
+-------------------------------------
+By default it expects the event data as "key=value".
+```
+Particle.publish("tvalue", "temperature=20.7")
+```
+In order to parse JSON format, a custom `split_character` can be configured.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-particle-io",
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "Particle plugin for homebridge: https://github.com/nfarina/homebridge",
   "license": "ISC",
   "keywords": [
@@ -27,11 +27,11 @@
   },
   "engines": {
     "node": ">=4.3.2",
-    "homebridge": ">=0.2.0"
+    "homebridge": ">=0.4.0"
   },
   "dependencies": {
     "eventsource": "",
-    "request": "^2.65.0"
+    "request": "^2.85.0"
   },
   "devDependencies": {
     "chai": "^3.5.0",

src/AccessoryFactory.js

@@ -34,7 +34,7 @@ class AccessoryFactory {
   }
 
   createAccessory(device) {
-    this.log("Create Accessory for device:", device)
+    this.log('Create Accessory for device:', device);
     return new accessoryRegistry[device.type.toLowerCase()](
       this.log, this.url, this.accessToken, device, this.homebridge
     );

src/ActorAccessory.js

@@ -36,19 +36,21 @@ class ActorAccessory extends Accessory {
 
   getState(callback) {
     this.callParticleFunction(this.function_name, '?', (error, response, body) => {
-      this.value = parseInt(body);
+      this.value = parseInt(body, 10);
       try {
         callback(null, this.value);
-      } catch (error) {
-        this.log('Caught error '+ error + ' when calling homebridge callback.');
+      } catch (err) {
+        this.log(`Caught error ${err} when calling homebridge callback.`);
       }
     },
     true);
   }
 
   setState(value, callback) {
     this.value = value;
-    this.callParticleFunction(this.function_name, value, (error, response, body) => this.callbackHelper(error, response, body, callback), true);
+    this.callParticleFunction(this.function_name,
+                              value,
+                              (error, response, body) => this.callbackHelper(error, response, body, callback), true);
   }
 
   callbackHelper(error, response, body, callback) {

src/ColorLightbulbAccessory.js

@@ -6,46 +6,48 @@ class ColorLightbulbAccessory extends DimmableLightbulbAccessory {
     const Characteristic = homebridge.hap.Characteristic;
     super(log, url, accessToken, device, homebridge);
 
-    this.hueFunctionName = "hue"
-		this.actorService.getCharacteristic(Characteristic.Hue)
+    this.hueFunctionName = 'hue';
+    this.actorService.getCharacteristic(Characteristic.Hue)
                      .on('set', this.setHue.bind(this))
                      .on('get', this.getHue.bind(this));
 
-    this.saturationFunctionName = "saturation"
+    this.saturationFunctionName = 'saturation';
     this.actorService.getCharacteristic(Characteristic.Saturation)
                      .on('set', this.setSaturation.bind(this))
                      .on('get', this.getSaturation.bind(this));
   }
 
   setHue(value, callback) {
     this.hue = value;
-    this.callParticleFunction(this.hueFunctionName, value, (error, response, body) => this.callbackHelper(error, response, body, callback), true);
+    this.callParticleFunction(this.hueFunctionName, value,
+                              (error, response, body) => this.callbackHelper(error, response, body, callback), true);
   }
 
   getHue(callback) {
     this.callParticleFunction(this.hueFunctionName, '?', (error, response, body) => {
-      this.hue = parseInt(body);
+      this.hue = parseInt(body, 10);
       try {
         callback(null, this.hue);
-      } catch (error) {
-        this.log('Caught error '+ error + ' when calling homebridge callback.');
+      } catch (err) {
+        this.log(`Caught error ${err} when calling homebridge callback.`);
       }
     },
     true);
   }
 
   setSaturation(value, callback) {
     this.saturation = value;
-    this.callParticleFunction(this.saturationFunctionName, value, (error, response, body) => this.callbackHelper(error, response, body, callback), true);
+    this.callParticleFunction(this.saturationFunctionName, value,
+                              (error, response, body) => this.callbackHelper(error, response, body, callback), true);
   }
 
   getSaturation(callback) {
     this.callParticleFunction(this.saturationFunctionName, '?', (error, response, body) => {
-      this.saturation = parseInt(body);
+      this.saturation = parseInt(body, 10);
       try {
         callback(null, this.saturation);
-      } catch (error) {
-        this.log('Caught error '+ error + ' when calling homebridge callback.');
+      } catch (err) {
+        this.log(`Caught error ${err} when calling homebridge callback.`);
       }
     },
     true);

src/DimmableLightbulbAccessory.js

@@ -9,21 +9,22 @@ class DimmableLightbulbAccessory extends LightbulbAccessory {
     this.actorService.getCharacteristic(Characteristic.Brightness)
                      .on('set', this.setBrightness.bind(this))
                      .on('get', this.getBrightness.bind(this));
-    this.brightnessFunctionName = "brightness"
+    this.brightnessFunctionName = 'brightness';
   }
 
   setBrightness(value, callback) {
     this.brightness = value;
-    this.callParticleFunction(this.brightnessFunctionName, value, (error, response, body) => this.callbackHelper(error, response, body, callback), true);
+    this.callParticleFunction(this.brightnessFunctionName, value,
+                              (error, response, body) => this.callbackHelper(error, response, body, callback), true);
   }
 
   getBrightness(callback) {
     this.callParticleFunction(this.brightnessFunctionName, '?', (error, response, body) => {
-      this.brightness = parseInt(body);
+      this.brightness = parseInt(body, 10);
       try {
         callback(null, this.brightness);
-      } catch (error) {
-        this.log('Caught error '+ error + ' when calling homebridge callback.');
+      } catch (err) {
+        this.log(`Caught error ${err} when calling homebridge callback.`);
       }
     },
     true);

src/SensorAccessory.js

@@ -8,6 +8,7 @@ class SensorAccessory extends Accessory {
     this.eventName = device.event_name;
     this.key = device.key;
     this.unit = null;
+    this.split_character = !device.split_character ? '=' : device.split_character;
 
     this.eventUrl = `${this.url}${this.deviceId}/events/${this.eventName}?access_token=${this.accessToken}`;
     this.log('Listening for events from:', this.eventUrl);
@@ -30,7 +31,7 @@ class SensorAccessory extends Accessory {
 
   processEventData(e) {
     const data = JSON.parse(e.data);
-    const result = this.key ? data.data.split('=')[1] : data.data;
+    const result = this.key ? data.data.split(this.split_character)[1] : data.data;
 
     if (this.services.length < 2) {
       return;

test/SensorAccessory-test.js

@@ -33,6 +33,7 @@ describe('SensorAccessory.js', () => {
       accessory.eventUrl.should.be.equal(
         'https://some.random.url.com/1234567890abcdef/events/humidity?access_token=MY_top_SECRET_access_TOKEN'
       );
+      accessory.split_character.should.be.equal(device.split_character);
 
       accessory.services.should.have.length(2);
       accessory.services[1].should.be.an.instanceOf(Service.HumiditySensor);

test/dummyConfig.js

@@ -25,7 +25,8 @@ const dummyConfig = {
       name: 'Kitchen Humidity',
       type: 'humiditysensor',
       device_id: '1234567890abcdef',
-      event_name: 'humidity'
+      event_name: 'humidity',
+      split_character: ':'
     },
     {
       name: 'Kitchen Light Sensor',