fix: Brightness retrieval without brightness config via RGB

Author: QuickSander

README.md

@@ -175,7 +175,7 @@ Following configuration is a real world example for a accessory that combines a
                 "url":"http://192.168.0.120/api/<apikey>/lights/6/state",
                 "body": "{\"bri\": %s}"
             },
-            "http_method": "`PUT`",
+            "http_method": "PUT",
             "max": 254
         },
         "color": {

index.js

@@ -381,12 +381,32 @@ HttpPushRgb.prototype = {
 
                     level = parseInt(100 / this.brightness.max * level);
 
-                    this.log('brightness is currently at %s %', level);
+                    this.log('brightness is currently at %s%', level);
                     callback(null, level);
                 }
             }.bind(this));
         } else {
-            callback(null, this.cache.brightness);
+            if(this.color.brightness) {
+                var url = this.color.get_url.url;
+                this._httpRequest(url, '', 'GET', function(error, response, responseBody) {
+                    if (!this._handleHttpErrorResponse('getBrightness()', error, response, responseBody, callback)) {
+                        var rgb = responseBody;
+                        var levels = this._rgbToHsl(
+                            parseInt(rgb.substr(0,2),16),
+                            parseInt(rgb.substr(2,2),16),
+                            parseInt(rgb.substr(4,2),16)
+                        );
+        
+                        var brightness = levels[2];
+        
+                        this.log('... brightness is currently %s. RGB: %s', brightness, rgb);
+                        this.cache.brightness = brightness;
+                        callback(null, brightness);
+                    }
+                }.bind(this));
+            } else {
+                callback(null, this.cache.brightness);
+            }
         }
     },
 
@@ -401,6 +421,8 @@ HttpPushRgb.prototype = {
             callback(new Error("No 'brightness' defined in configuration"));
             return;
         }
+
+        this.log('Caching Brightness as %s ...', level);
         this.cache.brightness = level;
 
         // If achromatic or color.brightness is false, update brightness, otherwise, update HSL as RGB
@@ -412,11 +434,12 @@ HttpPushRgb.prototype = {
 
             this._httpRequest(url, body, this.brightness.http_method, function(error, response, responseBody) {
                 if (!this._handleHttpErrorResponse('setBrightness()', error, response, responseBody, callback)) {
-                    this.log('setBrightness() successfully set to %s %', level);
+                    this.log('setBrightness() successfully set to %s%', level);
                     callback();
                 }
             }.bind(this));
         } else {
+            this.log("Setting brightness via RGB.");
             this._setRGB(callback);
         }
     },
@@ -445,7 +468,7 @@ HttpPushRgb.prototype = {
 
                 var hue = levels[0];
 
-                this.log('... hue is currently %s', hue);
+                this.log('... hue is currently %s. RGB: %s', hue, rgb);
                 this.cache.hue = hue;
                 callback(null, hue);
             }
@@ -497,7 +520,7 @@ HttpPushRgb.prototype = {
 
                 var saturation = levels[1];
 
-                this.log('... saturation is currently %s', saturation);
+                this.log('... saturation is currently %s. RGB: %s', saturation, rgb);
                 this.cache.saturation = saturation;
                 callback(null, saturation);
             }
