Google Home: Should normalize brightness scale when controlling device with custom scale

server/services/google-actions/lib/traits/googleActions.brightness.trait.js

@@ -1,3 +1,4 @@
+const { normalize } = require('../../../../utils/device');
 const { DEVICE_FEATURE_CATEGORIES, DEVICE_FEATURE_TYPES } = require('../../../../utils/constants');
 
 /**
@@ -19,7 +20,7 @@ const brightnessTrait = {
     {
       key: 'brightness',
       readValue: (feature) => {
-        return feature.last_value;
+        return Math.round(normalize(feature.last_value, feature.min, feature.max, 0, 100));
       },
     },
   ],
@@ -34,7 +35,7 @@ const brightnessTrait = {
       if (relatedFeature) {
         events.push({
           device_feature: relatedFeature.selector,
-          value: brightness,
+          value: Math.round(normalize(brightness, 0, 100, relatedFeature.min, relatedFeature.max)),
         });
       }
 

server/services/homekit/lib/buildService.js

@@ -8,7 +8,7 @@ const {
   EVENTS,
   DEVICE_FEATURE_UNITS,
 } = require('../../../utils/constants');
-const { normalize } = require('./utils');
+const { normalize } = require('../../../utils/device');
 const { fahrenheitToCelsius } = require('../../../utils/units');
 
 const sleep = promisify(setTimeout);

server/services/homekit/lib/sendState.js

@@ -1,6 +1,6 @@
 const { intToRgb, rgbToHsb } = require('../../../utils/colors');
 const { DEVICE_FEATURE_CATEGORIES, DEVICE_FEATURE_TYPES, DEVICE_FEATURE_UNITS } = require('../../../utils/constants');
-const { normalize } = require('./utils');
+const { normalize } = require('../../../utils/device');
 const { fahrenheitToCelsius } = require('../../../utils/units');
 const { mappings } = require('./deviceMappings');
 

server/test/services/google-actions/lib/smarthome/devices_and_traits/googleActions.brightness.trait.light.test.js

@@ -59,6 +59,8 @@ describe('GoogleActions Handler - onSync - brightness (light)', () => {
           category: DEVICE_FEATURE_CATEGORIES.LIGHT,
           type: DEVICE_FEATURE_TYPES.LIGHT.BRIGHTNESS,
           last_value: 73,
+          min: 0,
+          max: 100,
         },
       ],
       model: 'device-model',
@@ -144,6 +146,65 @@ describe('GoogleActions Handler - onSync - brightness (light)', () => {
     assert.notCalled(gladys.event.emit);
   });
 
+  it('should get device value with custom scale - onQuery', async () => {
+    const device = {
+      name: 'Device 1',
+      selector: 'device-1',
+      external_id: 'device-1-external-id',
+      features: [
+        {
+          selector: 'feature-1',
+          category: DEVICE_FEATURE_CATEGORIES.LIGHT,
+          type: DEVICE_FEATURE_TYPES.LIGHT.BRIGHTNESS,
+          last_value: 127,
+          min: 0,
+          max: 254,
+        },
+      ],
+      model: 'device-model',
+      room: {
+        name: 'living-room',
+      },
+    };
+
+    gladys = {
+      event: {
+        emit: fake.resolves(null),
+      },
+      stateManager: {
+        get: fake.returns(device),
+        state: {
+          device: {
+            device_1: {
+              get: fake.returns(device),
+            },
+          },
+        },
+      },
+    };
+
+    googleActionsHandler = new GoogleActionsHandler(gladys, serviceId);
+    const result = await googleActionsHandler.onQuery(body);
+
+    const expectedResult = {
+      requestId: 'request-id',
+      payload: {
+        agentUserId: 'user-id',
+        devices: {
+          'device-1': {
+            online: true,
+            brightness: 50,
+          },
+        },
+      },
+    };
+    expect(result).to.deep.eq(expectedResult);
+
+    assert.notCalled(gladys.stateManager.state.device.device_1.get);
+    assert.calledOnceWithExactly(gladys.stateManager.get, 'device', 'device-1');
+    assert.notCalled(gladys.event.emit);
+  });
+
   it('should emit Gladys event with new value - onExecute', async () => {
     const result = await googleActionsHandler.onExecute(body);
 
@@ -171,4 +232,68 @@ describe('GoogleActions Handler - onSync - brightness (light)', () => {
       value: 20,
     });
   });
+  it('should emit Gladys event with new value on scale 0 - 254 - onExecute', async () => {
+    const device = {
+      name: 'Device 1',
+      selector: 'device-1',
+      external_id: 'device-1-external-id',
+      features: [
+        {
+          selector: 'feature-1',
+          category: DEVICE_FEATURE_CATEGORIES.LIGHT,
+          type: DEVICE_FEATURE_TYPES.LIGHT.BRIGHTNESS,
+          last_value: 73,
+          min: 0,
+          max: 254,
+        },
+      ],
+      model: 'device-model',
+      room: {
+        name: 'living-room',
+      },
+    };
+
+    gladys = {
+      event: {
+        emit: fake.resolves(null),
+      },
+      stateManager: {
+        get: fake.returns(device),
+        state: {
+          device: {
+            device_1: {
+              get: fake.returns(device),
+            },
+          },
+        },
+      },
+    };
+
+    googleActionsHandler = new GoogleActionsHandler(gladys, serviceId);
+    const result = await googleActionsHandler.onExecute(body);
+
+    const expectedResult = {
+      requestId: 'request-id',
+      payload: {
+        agentUserId: 'user-id',
+        commands: [
+          {
+            ids: ['device-1'],
+            status: 'PENDING',
+          },
+        ],
+      },
+    };
+    expect(result).to.deep.eq(expectedResult);
+
+    assert.notCalled(gladys.stateManager.state.device.device_1.get);
+    assert.calledOnceWithExactly(gladys.stateManager.get, 'device', 'device-1');
+    assert.calledOnceWithExactly(gladys.event.emit, EVENTS.ACTION.TRIGGERED, {
+      device: 'device-1',
+      device_feature: 'feature-1',
+      status: 'pending',
+      type: 'device.set-value',
+      value: 51,
+    });
+  });
 });

server/test/services/google-actions/lib/smarthome/devices_and_traits/googleActions.brightness.trait.switch.test.js

@@ -58,6 +58,8 @@ describe('GoogleActions Handler - onSync - brightness (switch)', () => {
           selector: 'feature-1',
           category: DEVICE_FEATURE_CATEGORIES.SWITCH,
           type: DEVICE_FEATURE_TYPES.SWITCH.DIMMER,
+          min: 0,
+          max: 100,
           last_value: 73,
         },
       ],

server/test/utils/device.test.js

@@ -6,6 +6,7 @@ const {
   hasDeviceChanged,
   mergeFeatures,
   mergeDevices,
+  normalize,
 } = require('../../utils/device');
 
 const buildObject = (prefix, attributes) => {
@@ -262,3 +263,11 @@ describe('mergeDevice', () => {
     expect(mergedDevice).to.deep.equal(expectedDevice);
   });
 });
+
+describe('normalize', () => {
+  it('should normalize data to new range', async () => {
+    const newValue = normalize(50, 0, 100, 0, 360);
+
+    expect(newValue).to.equal(180);
+  });
+});

server/utils/device.js

@@ -175,11 +175,27 @@ function mergeDevices(newDevice, existingDevice, updateAttribute = 'updatable')
   return { ...existingDevice, ...newDevice, name, room_id: roomId, features, [updateAttribute]: deviceChanged };
 }
 
+/**
+ * @description Normalize value to new range.
+ * @param {number} value - Actual value.
+ * @param {number} currentMin - Actual possible min value.
+ * @param {number} currentMax - Actual possible max value.
+ * @param {number} newRangeMin - Target possible min value.
+ * @param {number} newRangeMax - Target possible max value.
+ * @returns {number} New value in target range.
+ * @example
+ * normalize(5, 0, 255, 0, 360)
+ */
+function normalize(value, currentMin, currentMax, newRangeMin, newRangeMax) {
+  return ((newRangeMax - newRangeMin) * (value - currentMin)) / (currentMax - currentMin) + newRangeMin;
+}
+
 module.exports = {
   getDeviceParam,
   setDeviceParam,
   getDeviceFeature,
   hasDeviceChanged,
   mergeFeatures,
   mergeDevices,
+  normalize,
 };