homebridge-tuya-plus 3.14.0-dev.12 → 3.14.0-dev.14

package/Changelog.md

@@ -12,6 +12,8 @@ All notable changes to this project will be documented in this file. This projec
 * [*] **Fix realtime (MQTT) cloud updates being silently dropped** — external changes (physical buttons, the Tuya app, the device's own timers) now show up in HomeKit within a second or two. The decryptor was verifying the AES-GCM auth tag (`decipher.final()`), but Tuya's real status frames don't carry a tag that verifies against the documented AAD, so every realtime message was being thrown away. Now decrypts with `update()` only, matching the official `tuya/tuya-homebridge` and `0x5e/homebridge-tuya-platform` implementations.
 * [*] **Fix cloud irrigation valves that could be turned on but not off** — the per-zone write coalescer was dropping any command that matched the last-known `device.state`. Cloud devices never optimistically advance `state` (it only moves once the realtime stream confirms the device), so an "off" issued before the "on" was echoed matched the stale "off" and was discarded — HomeKit showed the zone closed while it kept running. Queued commands are now sent as-is (callers already queue only genuine changes).
 * [*] **IrrigationSystem: remove the rain sensor.** It never reported reliably on these devices, and bundling a sensor (a different HomeKit category) in the same accessory forced the Home app to fragment the sprinkler into "sub-accessories" — blocking control from the main tile and hiding the system master on/off. The accessory is now a single, clean sprinkler tile (IrrigationSystem + valves + optional battery); any leftover Contact/Leak sensor service from a previous build is removed automatically on restart. The `noRainSensor`, `rainSensorType`, `rainInverted`, `dpRain` and `rainOnValue` options are gone.
+* [*] **IrrigationSystem: add the HAP Service Label service for multi-valve controllers** — an accessory that exposes a collection of same-type services (more than one `Valve`) must include a `ServiceLabel` service to anchor each valve's `ServiceLabelIndex`. It was missing, so stricter Home app clients (notably iOS) scattered the zones as separate tiles instead of nesting them under the single irrigation tile. The service is added automatically (with the Arabic-numerals namespace) whenever there is more than one valve; user-set zone names still take precedence.
+* [*] **IrrigationSystem: stop the valve toggle flickering after a press** — tapping a zone briefly snapped back to the old state before settling on the new one. The `Active` getters returned the raw `device.state`, which (for cloud devices) only advances once the realtime stream echoes the write back, so a read in that window reported the pre-press value. The getters now report the value HomeKit already shows (optimistic on press, then confirmed/corrected by device-side change events); they still surface "No Response" while disconnected.
 
 ## 2.0.1 (2021-03-25)
 This update includes the following changes:

package/lib/IrrigationSystemAccessory.js

@@ -13,6 +13,8 @@ const BaseAccessory = require('./BaseAccessory');
  *     ├─ Valve  "Zone A"   (linked, ValveType=IRRIGATION, ServiceLabelIndex 1)
  *     ├─ Valve  "Zone B"   (linked, ServiceLabelIndex 2)
  *     ├─ ...
+ *   ServiceLabel       (labels the multi-valve collection so the Home app nests
+ *                       the zones under the system tile; added when >1 valve)
  *   Battery            (BatteryLevel + StatusLowBattery)
  *
  * Each Valve carries its own SetDuration/RemainingDuration so the Home app shows
@@ -140,6 +142,25 @@ class IrrigationSystemAccessory extends BaseAccessory {
             irrigation.addLinkedService(valve);
         });
 