@@ -548,12 +571,11 @@ HttpPushRgb.prototype = {
         var xyz = convert.rgb.xyz(rgb);
         var hex = convert.rgb.hex(rgb);
 
-        if(xyz == null || xyz.size == 0){
-           this.log.warn("Can't read the brightness property! Ignoring the request");
+        if(xyz == null || xyz.size == 0) {
+           this.log.error("Failed to convert HSB to xyz values. Cached values: H:%s S:%s B:%s", this.cache.hue, this.cache.saturation, this.cache.brightness);
            return {url: '', body: ''};
         }
 
-
         var xy = {
             x: (xyz[0] / 100 / (xyz[0] / 100 + xyz[1] / 100 + xyz[2] / 100)).toFixed(4),
             y: (xyz[1] / 100 / (xyz[0] / 100 + xyz[1] / 100 + xyz[2] / 100)).toFixed(4)

test/basics.test.js

@@ -288,7 +288,8 @@ describe('Set brightness', function () {
 
       // 3. Assert
       expect(this.homebridgeCallback.calledOnce).to.be.true;
-      expect(this.homebridgeStub.logger.firstCall.args).deep.equals(['setBrightness() successfully set to %s %', 100]);
+      expect(this.homebridgeStub.logger.firstCall.args).deep.equals(['Caching Brightness as %s ...', 100]);
+      expect(this.homebridgeStub.logger.secondCall.args).deep.equals(['setBrightness() successfully set to %s%', 100]);
    });
 
    it('sets RGB instead of brightness to Homebridge when config.color.brightness equals true', function () {
@@ -303,8 +304,12 @@ describe('Set brightness', function () {
 
       // 3. Assert
       expect(this.homebridgeCallback.calledOnce).to.be.true; // But now inside _buildRgbRequest.
-      expect(this.homebridgeStub.logger.firstCall.args[0]).deep.equals('_buildRgbRequest converting H:%s S:%s B:%s to RGB:%s ...');
-      expect(this.homebridgeStub.logger.secondCall.args).deep.equals(['... _setRGB() successfully set']);
+      expect(this.homebridgeStub.logger.secondCall.args).deep.equals(['Setting brightness via RGB.']);
+      expect(this.homebridgeStub.logger.firstCall.args).deep.equals(['Caching Brightness as %s ...', 100]);
+      expect(this.homebridgeStub.logger.thirdCall.args[0]).deep.equals('_buildRgbRequest converting H:%s S:%s B:%s to RGB:%s ...');
+      expect(this.homebridgeStub.logger.getCall(3).args).deep.equals(['... _setRGB() successfully set']);
+      expect(this.homebridgeStub.accessory._httpRequest.firstCall.args[0]).not.to.be.empty;
+
    });
 
    it('replies an Error object with message "Received HTTP error code 500." to Homebridge on HTTP GET device response status code 500', function () {
@@ -319,7 +324,8 @@ describe('Set brightness', function () {
 
       // 3. Assert
       expect(this.homebridgeCallback.firstCall.args[0]).to.be.instanceOf(Error).and.have.property('message', 'Received HTTP error code '+HTTP_ERROR_STATUS_CODE+': "Dummy error"');
-      expect(this.homebridgeStub.logger.firstCall.args).deep.equals(['setBrightness() returned HTTP error code: %s: "%s"', HTTP_ERROR_STATUS_CODE, 'Dummy error']);
+      expect(this.homebridgeStub.logger.firstCall.args).deep.equals(['Caching Brightness as %s ...', 100]);
+      expect(this.homebridgeStub.logger.secondCall.args).deep.equals(['setBrightness() returned HTTP error code: %s: "%s"', HTTP_ERROR_STATUS_CODE, 'Dummy error']);
    });
 
 });
@@ -361,7 +367,7 @@ describe('Get hue', function () {
 
       // 3. Assert
       expect(this.homebridgeCallback.firstCall.args[1]).equals(0);
-      expect(this.homebridgeStub.logger.firstCall.args).deep.equals(['... hue is currently %s', 0]);
+      expect(this.homebridgeStub.logger.firstCall.args).deep.equals(['... hue is currently %s. RGB: %s', 0, 'ffffff']);
    });
 
 });
@@ -407,7 +413,7 @@ describe('Get saturation', function () {
 
       // 3. Assert
       expect(this.homebridgeCallback.firstCall.args[1]).equals(0);
-      expect(this.homebridgeStub.logger.firstCall.args).deep.equals(['... saturation is currently %s', 0]);
+      expect(this.homebridgeStub.logger.firstCall.args).deep.equals(['... saturation is currently %s. RGB: %s', 0, 'ffffff']);
    });
 
 });