homebridge-tuya-plus 4.1.0-dev.63 → 4.1.0-dev.64

package/config.schema.json

@@ -538,6 +538,23 @@
                 "functionBody": "return model.devices && model.devices[arrayIndices] && ['Fan', 'FanLight'].includes(model.devices[arrayIndices].type);"
               }
             },
+            "dpSwing": {
+              "title": "Swing/oscillation DP",
+              "description": "Data point of the fan's oscillation switch (a boolean DP). When set, a Swing (oscillation) control is shown in the Home app. Leave empty if the fan has no oscillation.",
+              "type": "integer",
+              "condition": {
+                "functionBody": "return model.devices && model.devices[arrayIndices] && ['Fan'].includes(model.devices[arrayIndices].type);"
+              }
+            },
+            "noDirection": {
+              "title": "Hide the rotation direction control",
+              "description": "Enable if the fan has no forward/reverse direction, or if the direction data point is actually a mode enum. Prevents writing forward/reverse into that data point.",
+              "type": "boolean",
+              "placeholder": false,
+              "condition": {
+                "functionBody": "return model.devices && model.devices[arrayIndices] && ['Fan'].includes(model.devices[arrayIndices].type);"
+              }
+            },
             "maxSpeed": {
               "type": "integer",
               "placeholder": "3",

package/lib/SimpleFanAccessory.js

@@ -22,6 +22,13 @@ class SimpleFanAccessory extends BaseAccessory {
         this.dpFanOn = this._getCustomDP(this.device.context.dpFanOn) || '1';
         this.dpRotationSpeed = this._getCustomDP(this.device.context.dpRotationSpeed) || '3';
         this.dpFanDirection = this._getCustomDP(this.device.context.dpFanDirection) || '2';
+        // Oscillation is opt-in: SwingMode is only exposed when the fan's boolean
+        // swing DP is configured, so existing setups are unchanged (issue #96).
+        this.dpSwing = this._getCustomDP(this.device.context.dpSwing);
+        // Some fans use DP 2 for a mode enum (nature/sleep/…) rather than a
+        // rotation direction; RotationDirection would then write forward/reverse
+        // into that enum. noDirection drops the characteristic for those fans.
+        this.noDirection = this._coerceBoolean(this.device.context.noDirection, false);
 
         this.maxSpeed = parseInt(this.device.context.maxSpeed) || 3;
         this.fanDefaultSpeed = parseInt(this.device.context.fanDefaultSpeed) || 1;
@@ -44,10 +51,21 @@ class SimpleFanAccessory extends BaseAccessory {
             .onGet(() => this.getSpeed())
             .onSet(value => this.setSpeed(value));
 
-        const characteristicFanDirection = serviceFan.getCharacteristic(Characteristic.RotationDirection)
-            .updateValue(this._getFanDirection(dps[this.dpFanDirection]))
-            .onGet(() => this.getFanDirection())
-            .onSet(value => this.setFanDirection(value));
+        let characteristicFanDirection;
+        if (!this.noDirection) {
+            characteristicFanDirection = serviceFan.getCharacteristic(Characteristic.RotationDirection)
+                .updateValue(this._getFanDirection(dps[this.dpFanDirection]))
+                .onGet(() => this.getFanDirection())
+                .onSet(value => this.setFanDirection(value));
+        } else this._removeCharacteristic(serviceFan, Characteristic.RotationDirection);
+
+        let characteristicSwingMode;
+        if (this.dpSwing) {
+            characteristicSwingMode = serviceFan.getCharacteristic(Characteristic.SwingMode)
+                .updateValue(this._getSwingMode(dps[this.dpSwing]))
+                .onGet(() => this.getSwingMode())
+                .onSet(value => this.setSwingMode(value));
+        } else this._removeCharacteristic(serviceFan, Characteristic.SwingMode);
 
         this.device.on('change', (changes, state) => {
             if (changes.hasOwnProperty(this.dpFanOn) && characteristicFanOn.value !== changes[this.dpFanOn])
@@ -61,6 +79,11 @@ class SimpleFanAccessory extends BaseAccessory {
                 if (characteristicFanDirection.value !== dir) characteristicFanDirection.updateValue(dir);
             }
 
+            if (characteristicSwingMode && changes.hasOwnProperty(this.dpSwing)) {
+                const swing = this._getSwingMode(changes[this.dpSwing]);
+                if (characteristicSwingMode.value !== swing) characteristicSwingMode.updateValue(swing);
+            }
+
             this.log.debug('SimpleFan changed: ' + JSON.stringify(state));
         });
     }
@@ -134,6 +157,20 @@ class SimpleFanAccessory extends BaseAccessory {
         return this.setStateAsync(this.dpFanDirection, tuyaVal);
     }
 
+    getSwingMode() {
+        return this._getSwingMode(this.getStateAsync(this.dpSwing));
+    }
+
+    _getSwingMode(dp) {
+        const {Characteristic} = this.hap;
+        return dp ? Characteristic.SwingMode.SWING_ENABLED : Characteristic.SwingMode.SWING_DISABLED;
+    }
+
+    setSwingMode(value) {
+        const {Characteristic} = this.hap;
+        return this.setStateAsync(this.dpSwing, value === Characteristic.SwingMode.SWING_ENABLED);
+    }
+
     convertRotationSpeedFromTuyaToHomeKit(value) {
         const v = parseInt(value) || 0;
         if (v <= 0) return 0;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-tuya-plus",
-  "version": "4.1.0-dev.63",
+  "version": "4.1.0-dev.64",
   "description": "A community-maintained Homebridge plugin for controlling Tuya devices locally over LAN, with an optional Tuya Cloud fallback for whatever the LAN can't reach. Includes new features, fixes, and updated device support. PRs welcome: if it runs, it ships (almost).",
   "main": "index.js",
   "scripts": {

package/test/SimpleFanAccessory.test.js

@@ -0,0 +1,101 @@
+'use strict';
+
+const SimpleFanAccessory = require('../lib/SimpleFanAccessory');
+const { makeInstance, HAP } = require('./support/mocks');
+
+const { SwingMode, RotationDirection } = HAP.Characteristic;
+
+// The mock Fan service shares a single characteristic, so the write-path tests
+// wire the DP fields manually (mirroring what _registerCharacteristics would do)
+// and assert on the conversion helpers and the DP packets that go out. The
+// registration tests below drive _registerCharacteristics itself.
+function makeFan(state = {}, context = {}) {
+    const result = makeInstance(SimpleFanAccessory, state, { type: 'Fan', ...context });
+    const { instance } = result;
+
+    instance.dpFanOn = '1';
+    instance.dpRotationSpeed = '3';
+    instance.dpFanDirection = '2';
+    instance.dpSwing = instance._getCustomDP(context.dpSwing);
+    return result;
+}
+
+// ---------------------------------------------------------------------------
+// _getSwingMode — boolean DP maps to HomeKit SwingMode
+// ---------------------------------------------------------------------------
+describe('SimpleFanAccessory._getSwingMode', () => {
+    test('truthy DP enables swing', () => {
+        const { instance } = makeFan();
+        expect(instance._getSwingMode(true)).toBe(SwingMode.SWING_ENABLED);
+        expect(instance._getSwingMode(1)).toBe(SwingMode.SWING_ENABLED);
+    });
+
+    test('falsy DP disables swing', () => {
+        const { instance } = makeFan();
+        expect(instance._getSwingMode(false)).toBe(SwingMode.SWING_DISABLED);
+        expect(instance._getSwingMode(0)).toBe(SwingMode.SWING_DISABLED);
+        expect(instance._getSwingMode(undefined)).toBe(SwingMode.SWING_DISABLED);
+    });
+});
+
+// ---------------------------------------------------------------------------
+// getSwingMode / setSwingMode — read and write the configured swing DP
+// ---------------------------------------------------------------------------
+describe('SimpleFanAccessory.getSwingMode / setSwingMode', () => {
+    test('getSwingMode reads and converts the swing DP', () => {
+        const { instance } = makeFan({ '4': true }, { dpSwing: 4 });
+        expect(instance.getSwingMode()).toBe(SwingMode.SWING_ENABLED);
+    });
+
+    test('setSwingMode writes a boolean true to the swing DP', () => {
+        const { instance, device } = makeFan({ '4': false }, { dpSwing: 4 });
+        instance.setSwingMode(SwingMode.SWING_ENABLED);
+        expect(device.update).toHaveBeenCalledWith({ '4': true });
+    });
+
+    test('setSwingMode writes a boolean false to the swing DP', () => {
+        const { instance, device } = makeFan({ '4': true }, { dpSwing: 4 });
+        instance.setSwingMode(SwingMode.SWING_DISABLED);
+        expect(device.update).toHaveBeenCalledWith({ '4': false });
+    });
+
+    test('setSwingMode rejects (No Response) and writes nothing when disconnected', async () => {
+        const { instance, device } = makeFan({ '4': false }, { dpSwing: 4 });
+        device.connected = false;
+        await expect(instance.setSwingMode(SwingMode.SWING_ENABLED)).rejects.toBeInstanceOf(HAP.HapStatusError);
+        expect(device.update).not.toHaveBeenCalled();
+    });
+});
+
+// ---------------------------------------------------------------------------
+// Registration — SwingMode is opt-in and RotationDirection is opt-out
+// ---------------------------------------------------------------------------
+describe('SimpleFanAccessory._registerCharacteristics', () => {
+    const register = context => {
+        const { instance, accessory } = makeInstance(SimpleFanAccessory, {}, { type: 'Fan', ...context });
+        const service = accessory._mockService;
+        service.getCharacteristic.mockClear();
+        instance._registerCharacteristics(instance.device.state);
+        return service;
+    };
+
+    test('registers SwingMode when dpSwing is configured', () => {
+        const service = register({ dpSwing: 4 });
+        expect(service.getCharacteristic).toHaveBeenCalledWith(SwingMode);
+    });
+
+    test('does not register SwingMode when dpSwing is absent (backwards compatible)', () => {
+        const service = register({});
+        expect(service.getCharacteristic).not.toHaveBeenCalledWith(SwingMode);
+    });
+
+    test('registers RotationDirection by default', () => {
+        const service = register({});
+        expect(service.getCharacteristic).toHaveBeenCalledWith(RotationDirection);
+    });
+
+    test('drops RotationDirection when noDirection is set', () => {
+        const service = register({ noDirection: true });
+        expect(service.getCharacteristic).not.toHaveBeenCalledWith(RotationDirection);
+    });
+});

package/wiki/Supported-Device-Types.md

@@ -732,7 +732,16 @@ These are accessories that may act as a regulator switch or an inbuilt regulator
     "dpRotationSpeed": "2",
 
     /* Override the default datapoint identifier of direction control (forward/reverse) */
-    "dpRotationDirection": 63
+    "dpRotationDirection": 63,
+
+    /* Datapoint of the oscillation switch (a boolean DP). When set, a Swing
+       (oscillation) control is shown in the Home app. Omit if the fan has none. */
+    "dpSwing": 4,
+
+    /* Hide the rotation direction control. Enable for fans that have no
+       forward/reverse, or whose direction datapoint is actually a mode enum,
+       so forward/reverse is never written into it. */
+    "noDirection": true
 }
 ```