homebridge-tuya-plus 4.1.0-dev.68 → 4.1.0-dev.69

package/config.schema.json

@@ -531,7 +531,7 @@
                 "functionBody": "return model.devices && model.devices[arrayIndices] && ['Convector', 'Fan', 'FanLight'].includes(model.devices[arrayIndices].type);"
               }
             },
-            "dpRotationDirection": {
+            "dpFanDirection": {
               "type": "integer",
               "placeholder": "63",
               "condition": {
@@ -585,6 +585,51 @@
                 "functionBody": "return model.devices && model.devices[arrayIndices] && ['FanLight'].includes(model.devices[arrayIndices].type);"
               }
             },
+            "lightUseEnum": {
+              "title": "Light uses On/Off text values",
+              "description": "Enable if the light appears in HomeKit but toggling it does nothing. Some fans type the light data point as an enum of text values (e.g. \"On\"/\"Off\") rather than a boolean.",
+              "type": "boolean",
+              "placeholder": false,
+              "condition": {
+                "functionBody": "return model.devices && model.devices[arrayIndices] && ['FanLight'].includes(model.devices[arrayIndices].type);"
+              }
+            },
+            "lightOnCommand": {
+              "title": "Light \"on\" value",
+              "description": "The text value sent to turn the light on when \"Light uses On/Off text values\" is enabled.",
+              "type": "string",
+              "placeholder": "On",
+              "condition": {
+                "functionBody": "return model.devices && model.devices[arrayIndices] && ['FanLight'].includes(model.devices[arrayIndices].type) && model.devices[arrayIndices].lightUseEnum;"
+              }
+            },
+            "lightOffCommand": {
+              "title": "Light \"off\" value",
+              "description": "The text value sent to turn the light off when \"Light uses On/Off text values\" is enabled.",
+              "type": "string",
+              "placeholder": "Off",
+              "condition": {
+                "functionBody": "return model.devices && model.devices[arrayIndices] && ['FanLight'].includes(model.devices[arrayIndices].type) && model.devices[arrayIndices].lightUseEnum;"
+              }
+            },
+            "directionForwardCommand": {
+              "title": "Forward direction value",
+              "description": "The value sent for the normal/forward direction. Set this when direction lives on a shared \"mode\" data point (e.g. Windmode \"Normal\").",
+              "type": "string",
+              "placeholder": "forward",
+              "condition": {
+                "functionBody": "return model.devices && model.devices[arrayIndices] && ['FanLight'].includes(model.devices[arrayIndices].type);"
+              }
+            },
+            "directionReverseCommand": {
+              "title": "Reverse direction value",
+              "description": "The value sent for the reverse direction. Set this when direction lives on a shared \"mode\" data point (e.g. Windmode \"Reverse\").",
+              "type": "string",
+              "placeholder": "reverse",
+              "condition": {
+                "functionBody": "return model.devices && model.devices[arrayIndices] && ['FanLight'].includes(model.devices[arrayIndices].type);"
+              }
+            },
             "dpChildLock": {
               "type": "integer",
               "placeholder": "6",

package/lib/SimpleFanLightAccessory.js

@@ -46,6 +46,19 @@ class SimpleFanLightAccessory extends BaseAccessory {
         this.useBrightness = this._coerceBoolean(this.device.context.useBrightness, true);
         this.useColorTemp = this._coerceBoolean(this.device.context.useColorTemp, true);
 
+        // Some fans (e.g. the Orient AEON V.C.) type the light DP as an enum of
+        // 'On'/'Off' strings rather than a boolean. When lightUseEnum is set we
+        // read/write those command strings; otherwise the DP stays a plain bool.
+        this.lightUseEnum = this._coerceBoolean(this.device.context.lightUseEnum, false);
+        this.lightOnCommand = this.device.context.lightOnCommand || 'On';
+        this.lightOffCommand = this.device.context.lightOffCommand || 'Off';
+
+        // The direction DP's forward/reverse command strings are configurable so
+        // fans that carry direction on a shared "mode" DP (e.g. Windmode
+        // 'Normal'/'Reverse') can be mapped onto HomeKit's RotationDirection.
+        this.directionForwardCommand = this.device.context.directionForwardCommand || 'forward';
+        this.directionReverseCommand = this.device.context.directionReverseCommand || 'reverse';
+
         let minWhiteColor = parseInt(this.device.context.minWhiteColor);
         let maxWhiteColor = parseInt(this.device.context.maxWhiteColor);
         if (isNaN(minWhiteColor)) minWhiteColor = DEFAULT_MIN_WHITE_COLOR;
@@ -126,7 +139,8 @@ class SimpleFanLightAccessory extends BaseAccessory {
             }
 
             if (changes.hasOwnProperty(this.dpLightOn) && characteristicLightOn) {
-                if (characteristicLightOn.value !== changes[this.dpLightOn]) characteristicLightOn.updateValue(changes[this.dpLightOn]);
+                const lightOn = this._getLightOn(changes[this.dpLightOn]);
+                if (characteristicLightOn.value !== lightOn) characteristicLightOn.updateValue(lightOn);
             }
 
             if (changes.hasOwnProperty(this.dpBrightness) && characteristicBrightness) {
@@ -204,13 +218,13 @@ class SimpleFanLightAccessory extends BaseAccessory {
 
     _getFanDirection(dp) {
         const {Characteristic} = this.hap;
-        return dp === 'reverse'
+        return dp === this.directionReverseCommand
             ? Characteristic.RotationDirection.COUNTER_CLOCKWISE
             : Characteristic.RotationDirection.CLOCKWISE;
     }
 
     setFanDirection(value) {
-        const tuyaVal = (value === 1) ? 'reverse' : 'forward';
+        const tuyaVal = (value === 1) ? this.directionReverseCommand : this.directionForwardCommand;
         return this.setStateAsync(this.dpFanDirection, tuyaVal);
     }
 
@@ -219,10 +233,14 @@ class SimpleFanLightAccessory extends BaseAccessory {
     }
 
     _getLightOn(dp) {
+        if (this.lightUseEnum) return dp === this.lightOnCommand;
         return !!dp;
     }
 
     setLightOn(value) {
+        if (this.lightUseEnum) {
+            return this.setStateAsync(this.dpLightOn, value ? this.lightOnCommand : this.lightOffCommand);
+        }
         return this.setStateAsync(this.dpLightOn, value);
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-tuya-plus",
-  "version": "4.1.0-dev.68",
+  "version": "4.1.0-dev.69",
   "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/SimpleFanLightAccessory.test.js

@@ -14,13 +14,19 @@ function makeFanLight(state = {}, context = {}) {
 
     instance.dpFanOn = '60';
     instance.dpRotationSpeed = '62';
-    instance.dpFanDirection = '63';
+    instance.dpFanDirection = device.context.dpFanDirection || '63';
+    instance.dpLightOn = device.context.dpLightOn || '20';
     instance.dpColorTemp = '23';
     instance.maxSpeed = parseInt(device.context.maxSpeed) || 6;
     instance.fanDefaultSpeed = parseInt(device.context.fanDefaultSpeed) || 1;
     instance.fanCurrentSpeed = 0;
     instance.useStrings = instance._coerceBoolean(device.context.useStrings, true);
     instance.singleDpWrites = instance._coerceBoolean(device.context.singleDpWrites, false);
+    instance.lightUseEnum = instance._coerceBoolean(device.context.lightUseEnum, false);
+    instance.lightOnCommand = device.context.lightOnCommand || 'On';
+    instance.lightOffCommand = device.context.lightOffCommand || 'Off';
+    instance.directionForwardCommand = device.context.directionForwardCommand || 'forward';
+    instance.directionReverseCommand = device.context.directionReverseCommand || 'reverse';
     if (device.context.minWhiteColor !== undefined) instance.minWhiteColor = parseInt(device.context.minWhiteColor);
     if (device.context.maxWhiteColor !== undefined) instance.maxWhiteColor = parseInt(device.context.maxWhiteColor);
 
@@ -164,6 +170,119 @@ describe('SimpleFanLightAccessory — setFanOn(false)', () => {
     });
 });
 
+// ---------------------------------------------------------------------------
+// Enum light on/off: fans whose Light DP is an 'On'/'Off' enum rather than a
+// boolean (e.g. Orient AEON V.C.). Default stays boolean for compatibility.
+// ---------------------------------------------------------------------------
+describe('SimpleFanLightAccessory — enum light (lightUseEnum)', () => {
+    test('reads the enum command strings, not truthiness', () => {
+        const { instance } = makeFanLight(
+            { '20': 'Off' },
+            { lightUseEnum: true }
+        );
+        // The boolean path would read the non-empty string 'Off' as ON (the bug).
+        expect(instance.getLightOn()).toBe(false);
+        instance.device.state['20'] = 'On';
+        expect(instance.getLightOn()).toBe(true);
+    });
+
+    test('setLightOn writes the On/Off command strings', () => {
+        const { instance, device } = makeFanLight(
+            { '20': 'Off' },
+            { lightUseEnum: true }
+        );
+
+        instance.setLightOn(true);
+        expect(device.update).toHaveBeenCalledWith({ '20': 'On' });
+
+        device.state['20'] = 'On';
+        instance.setLightOn(false);
+        expect(device.update).toHaveBeenCalledWith({ '20': 'Off' });
+    });
+
+    test('honours custom on/off command strings', () => {
+        const { instance, device } = makeFanLight(
+            { '101': 'off' },
+            { dpLightOn: '101', lightUseEnum: true, lightOnCommand: 'on', lightOffCommand: 'off' }
+        );
+
+        expect(instance.getLightOn()).toBe(false);
+        instance.setLightOn(true);
+        expect(device.update).toHaveBeenCalledWith({ '101': 'on' });
+    });
+
+    test('default (flag off) keeps the boolean behaviour', () => {
+        const { instance, device } = makeFanLight({ '20': false });
+
+        expect(instance._getLightOn(true)).toBe(true);
+        expect(instance._getLightOn(false)).toBe(false);
+
+        instance.setLightOn(true);
+        expect(device.update).toHaveBeenCalledWith({ '20': true });
+    });
+});
+
+// ---------------------------------------------------------------------------
+// Configurable direction commands: map a shared "mode" DP (Windmode
+// Normal/Reverse) onto HomeKit's RotationDirection toggle.
+// ---------------------------------------------------------------------------
+describe('SimpleFanLightAccessory — configurable direction commands', () => {
+    const { RotationDirection } = HAP.Characteristic;
+
+    test('reads the reverse command as COUNTER_CLOCKWISE', () => {
+        const { instance } = makeFanLight(
+            { '3': 'Reverse' },
+            { dpFanDirection: '3', directionForwardCommand: 'Normal', directionReverseCommand: 'Reverse' }
+        );
+
+        expect(instance.getFanDirection()).toBe(RotationDirection.COUNTER_CLOCKWISE);
+        instance.device.state['3'] = 'Normal';
+        expect(instance.getFanDirection()).toBe(RotationDirection.CLOCKWISE);
+        // Unrelated Windmode values (e.g. Sleep set from the Tuya app) read as forward.
+        instance.device.state['3'] = 'Sleep';
+        expect(instance.getFanDirection()).toBe(RotationDirection.CLOCKWISE);
+    });
+
+    test('setFanDirection writes the configured command strings', () => {
+        const { instance, device } = makeFanLight(
+            { '3': 'Normal' },
+            { dpFanDirection: '3', directionForwardCommand: 'Normal', directionReverseCommand: 'Reverse' }
+        );
+
+        instance.setFanDirection(RotationDirection.COUNTER_CLOCKWISE);
+        expect(device.update).toHaveBeenCalledWith({ '3': 'Reverse' });
+
+        device.state['3'] = 'Reverse';
+        instance.setFanDirection(RotationDirection.CLOCKWISE);
+        expect(device.update).toHaveBeenCalledWith({ '3': 'Normal' });
+    });
+
+    test('defaults remain forward/reverse when unconfigured', () => {
+        const { instance, device } = makeFanLight({ '63': 'forward' });
+
+        expect(instance._getFanDirection('reverse')).toBe(RotationDirection.COUNTER_CLOCKWISE);
+        instance.setFanDirection(RotationDirection.COUNTER_CLOCKWISE);
+        expect(device.update).toHaveBeenCalledWith({ '63': 'reverse' });
+    });
+});
+
+// ---------------------------------------------------------------------------
+// Direction DP resolution: dpFanDirection overrides the default DP.
+// ---------------------------------------------------------------------------
+describe('SimpleFanLightAccessory — direction DP resolution', () => {
+    test('honours the dpFanDirection config key', () => {
+        const { instance } = makeInstance(SimpleFanLightAccessory, {}, { type: 'FanLight', dpFanDirection: 3 });
+        instance._registerCharacteristics({});
+        expect(instance.dpFanDirection).toBe('3');
+    });
+
+    test('defaults to DP 63 when unset', () => {
+        const { instance } = makeInstance(SimpleFanLightAccessory, {}, { type: 'FanLight' });
+        instance._registerCharacteristics({});
+        expect(instance.dpFanDirection).toBe('63');
+    });
+});
+
 // ---------------------------------------------------------------------------
 // convertColorTempFromTuyaToHomeKit — default range, inverted (issue #44)
 // ---------------------------------------------------------------------------

package/wiki/Supported-Device-Types.md

@@ -820,6 +820,9 @@ Every option below is optional — the defaults match a common 3-speed fan. The
        Default: 3 */
     "maxSpeed": 3,
 
+    /* Override the default datapoint identifier of direction control (forward/reverse) */
+    "dpFanDirection": 63,
+
     /* Speed to use when the fan is switched on from off. Default: 1 */
     "fanDefaultSpeed": 1,
 
@@ -926,6 +929,48 @@ If the light, brightness and turning the fan **off** all work, but turning the f
 }
 ```
 
+#### Lights that use `On`/`Off` text values instead of a boolean
+
+Some fans (e.g. the **Orient AEON V.C.**) type their light data point as an *enum of text values* — it sends `"On"` / `"Off"` strings rather than a boolean. With such a fan the light appears in HomeKit but toggling it does nothing, because the plugin's default light handling expects a boolean. Set `"lightUseEnum": true` to make the plugin read and write the text values instead. The command strings default to `"On"` / `"Off"` and can be overridden with `lightOnCommand` / `lightOffCommand`.
+
+#### Direction carried on a shared "mode" data point
+
+On some fans, forward/reverse is not its own data point — it is one of several values of a shared *mode* data point (e.g. a `Windmode` enum with values like `Normal`, `Reverse`, `Sleep`, `Breeze`). Point `dpFanDirection` at that data point and set `directionForwardCommand` / `directionReverseCommand` to the values it uses (they default to `"forward"` / `"reverse"`). HomeKit's clockwise/counter-clockwise direction toggle then maps onto `Normal` / `Reverse`. Any other mode value (`Sleep`, `Breeze`, …) set from the Tuya app simply reads back as the forward direction.
+
+> Note: because direction shares the mode data point, selecting a normal speed writes `Normal` to it, so the fan can only be in one mode at a time — this mirrors how the physical fan works. Modes that HomeKit has no control for (Turbo, Sleep, Breeze) and the countdown timer are not exposed; set them from the Tuya / Smart Life app.
+
+A full example for the Orient AEON V.C. (Power = DP 1, WindSpeed enum `"1"`–`"5"` = DP 2, Windmode = DP 3, Light enum `"On"`/`"Off"` = DP 101):
+
+```json5
+{
+    "type": "FanLight",
+    "name": "Orient AEON Fan",
+    "id": "032000123456789abcde",
+    "key": "0123456789abcdef",
+
+    /* Power (boolean) */
+    "dpFanOn": 1,
+
+    /* WindSpeed enum "1".."5" — parsed as levels 1..5 and sent as strings */
+    "dpRotationSpeed": 2,
+    "maxSpeed": 5,
+    "useStrings": true,
+
+    /* Light is an "On"/"Off" enum, not a boolean; no brightness/colour temp */
+    "dpLightOn": 101,
+    "lightUseEnum": true,
+    "useBrightness": false,
+    "useColorTemp": false,
+
+    /* Direction lives on the Windmode data point as Normal/Reverse */
+    "dpFanDirection": 3,
+    "directionForwardCommand": "Normal",
+    "directionReverseCommand": "Reverse"
+}
+```
+
+> On this fan, reverse airflow only runs at the lower speeds — that limit is enforced by the fan's own firmware, not the plugin, so the HomeKit speed slider still shows the full range.
+
 ### Irrigation Systems / Sprinklers
 
 Multi-valve Tuya irrigation/sprinkler controllers (the battery-powered Wi-Fi "faucet timers" that expose several `switch_*` valves and a `battery_percentage`) are exposed as a single, fully-fledged HomeKit **Irrigation System** accessory: