homebridge-dummy 0.7.0 → 0.9.0

package/README.md

@@ -7,7 +7,8 @@ Example config.json:
     "accessories": [
         {
           "accessory": "DummySwitch",
-          "name": "My Switch 1"
+          "name": "My Switch 1",
+          "disableLogging": false
         }   
     ]
 
@@ -17,7 +18,9 @@ With this plugin, you can create any number of fake switches that will do nothin
 
 For instance, the Philips Hue app will automatically create HomeKit scenes for you based on Hue Scenes you create. But what if you want to create a scene that contains both Philips Hue actions and other actions (like turning on the coffee maker with a WeMo outlet)? You are forced to either modify the Hue-created scene (which can be a HUGE list of actions if you have lots of lights) or build your own HomeKit lighting scenes.
 
-Instead, you can link scenes using these dummy switches. Let's say you have a Hue Scene called "Rise and Shine" that you want to activate in the morning. And you have also setup the system HomeKit scene "Good Morning" to turn on your coffee maker and disarm you security system. You can add a single dummy switch to your Good Morning scene, then create a Trigger based on the switching-on of the dummy switch that also activates Rise And Shine.
+Instead, you can link scenes using these dummy switches. Let's say you have a Hue Scene called "Rise and Shine" that you want to activate in the morning. And you have also setup the system HomeKit scene "Good Morning" to turn on your coffee maker and disarm your security system. You can add a single dummy switch to your Good Morning scene, then create a Trigger based on the switching-on of the dummy switch that also activates Rise And Shine.
+
+If the disableLogging option is true, state changes (On/Off) will not be logged. The disableLogging option is per switch, so you can choose which ones will get log entries. If not supplied, the default value is false and state changes will be logged.
 
 ## Stateful Switches
 
@@ -34,6 +37,21 @@ The default behavior of a dummy switch is to turn itself off one second after be
 
 ```
 
+## Dimmer Switches
+
+By default, switches are toggle switches (on/off). You can configure your switch to be a dimmer switch, instead, storing a brightness value between 0 and 100. This can be done by passing the 'dimmer' argument in your config.json:
+
+```
+    "accessories": [
+        {
+          "accessory": "DummySwitch",
+          "name": "My Stateful Switch 1",
+          "dimmer": true
+        }
+    ]
+
+```
+
 ## Reverse Switches
 
 You may also want to create a dummy switch that turns itself on one second after being turned off. This can be done by passing the 'reverse' argument in your config.json:

package/config.schema.json

@@ -16,6 +16,12 @@
                 "default": false,
                 "description": "The switch remains on instead of being automatically turned off."
             },
+            "dimmer": {
+                "title": "Dimmer",
+                "type": "boolean",
+                "default": false,
+                "description": "Make the switch a dimmer instead of a toggle (on/off) switch"
+            },
             "reverse": {
                 "title": "Reverse",
                 "type": "boolean",
@@ -39,7 +45,22 @@
                 "type": "boolean",
                 "default": false,
                 "description": "The timer will reset each time the switch is turned on. "
+            },
+            "brightness": {
+                "title": "Brightness",
+                "type": "integer",
+                "default": 0,
+                "placeholder": 0,
+                "maximum": 100,
+                "description": "Starting brightness (dimmer only)"
+            },
+            "disableLogging": {
+                "title": "DisableLogging",
+                "type": "boolean",
+                "default": false,
+                "description": "No state change information (On/Off) will be logged. "
             }
+
         }
     }
 }

package/index.js

@@ -16,17 +16,28 @@ function DummySwitch(log, config) {
   this.log = log;
   this.name = config.name;
   this.stateful = config.stateful;
+  this.dimmer = config.dimmer;
+  this.brightness = config.brightness;
+  this.brightnessStorageKey = this.name + "Brightness";
   this.reverse = config.reverse;
   this.time = config.time ? config.time : 1000;		
   this.resettable = config.resettable;
   this.timer = null;
   this.random = config.random;
-  this._service = new Service.Switch(this.name);
+  this.disableLogging = config.disableLogging;
+
+  if (this.dimmer) {
+	this._service = new Service.Lightbulb(this.name);
+	this.modelString = "Dummy Dimmer";
+  } else {
+	this._service = new Service.Switch(this.name);
+	this.modelString = "Dummy Switch";
+  }
   
   this.informationService = new Service.AccessoryInformation();
   this.informationService
       .setCharacteristic(Characteristic.Manufacturer, 'Homebridge')
-      .setCharacteristic(Characteristic.Model, 'Dummy Switch')
+      .setCharacteristic(Characteristic.Model, this.modelString)
       .setCharacteristic(Characteristic.FirmwareRevision, HomebridgeDummyVersion)
       .setCharacteristic(Characteristic.SerialNumber, 'Dummy-' + this.name.replace(/\s/g, '-'));
   
@@ -36,6 +47,11 @@ function DummySwitch(log, config) {
   
   this._service.getCharacteristic(Characteristic.On)
     .on('set', this._setOn.bind(this));
+  if (this.dimmer) {
+	this._service.getCharacteristic(Characteristic.Brightness)
+            .on('get', this._getBrightness.bind(this))
+            .on('set', this._setBrightness.bind(this));
+  }
 
   if (this.reverse) this._service.setCharacteristic(Characteristic.On, true);
 
@@ -47,6 +63,17 @@ function DummySwitch(log, config) {
 		this._service.setCharacteristic(Characteristic.On, true);
 	}
   }
+
+  if (this.dimmer) {
+	var cachedBrightness = this.storage.getItemSync(this.brightnessStorageKey);
+	if ((cachedBrightness == undefined) || cachedBrightness == 0) {
+		this._service.setCharacteristic(Characteristic.On, false);
+		this._service.setCharacteristic(Characteristic.Brightness, 0);
+	} else {
+		this._service.setCharacteristic(Characteristic.On, true);
+		this._service.setCharacteristic(Characteristic.Brightness, cachedBrightness);
+	}
+  }
 }
 
 DummySwitch.prototype.getServices = function() {
@@ -57,6 +84,28 @@ function randomize(time) {
   return Math.floor(Math.random() * (time + 1));
 }
 
+DummySwitch.prototype._getBrightness = function(callback) {
+
+  if ( ! this.disableLogging ) {
+	this.log("Getting " + "brightness: " + this.brightness);
+  }
+
+  callback(null, this.brightness);
+}
+
+DummySwitch.prototype._setBrightness = function(brightness, callback) {
+
+  if ( ! this.disableLogging ) {
+	var msg = "Setting brightness: " + brightness
+	this.log(msg);
+  }
+
+  this.brightness = brightness;
+  this.storage.setItemSync(this.brightnessStorageKey, brightness);
+
+  callback();
+}
+
 DummySwitch.prototype._setOn = function(on, callback) {
 
   var delay = this.random ? randomize(this.time) : this.time;
@@ -66,7 +115,9 @@ DummySwitch.prototype._setOn = function(on, callback) {
         msg = msg + " (random delay " + delay + "ms)"
       }
   }
-  this.log(msg);
+  if( ! this.disableLogging ) {
+      this.log(msg);
+  }
 
   if (on && !this.reverse && !this.stateful) {
     if (this.resettable) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-dummy",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "Dummy switches for Homebridge: https://github.com/nfarina/homebridge",
   "license": "ISC",
   "keywords": [