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

package/Changelog.md

@@ -14,6 +14,8 @@ All notable changes to this project will be documented in this file. This projec
 * [*] **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.
+* [*] **Tuya Cloud: report real device online/offline status.** Cloud devices previously always showed as reachable. They now mirror Tuya's `online` flag (read from the device record on connect and re-checked when the realtime stream reconnects), so HomeKit shows **"No Response"** when the device is genuinely offline. If the lookup isn't permitted (the project lacks the device-management API), the device is assumed reachable so control is never blocked.
+* [*] **Signal unreachable devices with `HapStatusError`.** The shared getters (`getStateAsync` / `getDividedStateAsync`, used by nearly every accessory's read handlers, plus the irrigation `Active` getter) threw a plain `Error` to make HomeKit show "No Response". Newer Homebridge logs a characteristic warning for that before falling back to a generic status; they now throw `HapStatusError(SERVICE_COMMUNICATION_FAILURE)` directly — same "No Response", no warning spam. No behaviour change for users.
 
 ## 2.0.1 (2021-03-25)
 This update includes the following changes:

package/lib/BaseAccessory.js

@@ -65,6 +65,16 @@ class BaseAccessory {
         return typeof b === 'boolean' ? b : (typeof b === 'string' ? b.toLowerCase().trim() === 'true' : (typeof b === 'number' ? b !== 0 : df));
     }
 
+    // A HapStatusError to throw from a get/set handler when the value can't be
+    // served (device unreachable, or an unusable reading). HomeKit shows the
+    // accessory as "No Response". Preferred over a plain `throw new Error(...)`,
+    // which newer Homebridge logs a characteristic warning for before falling
+    // back to this same status code (SERVICE_COMMUNICATION_FAILURE, -70402).
+    _commError() {
+        const {HapStatusError, HAPStatus} = this.hap;
+        return new HapStatusError(HAPStatus.SERVICE_COMMUNICATION_FAILURE);
+    }
+
     getState(dp, callback) {
         if (!this.device.connected) return callback(true);
         const _callback = () => {
@@ -120,7 +130,7 @@ class BaseAccessory {
     }
 
     getStateAsync(dp) {
-        if (!this.device.connected) throw new Error('Not connected');
+        if (!this.device.connected) throw this._commError();
         if (Array.isArray(dp)) {
             const ret = {};
             dp.forEach(p => { ret[p] = this.device.state[p]; });
@@ -155,7 +165,7 @@ class BaseAccessory {
 
     getDividedStateAsync(dp, divisor) {
         const data = this.getStateAsync(dp);
-        if (!isFinite(data)) throw new Error('Invalid state');
+        if (!isFinite(data)) throw this._commError();
         return this._getDividedState(data, divisor);
     }
 

package/lib/IrrigationSystemAccessory.js

@@ -373,7 +373,7 @@ class IrrigationSystemAccessory extends BaseAccessory {
     // 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');
+        if (!this.device.connected) throw this._commError();
         return char.value;
     }
 

package/lib/SimpleHeaterAccessory.js

@@ -147,7 +147,7 @@ class SimpleHeaterAccessory extends BaseAccessory {
 
     _getCurrentTempAsync() {
         const data = this.getStateAsync(this.dpCurrentTemperature);
-        if (!isFinite(data)) throw new Error('Invalid state');
+        if (!isFinite(data)) throw this._commError();
         return this._getDividedState(data, this.temperatureDivisor, this.currentTemperatureOffset);
     }
 }

package/lib/TuyaCloudApi.js

@@ -214,6 +214,15 @@ class TuyaCloudApi {
         return (res && Array.isArray(res.result)) ? res.result : [];
     }
 
+    // Read the device record (name, product, and crucially `online`). Used to
+    // learn whether the device is currently reachable. Returns the raw `result`
+    // object or null. Requires the project to have the device-management API
+    // authorized; callers treat a failure as "online unknown".
+    async getDeviceInfo(deviceId) {
+        const res = await this.request('GET', `/v1.0/devices/${encodeURIComponent(deviceId)}`);
+        return (res && res.result && typeof res.result === 'object') ? res.result : null;
+    }
+
     // Issue one or more commands: [{code, value}, …].
     async sendCommands(deviceId, commands) {
         if (!Array.isArray(commands) || !commands.length) return true;

package/lib/TuyaCloudDevice.js

@@ -66,7 +66,7 @@ class TuyaCloudDevice extends EventEmitter {
         try {
             const status = await this.api.getStatus(this.context.id);
             this.state = this._statusToState(status);
-            this.connected = true;
+            this.connected = await this._readOnline();
 
             this._logDiscoveredCodes(status);
 
@@ -102,6 +102,11 @@ class TuyaCloudDevice extends EventEmitter {
     async _refreshState() {
         if (this._stopped) return;
         try {
+            const online = await this._readOnline();
+            if (this.connected !== online) {
+                this.connected = online;
+                this.log.info(`${this.context.name}: Tuya now reports the device ${online ? 'online' : 'offline'}.`);
+            }
             const status = await this.api.getStatus(this.context.id);
             this._applyStatus(status);
         } catch (ex) {
@@ -109,6 +114,20 @@ class TuyaCloudDevice extends EventEmitter {
         }
     }
 
+    // Resolve the device's reachability from Tuya's `online` flag, so HomeKit
+    // shows "No Response" when the device is genuinely offline. If the lookup
+    // isn't available (e.g. the project lacks the device-management API) fall
+    // back to reachable so control is never blocked.
+    async _readOnline() {
+        try {
+            const info = await this.api.getDeviceInfo(this.context.id);
+            if (info && typeof info.online === 'boolean') return info.online;
+        } catch (ex) {
+            this.log.debug(`${this.context.name}: online-status check failed: ${ex.message}`);
+        }
+        return true;
+    }
+
     /* ------------------------------------------------------------------ *
      *  State helpers
      * ------------------------------------------------------------------ */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-tuya-plus",
-  "version": "3.14.0-dev.14",
+  "version": "3.14.0-dev.16",
   "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/BaseAccessory.test.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const BaseAccessory = require('../lib/BaseAccessory');
-const { makeInstance } = require('./support/mocks');
+const { makeInstance, HAP } = require('./support/mocks');
 
 // Minimal concrete subclass — BaseAccessory itself doesn't define _registerCharacteristics
 class TestAccessory extends BaseAccessory {
@@ -158,10 +158,13 @@ describe('getStateAsync', () => {
         expect(instance.getStateAsync(['1', '2'])).toEqual({ '1': true, '2': 50 });
     });
 
-    test('throws when device is not connected', () => {
+    test('throws a comm-failure HapStatusError when device is not connected', () => {
         const { instance, device } = make();
         device.connected = false;
-        expect(() => instance.getStateAsync('1')).toThrow('Not connected');
+        let err;
+        try { instance.getStateAsync('1'); } catch (e) { err = e; }
+        expect(err).toBeInstanceOf(HAP.HapStatusError);
+        expect(err.hapStatus).toBe(HAP.HAPStatus.SERVICE_COMMUNICATION_FAILURE);
     });
 });
 
@@ -231,9 +234,12 @@ describe('getDividedStateAsync', () => {
         expect(instance.getDividedStateAsync('5', 10)).toBeCloseTo(220);
     });
 
-    test('throws when state value is not finite', () => {
+    test('throws a comm-failure HapStatusError when state value is not finite', () => {
         const { instance } = make({ '5': 'bad' });
-        expect(() => instance.getDividedStateAsync('5', 10)).toThrow();
+        let err;
+        try { instance.getDividedStateAsync('5', 10); } catch (e) { err = e; }
+        expect(err).toBeInstanceOf(HAP.HapStatusError);
+        expect(err.hapStatus).toBe(HAP.HAPStatus.SERVICE_COMMUNICATION_FAILURE);
     });
 });
 

package/test/MultiOutletAccessory.test.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const MultiOutletAccessory = require('../lib/MultiOutletAccessory');
-const { makeInstance } = require('./support/mocks');
+const { makeInstance, HAP } = require('./support/mocks');
 
 function makeOutlet(state = {}) {
     return makeInstance(MultiOutletAccessory, state);
@@ -14,10 +14,13 @@ describe('MultiOutletAccessory.getPower', () => {
         expect(instance.getPower('2')).toBe(false);
     });
 
-    test('throws when device is disconnected', () => {
+    test('throws a comm-failure HapStatusError when device is disconnected', () => {
         const { instance, device } = makeOutlet();
         device.connected = false;
-        expect(() => instance.getPower('1')).toThrow('Not connected');
+        let err;
+        try { instance.getPower('1'); } catch (e) { err = e; }
+        expect(err).toBeInstanceOf(HAP.HapStatusError);
+        expect(err.hapStatus).toBe(HAP.HAPStatus.SERVICE_COMMUNICATION_FAILURE);
     });
 });
 

package/test/TuyaCloudApi.test.js

@@ -138,6 +138,14 @@ describe('TuyaCloudApi — endpoints', () => {
         await expect(api.getStatus('dev')).resolves.toEqual([{code: 'switch_1', value: true}]);
     });
 
+    test('getDeviceInfo returns the device record (with online status)', async () => {
+        const api = ready();
+        let path;
+        api._httpsRequest = async (method, p) => { path = p; return {success: true, result: {id: 'dev', online: false, name: 'X'}}; };
+        await expect(api.getDeviceInfo('dev')).resolves.toEqual({id: 'dev', online: false, name: 'X'});
+        expect(path).toBe('/v1.0/devices/dev');
+    });
+
     test('sendCommands posts the commands and reports success', async () => {
         const api = ready();
         let captured;

package/test/TuyaCloudDevice.test.js

@@ -9,6 +9,7 @@ function makeApi(status = [{code: 'switch_1', value: false}, {code: 'battery_per
     return {
         isConfigured: () => true,
         getStatus: jest.fn().mockResolvedValue(status),
+        getDeviceInfo: jest.fn().mockResolvedValue({online: true}),
         sendCommands: jest.fn().mockResolvedValue(true)
     };
 }
@@ -77,6 +78,34 @@ describe('TuyaCloudDevice', () => {
         expect(changes).toHaveLength(0);
     });
 
+    test('connect reflects the device online status (offline → not connected)', async () => {
+        const api = makeApi();
+        api.getDeviceInfo.mockResolvedValue({online: false});
+        const dev = makeDevice(api);
+        await dev._connect();
+        expect(api.getDeviceInfo).toHaveBeenCalledWith('dev1');
+        expect(dev.connected).toBe(false);
+    });
+
+    test('online lookup failure → assume reachable (never block control)', async () => {
+        const api = makeApi();
+        api.getDeviceInfo.mockRejectedValue(new Error('no device-management permission'));
+        const dev = makeDevice(api);
+        await dev._connect();
+        expect(dev.connected).toBe(true);
+    });
+
+    test('a state refresh re-checks online and flips connected', async () => {
+        const api = makeApi();
+        const dev = makeDevice(api);
+        await dev._connect();
+        expect(dev.connected).toBe(true);
+
+        api.getDeviceInfo.mockResolvedValue({online: false});
+        await dev._refreshState();
+        expect(dev.connected).toBe(false);
+    });
+
     test('subscribes to realtime and re-reads state when the stream (re)connects', async () => {
         const api = makeApi();
         const messaging = Object.assign(new EventEmitter(), {

package/test/support/mocks.js

@@ -75,6 +75,17 @@ const HAP = {
     },
     Formats: { FLOAT: 'float', UINT32: 'uint32', UINT16: 'uint16' },
     Perms: { READ: 'pr', NOTIFY: 'ev', WRITE: 'pw' },
+    // Subset of hap-nodejs HAPStatus + the HapStatusError class, so accessories
+    // can signal "No Response" the proper way (throw a HapStatusError from a
+    // get/set handler) and tests can assert on it.
+    HAPStatus: { SUCCESS: 0, SERVICE_COMMUNICATION_FAILURE: -70402 },
+    HapStatusError: class HapStatusError extends Error {
+        constructor(hapStatus) {
+            super('HapStatusError: ' + hapStatus);
+            this.name = 'HapStatusError';
+            this.hapStatus = hapStatus;
+        }
+    },
     // 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).