+        // --- Service Label (required when the accessory exposes a *collection*
+        //     of same-type services, i.e. more than one Valve) ---
+        // HAP's Service Label profile says an accessory holding several services
+        // of the same type must carry a Service Label service, with each member
+        // service tagged by a ServiceLabelIndex. We already set the indices; the
+        // anchoring Service Label service was missing. Without it the stricter
+        // Home app clients (notably iOS) scatter the zones as separate tiles
+        // rather than nesting them under the irrigation system — macOS happens to
+        // render leniently either way. The namespace is set in
+        // _registerCharacteristics. A single-valve system is not a collection, so
+        // it needs no label.
+        const multiValve = valveConfigs.length > 1;
+        const existingLabel = this.accessory.getService(Service.ServiceLabel);
+        if (multiValve && !existingLabel) {
+            this.accessory.addService(Service.ServiceLabel, this.device.context.name);
+        } else if (!multiValve && existingLabel) {
+            this.accessory.removeService(existingLabel);
+        }
+
         // --- Battery (optional) ---
         if (this._hasBattery()) {
             if (!this.accessory.getService(Service.Battery)) {
@@ -217,7 +238,7 @@ class IrrigationSystemAccessory extends BaseAccessory {
 
         this._systemActiveChar = irrigation.getCharacteristic(Characteristic.Active)
             .updateValue(this._anyValveOn() ? Characteristic.Active.ACTIVE : Characteristic.Active.INACTIVE)
-            .onGet(() => this._anyValveOn() ? Characteristic.Active.ACTIVE : Characteristic.Active.INACTIVE)
+            .onGet(() => this._reportCached(this._systemActiveChar))
             .onSet(value => this._setSystemActive(value));
 
         this._systemInUseChar = irrigation.getCharacteristic(Characteristic.InUse)
@@ -260,10 +281,10 @@ class IrrigationSystemAccessory extends BaseAccessory {
                 .updateValue(0)
                 .onGet(() => this._valveRemaining(cfg));
 
-            valve.getCharacteristic(Characteristic.Active)
+            const activeChar = valve.getCharacteristic(Characteristic.Active)
                 .updateValue(on ? Characteristic.Active.ACTIVE : Characteristic.Active.INACTIVE)
-                .onGet(() => (this.getStateAsync(cfg.dp) ? 1 : 0))
                 .onSet(value => this._setValveActive(cfg, value));
+            activeChar.onGet(() => this._reportCached(activeChar));
 
             valve.getCharacteristic(Characteristic.InUse)
                 .updateValue(on ? Characteristic.InUse.IN_USE : Characteristic.InUse.NOT_IN_USE);
@@ -273,6 +294,19 @@ class IrrigationSystemAccessory extends BaseAccessory {
             if (on) this._reflectValve(cfg, true);
         });
 
+        // --- Service Label namespace ---
+        // Anchors the per-valve ServiceLabelIndex so the Home app groups the
+        // zones under the irrigation tile (see _verifyCachedPlatformAccessory).
+        // Arabic numerals: zones are labelled 1, 2, 3… — the user-set zone names
+        // (ConfiguredName) still take precedence in the Home app.
+        if (this._valves.length > 1) {
+            const serviceLabel = this.accessory.getService(Service.ServiceLabel);
+            if (serviceLabel) {
+                serviceLabel.getCharacteristic(Characteristic.ServiceLabelNamespace)
+                    .updateValue(Characteristic.ServiceLabelNamespace.ARABIC_NUMERALS);
+            }
+        }
+
         // --- Battery ---
         if (this._hasBattery()) {
             const battery = this.accessory.getService(Service.Battery);
@@ -330,6 +364,19 @@ class IrrigationSystemAccessory extends BaseAccessory {
         if (valveChanged) this._syncAggregate();
     }
 
+    // onGet handler for the system / valve Active characteristics. Returns the
+    // value HomeKit already shows — the optimistic value written on press and
+    // then confirmed (or corrected) by device-side change events — rather than
+    // the raw `device.state`. Cloud devices don't advance `device.state` until
+    // the realtime stream echoes the write back, so reading it here returned the
+    // pre-press value for a moment and made the Home app toggle visibly flicker
+    // back to the old state before settling. Throwing while disconnected keeps
+    // the HomeKit "No Response" behaviour.
+    _reportCached(char) {
+        if (!this.device.connected) throw new Error('Not connected');
+        return char.value;
+    }
+
     /* ------------------------------------------------------------------ *
      *  Valve activation + timer logic
      * ------------------------------------------------------------------ */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-tuya-plus",
-  "version": "3.14.0-dev.12",
+  "version": "3.14.0-dev.14",
   "description": "A community-maintained Homebridge plugin for controlling Tuya devices locally over LAN. Includes new features, fixes, and updated device support.",
   "main": "index.js",
   "scripts": {

package/test/IrrigationSystemAccessory.test.js

@@ -154,6 +154,19 @@ describe('IrrigationSystemAccessory — service topology', () => {
         });
     });
 
+    test('adds a ServiceLabel (ARABIC_NUMERALS) so the multi-valve zones group under the system', () => {
+        const { accessory } = makeHarness({ '1': false, '2': false, '3': false, '4': false });
+        const label = accessory.getService(Service.ServiceLabel);
+        expect(label).toBeDefined();
+        expect(label.getCharacteristic(Characteristic.ServiceLabelNamespace).value)
+            .toBe(Characteristic.ServiceLabelNamespace.ARABIC_NUMERALS);
+    });
+
+    test('a single-valve system omits the ServiceLabel (no collection to label)', () => {
+        const { accessory } = makeHarness({ '1': false }, { valveCount: 1 });
+        expect(accessory.getService(Service.ServiceLabel)).toBeUndefined();
+    });
+
     test('IrrigationSystem advertises the required characteristics', () => {
         const { accessory } = makeHarness({ '1': false });
         const irr = irrigation(accessory);
@@ -285,6 +298,38 @@ describe('IrrigationSystemAccessory — valve activation & timer', () => {
         jest.advanceTimersByTime(600 * 1000);
         expect(device.update.mock.calls.length).toBe(calls);
     });
+
+    test('valve Active onGet reports the optimistic value, not the lagging device state (no flicker)', () => {
+        // Cloud devices don't advance device.state until the realtime stream
+        // echoes the write back. Emulate that (update is a no-op on state) and
+        // confirm a freshly-pressed valve keeps reading ON instead of briefly
+        // reverting to the pre-press value.
+        const { accessory, device } = makeHarness({ '1': false }, { defaultDuration: 0 });
+        device.update.mockImplementation(() => true);
+        const v = valve(accessory, 1);
+
+        v.getCharacteristic(Characteristic.Active).triggerSet(1);
+        jest.advanceTimersByTime(500);
+
+        expect(device.state['1']).toBe(false); // not echoed yet
+        expect(v.getCharacteristic(Characteristic.Active).triggerGet()).toBe(Characteristic.Active.ACTIVE);
+    });
+
+    test('system Active onGet reports the cached aggregate, not the lagging device state', () => {
+        const { accessory, device } = makeHarness({ '1': false, '2': false }, { defaultDuration: 0 });
+        device.update.mockImplementation(() => true);
+        valve(accessory, 1).getCharacteristic(Characteristic.Active).triggerSet(1);
+        jest.advanceTimersByTime(500);
+
+        expect(irrigation(accessory).getCharacteristic(Characteristic.Active).triggerGet())
+            .toBe(Characteristic.Active.ACTIVE);
+    });
+
+    test('Active onGet still throws while disconnected (HomeKit shows "No Response")', () => {
+        const { accessory, device } = makeHarness({ '1': false });
+        device.connected = false;
+        expect(() => valve(accessory, 1).getCharacteristic(Characteristic.Active).triggerGet()).toThrow();
+    });
 });
 
 describe('IrrigationSystemAccessory — write batching (one Tuya command)', () => {

package/test/support/mocks.js

@@ -34,6 +34,7 @@ const HAP = {
         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' },
+        ServiceLabelNamespace: { UUID: 'CD', DOTS: 0, ARABIC_NUMERALS: 1 },
         ConfiguredName: { UUID: 'E3' },
         BatteryLevel: { UUID: '68' },
         StatusLowBattery: { UUID: '79', BATTERY_LEVEL_NORMAL: 0, BATTERY_LEVEL_LOW: 1 },
@@ -65,6 +66,7 @@ const HAP = {
         LockMechanism: { UUID: '45' },
         Valve: { UUID: 'D0' },
         IrrigationSystem: { UUID: 'CF' },
+        ServiceLabel: { UUID: 'CC' },
         Battery: { UUID: '96' },
         ContactSensor: { UUID: '80' },
         LeakSensor: { UUID: '83' },