HomeKit: Handle state only shutters (#2342)

Author: bertrandda

server/services/homekit/lib/buildService.js

@@ -199,6 +199,38 @@ function buildService(device, features, categoryMapping, subtype) {
           const { features: updatedFeatures } = await this.gladys.device.getBySelector(device.selector);
           callback(undefined, coverStateMapping[updatedFeatures.find((feat) => feat.id === feature.id).last_value]);
         });
+
+        if (
+          !features.find((f) =>
+            [
+              `${DEVICE_FEATURE_CATEGORIES.CURTAIN}:${DEVICE_FEATURE_TYPES.CURTAIN.POSITION}`,
+              `${DEVICE_FEATURE_CATEGORIES.SHUTTER}:${DEVICE_FEATURE_TYPES.SHUTTER.POSITION}`,
+            ].includes(`${f.category}:${f.type}`),
+          )
+        ) {
+          const targetPosCharacteristic = service.getCharacteristic(
+            Characteristic[categoryMapping.capabilities[DEVICE_FEATURE_TYPES.CURTAIN.POSITION].characteristics[1]],
+          );
+          targetPosCharacteristic.on(CharacteristicEventTypes.SET, async (value, callback) => {
+            const action = {
+              type: ACTIONS.DEVICE.SET_VALUE,
+              status: ACTIONS_STATUS.PENDING,
+              value: Math.round(
+                normalize(
+                  value,
+                  targetPosCharacteristic.props.minValue,
+                  targetPosCharacteristic.props.maxValue,
+                  feature.min,
+                  feature.max,
+                ),
+              ),
+              device: device.selector,
+              device_feature: feature.selector,
+            };
+            this.gladys.event.emit(EVENTS.ACTION.TRIGGERED, action);
+            callback();
+          });
+        }
         break;
       }
       default:

server/test/services/homekit/lib/buildService.test.js

@@ -575,4 +575,91 @@ describe('Build service', () => {
       device_feature: features[1].selector,
     });
   });
+
+  it('should build shutter/curtain service without real position', async () => {
+    homekitHandler.gladys.device.getBySelector = stub().resolves({
+      features: [
+        {
+          id: '31c6a4a7-9710-4951-bf34-04eeae5b9ff7',
+          name: 'Shutter State',
+          selector: 'shutter-state',
+          category: DEVICE_FEATURE_CATEGORIES.SHUTTER,
+          type: DEVICE_FEATURE_TYPES.SHUTTER.STATE,
+          last_value: 0,
+        },
+      ],
+    });
+    homekitHandler.gladys.event.emit = stub();
+    const on = stub();
+    const getCharacteristic = stub()
+      .onCall(0)
+      .returns({
+        on,
+        props: {
+          perms: ['PAIRED_READ'],
+        },
+      })
+      .onCall(1)
+      .returns({
+        on,
+        props: {
+          perms: ['PAIRED_READ', 'PAIRED_WRITE'],
+          minValue: 0,
+          maxValue: 100,
+        },
+      });
+    const WindowCovering = stub().returns({
+      getCharacteristic,
+    });
+
+    homekitHandler.hap = {
+      Characteristic: {
+        PositionState: 'POSITIONSTATE',
+        TargetPosition: 'TARGETPOSITION',
+      },
+      CharacteristicEventTypes: stub(),
+      Perms: {
+        PAIRED_READ: 'PAIRED_READ',
+        PAIRED_WRITE: 'PAIRED_WRITE',
+      },
+      Service: {
+        WindowCovering,
+      },
+    };
+    const device = {
+      name: 'Shutter',
+      selector: 'shutter',
+    };
+    const features = [
+      {
+        id: '31c6a4a7-9710-4951-bf34-04eeae5b9ff7',
+        selector: 'shutter-state',
+        name: 'Shutter State',
+        category: DEVICE_FEATURE_CATEGORIES.SHUTTER,
+        type: DEVICE_FEATURE_TYPES.SHUTTER.STATE,
+        min: -1,
+        max: 1,
+      },
+    ];
+
+    const cb = stub();
+
+    await homekitHandler.buildService(device, features, mappings[DEVICE_FEATURE_CATEGORIES.SHUTTER]);
+    await on.args[0][1](cb);
+    await on.args[1][1](70, cb);
+
+    expect(WindowCovering.args[0][0]).to.equal('Shutter');
+    expect(on.callCount).to.equal(2);
+    expect(getCharacteristic.args[0][0]).to.equal('POSITIONSTATE');
+    expect(getCharacteristic.args[1][0]).to.equal('TARGETPOSITION');
+    expect(cb.args[0][1]).to.equal(2);
+    expect(homekitHandler.gladys.event.emit.args[0][1]).to.eql({
+      type: ACTIONS.DEVICE.SET_VALUE,
+      status: ACTIONS_STATUS.PENDING,
+      // we don't have a real position, it's normalized and rounded between -1 and 1
+      value: 0,
+      device: device.selector,
+      device_feature: features[0].selector,
+    });
+  });
 });