homebridge-tuya-plus 3.13.0 → 3.13.1-dev.2

package/test/support/mocks.js

@@ -27,10 +27,19 @@ const HAP = {
         LockCurrentState: { UNSECURED: 0, SECURED: 1, JAMMED: 2, UNKNOWN: 3 },
         RotationDirection: { CLOCKWISE: 0, COUNTER_CLOCKWISE: 1 },
         RotationSpeed: { UUID: '29' },
-        ValveType: { UUID: 'D5' },
-        InUse: { UUID: 'D2' },
+        ValveType: { UUID: 'D5', GENERIC_VALVE: 0, IRRIGATION: 1, SHOWER_HEAD: 2, WATER_FAUCET: 3 },
+        InUse: { UUID: 'D2', NOT_IN_USE: 0, IN_USE: 1 },
         SetDuration: { UUID: 'D3' },
         RemainingDuration: { UUID: 'D4' },
+        ProgramMode: { UUID: 'D1', NO_PROGRAM_SCHEDULED: 0, PROGRAM_SCHEDULED: 1, PROGRAM_SCHEDULED_MANUAL_MODE: 2 },
+        IsConfigured: { UUID: 'D6', NOT_CONFIGURED: 0, CONFIGURED: 1 },
+        ServiceLabelIndex: { UUID: 'CB' },
+        ConfiguredName: { UUID: 'E3' },
+        BatteryLevel: { UUID: '68' },
+        StatusLowBattery: { UUID: '79', BATTERY_LEVEL_NORMAL: 0, BATTERY_LEVEL_LOW: 1 },
+        ChargingState: { UUID: '8F', NOT_CHARGING: 0, CHARGING: 1, NOT_CHARGEABLE: 2 },
+        ContactSensorState: { UUID: '6A', CONTACT_DETECTED: 0, CONTACT_NOT_DETECTED: 1 },
+        LeakDetected: { UUID: '70', LEAK_NOT_DETECTED: 0, LEAK_DETECTED: 1 },
         HeatingThresholdTemperature: { UUID: '12' },
         CoolingThresholdTemperature: { UUID: '0D' },
         CurrentTemperature: { UUID: '11' },
@@ -55,11 +64,30 @@ const HAP = {
         TemperatureSensor: { UUID: '8A' },
         LockMechanism: { UUID: '45' },
         Valve: { UUID: 'D0' },
+        IrrigationSystem: { UUID: 'CF' },
+        Battery: { UUID: '96' },
+        ContactSensor: { UUID: '80' },
+        LeakSensor: { UUID: '83' },
         Doorbell: { UUID: '41' },
         AccessoryInformation: { UUID: '3E' },
     },
     Formats: { FLOAT: 'float', UINT32: 'uint32', UINT16: 'uint16' },
     Perms: { READ: 'pr', NOTIFY: 'ev', WRITE: 'pw' },
+    // Mirrors hap-nodejs Categories. Intentionally kept faithful to the real
+    // enum (no FANLIGHT, no bare DEHUMIDIFIER) so getCategory() regressions are
+    // caught here instead of in production (see issue #45).
+    Categories: {
+        OTHER: 1, BRIDGE: 2, FAN: 3, GARAGE_DOOR_OPENER: 4, LIGHTBULB: 5,
+        DOOR_LOCK: 6, OUTLET: 7, SWITCH: 8, THERMOSTAT: 9, SENSOR: 10,
+        ALARM_SYSTEM: 11, SECURITY_SYSTEM: 11, DOOR: 12, WINDOW: 13,
+        WINDOW_COVERING: 14, PROGRAMMABLE_SWITCH: 15, RANGE_EXTENDER: 16,
+        CAMERA: 17, IP_CAMERA: 17, VIDEO_DOORBELL: 18, AIR_PURIFIER: 19,
+        AIR_HEATER: 20, AIR_CONDITIONER: 21, AIR_HUMIDIFIER: 22,
+        AIR_DEHUMIDIFIER: 23, APPLE_TV: 24, HOMEPOD: 25, SPEAKER: 26,
+        AIRPORT: 27, SPRINKLER: 28, FAUCET: 29, SHOWER_HEAD: 30,
+        TELEVISION: 31, TARGET_CONTROLLER: 32, ROUTER: 33, AUDIO_RECEIVER: 34,
+        TV_SET_TOP_BOX: 35, TV_STREAMING_STICK: 36,
+    },
 };
 
 function makeMockCharacteristic(initialValue = null) {

package/wiki/Supported-Device-Types.md

@@ -15,10 +15,10 @@ If you are looking for verified configurations for your specific device, please
 |Barely Smart Power Strip|`Outlet`|Smart power strips that don't allow individual control of the outlets|
 |Air Conditioner|`AirConditioner`<sup>[6](#air-conditioners)</sup>|Cooling and heating devices <small>([instructions](#air-conditioners))</small>|
 |Heat Convector|`Convector`<sup>[7](#heat-convectors)</sup>|Heating panels <small>([instructions](#heat-convectors))</small>|
-|Simple Dimmer|`SimpleDimmer`<sup>[8](#simple-dimmers)</sup>|Dimmer switches with power control <small>([instructions](#simple-dimmers))</small>|
+|WLED Dimmer|`WledDimmer` (or legacy `SimpleDimmer`)<sup>[8](#simple-dimmers)</sup>|Dimmer switches with power control, with optional WLED sync <small>([instructions](#simple-dimmers))</small>|
 |Simple Heater|`SimpleHeater`<sup>[9](#simple-heaters)</sup>|Heating solutions with only temperature control <small>([instructions](#simple-heaters))</small>|
 |Garage Door|`GarageDoor`<sup>[10](#garage-doors)</sup>|Smart garage doors or garage door openers <small>([instructions](#garage-doors))</small>|
-|Simple Garage Door|`SimpleGarageDoor`<sup>[10](#simple-garage-doors)</sup>|Garage doors and sliding gate openers that expose only three momentary action DPs: open, stop, close <small>([instructions](#simple-garage-doors))</small>|
+|Simple Garage Door|`SimpleGarageDoor`<sup>[10](#simple-garage-doors)</sup>|Sliding gate openers and garage door controllers with open/stop/close action DPs and a simple three-value status DP <small>([instructions](#simple-garage-doors))</small>|
 |Simple Blinds|`SimpleBlinds`<sup>[11](#simple-blinds)</sup>|Smart blinds and smart switches that control blinds <small>([instructions](#simple-blinds))</small>|
 |Simple Blinds2|`SimpleBlinds2`<sup>[11](#simple-blinds)</sup>|Smart blinds and smart switches that control blinds(Use if simple Blinds (1) doesn't work for you. <small>([instructions](#simple-blinds))</small>|
 |Vertical Blinds with Tilt|`VerticalBlindsWithTilt`<sup>[11](#vertical-blinds-with-tilt)</sup>|Smart vertical blinds with open/close and panel rotation <small>([instructions](#vertical-blinds-with-tilt))</small>|
@@ -316,13 +316,20 @@ If your signature doesn't have a variation of _low_ or _high_, `SimpleHeater` wo
 }
 ```
 
-### Simple Dimmers
-These are switches allow turning on and off, and dimming. 
+### Simple Dimmers / WLED Dimmers
+These are switches that allow turning on and off, and dimming. Use type `WledDimmer` (legacy `SimpleDimmer` alias is also supported for backward compatibility).
+
+When using with a WLED controller (e.g. a Tuya-based relay/dimmer feeding power to a WLED strip), you can use advanced sync options:
+
+- `syncBrightnessToWled`: set to WLED device IP (e.g. "192.168.1.50" or "192.168.1.50:80") to sync HomeKit brightness changes directly to WLED over HTTP, keeping the Tuya dimmer at 100%.
+- `presetEffects`: array of effect configs to expose as switches in HomeKit (each turns on a WLED fx preset, optionally with staticColor).
+
+See the accessory source for full details on WLED integration.
 
 ```json5
 {
-    "name": "My Simple Dimmer",
-    "type": "SimpleDimmer",
+    "name": "My WLED Dimmer",
+    "type": "WledDimmer",
     "manufacturer": "TESSAN",
     "model": "Smart Dimmer Switch",
     "id": "032000123456789abcde",
@@ -334,11 +341,19 @@ These are switches allow turning on and off, and dimming.
     "dpPower": 1,
 
     /* Override the default datapoint identifier for brightness */
-    "dpBrightness": 2
+    "dpBrightness": 2,
 
     /* Override the default datapoint identifier for scaleBrightness. Common values are 255 or 1000 */
-    "scaleBrightness": 1000
+    "scaleBrightness": 1000,
 
+    /* WLED sync: forward brightness to a WLED instance instead of using the Tuya dimmer's level */
+    "syncBrightnessToWled": "192.168.1.123",
+
+    /* Optional preset effect switches (for WLED) */
+    "presetEffects": [
+      { "name": "Solid", "fx": 0, "staticColor": "#FFFFFF" },
+      { "name": "Rainbow", "fx": 2 }
+    ]
 }
 ```
 
@@ -404,7 +419,21 @@ While still in early testing, you can use this to open and close the garage door
 ```
 
 ### Simple Garage Doors
-For very basic garage door openers and sliding gate controllers that expose only three momentary action DPs — one to open, one to stop, one to close — with no position or status feedback. The plugin tracks the target state locally and persists it across restarts, so HomeKit always reflects whatever was last requested. Triggering a change sends the stop command first (so reversing direction mid-motion works; it is a no-op when the gate is idle) and then the open or close command. There is no obstruction detection.
+For sliding gate openers and garage door controllers that expose momentary
+open/stop/close action DPs plus a single status DP that reports the gate's
+movement. The controller only distinguishes three states — `11` (stopped),
+`12` (opening or open) and `13` (closing or closed) — so the plugin collapses
+them for HomeKit: `11`/`12` are treated as **OPEN** and `13` as **CLOSED**.
+Both the current and target door state are mirrored straight from this DP, so
+HomeKit stays in sync however the gate was operated (Home app, a physical
+remote, the Tuya app, ...).
+
+Opening is direct: the controller reverses on its own, so an open command is
+fired straight away even while the gate is closing. Closing is asymmetric — the
+controller ignores a close command while the gate is actively moving. So unless
+the status DP already reads `11` (stopped, e.g. after a partial-open or an
+external stop, where close is accepted immediately), a close is sent as
+**stop → wait `stopBeforeCloseMs` → close**. There is no obstruction detection.
 
 ```json5
 {
@@ -418,28 +447,39 @@ For very basic garage door openers and sliding gate controllers that expose only
     /* Additional parameters to override defaults only if needed */
 
     /* Override the default datapoint identifier for the open action */
-    "dpOpen": 1,
-
-    /* Override the default datapoint identifier for the stop action */
-    "dpStop": 2,
+    "dpOpen": 101,
 
     /* Override the default datapoint identifier for the close action */
-    "dpClose": 3,
+    "dpClose": 102,
+
+    /* Override the default datapoint identifier for the stop action
+       (used by the partial-open feature and the stop-before-close) */
+    "dpStop": 103,
+
+    /* Override the default datapoint identifier for the reported state.
+       11 (stopped) and 12 (opening/open) are treated as OPEN; 13
+       (closing/closed) is treated as CLOSED. */
+    "dpState": 105,
+
+    /* Optional. The controller ignores a close while the gate is moving,
+       so unless the state DP already reads 11 (stopped) the plugin sends
+       stop, waits this many milliseconds, then sends close. Tune to about
+       how long the gate takes to halt after a stop. Default 1500. */
+    "stopBeforeCloseMs": 1500,
 
     /* Optional. If set, exposes an extra stateful switch that mirrors
        whether the gate is currently open in HomeKit's view. Tapping it
        ON triggers a partial-open: the gate opens and then stops itself
-       this many milliseconds after the device acknowledges the open,
-       leaving the gate partially open. Tapping it OFF triggers a
-       standard full close. Useful for letting someone pass through
-       briefly. Leave unset to skip the switch. */
+       this many milliseconds later, leaving the gate partially open.
+       Tapping it OFF triggers a standard full close. Useful for letting
+       someone pass through briefly. Leave unset to skip the switch. */
     "partialOpenMs": 2000,
 
     /* Optional. Exposes extra Force Open and Force Close momentary
-       switches alongside the main GarageDoorOpener. They drive the gate
-       through the same queue as the main toggle, but being plain
-       switches they can be used in HomeKit automations (which won't
-       accept GarageDoorOpener targets directly). Default false. */
+       switches alongside the main GarageDoorOpener. They fire the same
+       open/close actions as the main toggle, but being plain switches
+       they can be used in HomeKit automations (which won't accept
+       GarageDoorOpener targets directly). Default false. */
     "forceSwitches": true
 }
 ```
@@ -663,3 +703,108 @@ These are accessories that combine fan and lighting control in one device. Suppo
     "dpRotationDirection": 63
 }
 ```
+
+If the light, brightness and turning the fan **off** all work, but turning the fan **on** or changing its speed is silently ignored, your fan's firmware most likely rejects LAN packets that carry more than one data point at once (some `fsd` ceiling fans behave this way). Set `"singleDpWrites": true` to send the fan power and speed as separate packets — matching how the Tuya cloud issues these commands:
+
+```json5
+{
+    "type": "FanLight",
+    "name": "My Fan with Light",
+    "id": "032000123456789abcde",
+    "key": "0123456789abcdef",
+
+    "dpActive": 60,
+    "dpRotationSpeed": 62,
+
+    /* Send each data point in its own packet instead of combining them. */
+    "singleDpWrites": true
+}
+```
+
+### Irrigation Systems / Sprinklers
+
+Multi-valve Tuya irrigation/sprinkler controllers (the battery-powered Wi-Fi "faucet timers" that expose several `switch_*` valves, a `battery_percentage` and a `rain_sensor_state`) are exposed as a single, fully-fledged HomeKit **Irrigation System** accessory:
+
+* one **Irrigation System** tile that contains every zone,
+* one **Valve** per zone (`ValveType = Irrigation`) — each with its own on/off, its own **Duration** picker and a live countdown,
+* an optional **Battery** service (level, low-battery warning, and — for solar/USB-C rechargeable units that report it — live charging status),
+* an optional **rain sensor** (a Contact sensor by default).
+
+Because these devices are slow to respond, all zone changes that happen close together — turning the whole system on/off, or running a scene that toggles several zones — are merged into a **single** Tuya command instead of a burst of them.
+
+#### Minimal Configuration
+
+The defaults match the common 4-zone layout (valves A–D on data-points `1`–`4`, battery on `46`, rain on `49`):
+
+```json5
+{
+    "name": "Garden Irrigation",
+    "type": "IrrigationSystem",
+    "manufacturer": "Generic",
+    "model": "4-Zone Water Timer",
+    "id": "032000123456789abcde",
+    "key": "0123456789abcdef"
+}
+```
+
+#### Per-zone timers and "indefinite" mode
+
+Each zone has its own **Duration**. When a zone is switched on it runs for that duration and the plugin closes it automatically (HomeKit's countdown is display-only — the plugin always enforces the shut-off, even after a Homebridge restart).
+
+* Set a zone's duration to **`0`** to make it run **indefinitely** (until it is switched off again) — handy for long, manual watering tasks.
+* Apple's Home app only offers duration presets up to **1 hour**. For longer runs (up to `maxDuration`) or to preset "indefinite" zones, set `defaultDuration` / the per-valve `defaultDuration` in the config, or use the Eve app.
+
+#### Master ("toggle all") switch
+
+Switching the whole Irrigation System tile **off** closes every open zone, and switching it **on** opens every zone — each as one combined command (mirroring the physical "all" button many of these controllers have). Either direction can be disabled with `masterTurnsOffAllZones` / `masterTurnsOnAllZones`.
+
+#### Rain sensor: Contact vs Leak
+
+By default the rain sensor is a **Contact sensor** (`raining → Open`). You can switch it to a **Leak sensor** (`raining → Leak Detected`) with `"rainSensorType": "leak"` — leak sensors read more naturally for rain and make "when it starts raining" automations obvious, **but HomeKit treats them as safety accessories and raises critical alerts that bypass Do-Not-Disturb on every rainfall**, which many people find too noisy. Use `rainInverted` if the wet/dry states appear reversed.
+
+#### Full Configuration
+
+```json5
+{
+    "name": "Garden Irrigation",
+    "type": "IrrigationSystem",
+    "manufacturer": "Generic",
+    "model": "4-Zone Water Timer",
+    "id": "032000123456789abcde",
+    "key": "0123456789abcdef",
+
+    /* --- Zones --- */
+    /* Simple: number of valves on sequential data-points 1, 2, 3, … */
+    "valveCount": 4,
+    /* …or, for custom names / non-sequential data-points, define them explicitly
+       (this overrides valveCount). defaultDuration is in seconds; 0 = indefinite. */
+    "valves": [
+        { "name": "Front Lawn", "dp": 1, "defaultDuration": 900 },
+        { "name": "Back Lawn",  "dp": 2, "defaultDuration": 900 },
+        { "name": "Flower Beds","dp": 3, "defaultDuration": 600 },
+        { "name": "Drip Line",  "dp": 4, "defaultDuration": 0 }
+    ],
+
+    /* --- Timers --- */
+    "defaultDuration": 600,   /* default per-zone run time, seconds (0 = indefinite) */
+    "maxDuration": 7200,      /* upper bound advertised to HomeKit, seconds */
+
+    /* --- Master switch behaviour --- */
+    "masterTurnsOnAllZones": true,
+    "masterTurnsOffAllZones": true,
+    "commandDebounce": 500,   /* ms window for merging zone changes into one command */
+
+    /* --- Battery (omit / set noBattery:true if mains-powered) --- */
+    "dpBattery": 46,
+    "lowBatteryThreshold": 20,
+    "dpCharging": 101,   /* boolean charging-status DP (solar / USB-C); omit if not reported */
+    /* "noBattery": true, */
+
+    /* --- Rain sensor (omit / set noRainSensor:true if not present) --- */
+    "dpRain": 49,
+    "rainSensorType": "contact", /* or "leak" */
+    "rainOnValue": "rain",       /* enum value reported while raining */
+    "rainInverted": false
+    /* "noRainSensor": true, */
+}
+```

package/wiki/User-documented-device-config.md

@@ -17,6 +17,63 @@ Below is a list of configurations for devices by users of the plugin. Please fol
 
 # Dimmer
 
+## Wled Dimmer
+
+**Treatlife Dimmable Smart Plug for Lamps**
+
+
+
+Tested plugin version: ```2.0.1```
+
+Tested by: [@benwtf](https://www.github.com/benwtf)
+
+Link to buy: [Amazon](https://www.amazon.com/Treatlife-Dimmer-Halogen-Incandescent-Outlets/dp/B08LPYXK6L/ref=sr_1_2_sspa)
+
+Capabilities: 
+- [X] On/Off
+- [X] Dimming
+- [ ] Timer (Use Tuya app)
+- [ ] Dimming Config (Use Tuya app)
+
+Config: 
+```json
+            {
+                "type": "WledDimmer",
+                "name": "Lamp",
+                "id": "xxx",
+                "key": "xxx",
+                "manufacturer": "Treatlife",
+                "model": "WiFi Smart Dimmer Plug",
+                "scaleBrightness": 1000,
+				"minBrightness": 10,
+				"syncBrightnessToWled": "192.168.1.239",
+				"presetEffects": [
+					{
+						"name": "White Static",
+						"id": 0,
+						"staticColor": "#ffffff"
+					},
+					{
+						"name": "Cyan Static",
+						"id": 0,
+						"staticColor": "#5cecd9"
+					},
+					{
+						"name": "Juggle",
+						"id": 130
+					},
+					{
+						"name": "Fire",
+						"id": 80
+					}
+				]
+            }
+```
+
+Schema/DP's:
+```
+```
+
 ## Simple Dimmer
 
 **Treatlife Dimmable Smart Plug for Lamps**