homebridge-tuya-plus 3.14.0-dev.4 → 3.14.0-dev.40

package/lib/TuyaCloudDevice.js

@@ -39,17 +39,35 @@ class TuyaCloudDevice extends EventEmitter {
         this.api = props.cloudApi;
         this.messaging = props.messaging || null; // shared realtime stream
 
+        // Lets the cloud backend ask its parent TuyaDevice whether the SAME device
+        // is currently reachable over the LAN. A cloud-fallback failure is harmless
+        // when the LAN is up and worth surfacing when it isn't, so the failure log
+        // adapts to it. Null when used standalone (no LAN sibling).
+        this.isLanConnected = typeof props.isLanConnected === 'function' ? props.isLanConnected : null;
+
         // Keep a plain config object on `context`, mirroring TuyaAccessory, but
         // without the live helper objects we were handed.
         this.context = {...props};
         delete this.context.cloudApi;
         delete this.context.messaging;
         delete this.context.log;
+        delete this.context.isLanConnected;
 
         this.state = {};
         this.connected = false;
         this._stopped = false;
         this._retryTimer = null;
+        this._retryDelay = 0;          // current connect-retry backoff (ms); grows on repeated failure
+        this._lastConnectError = null; // last surfaced connect error, so identical repeats stay quiet
+
+        // Bidirectional data-point maps, learned from the device's thing-shadow on
+        // connect. They let this cloud transport (and the LAN+cloud TuyaDevice that
+        // may wrap it) translate between the LAN's numeric data-point ids and the
+        // cloud's string codes. Empty until the shadow is read; empty means
+        // "code-only" (no numeric bridge), which is still fully functional for a
+        // cloud-configured accessory.
+        this.codeByDpId = {}; // '20'        -> 'switch_led'
+        this.dpIdByCode = {}; // 'switch_led' -> '20'
 
         if (props.connect !== false) this._connect();
     }
@@ -63,12 +81,33 @@ class TuyaCloudDevice extends EventEmitter {
             return this.log.error(`${this.context.name}: Tuya Cloud is not configured (missing accessId/accessKey).`);
         }
 
+        // First connect only: stagger the initial read so a large install doesn't
+        // fire every device's OpenAPI call in the same instant (rate limits). The
+        // platform hands each device an increasing cloudStartDelay.
+        if (!this._staggered) {
+            this._staggered = true;
+            const delay = parseInt(this.context.cloudStartDelay) || 0;
+            if (delay > 0) {
+                await new Promise(resolve => { const t = setTimeout(resolve, delay); if (t.unref) t.unref(); });
+                if (this._stopped) return;
+            }
+        }
+
         try {
-            const status = await this.api.getStatus(this.context.id);
-            this.state = this._statusToState(status);
-            this.connected = true;
+            const props = await this._readInitialProperties();
+            this._learnDpMap(props);
+            this.state = this._propsToState(props);
+            this.connected = await this._readOnline();
+
+            this._logDiscoveredCodes(props);
 
-            this._logDiscoveredCodes(status);
+            // Connected: announce recovery from any earlier failure once, and
+            // reset the retry backoff.
+            if (this._lastConnectError) {
+                this.log.info(`${this.context.name}: Tuya Cloud connection restored.`);
+                this._lastConnectError = null;
+            }
+            this._retryDelay = 0;
 
             this.emit('connect');
             // Accessories register their characteristics off the first 'change'.
@@ -76,12 +115,74 @@ class TuyaCloudDevice extends EventEmitter {
 
             this._subscribeRealtime();
         } catch (ex) {
-            this.log.error(`${this.context.name}: failed to connect to Tuya Cloud: ${ex.message}`);
-            // Retry later — credentials/permissions/network may recover.
-            if (!this._stopped) {
-                this._retryTimer = setTimeout(() => this._connect(), 30000);
-            }
+            this._onConnectFailure(ex);
+        }
+    }
+
+    // A failed connect is retried, but the cause is frequently permanent — the
+    // cloud project can't see this device (permission denied / "no space"), the
+    // datacenter region is wrong, or the device isn't linked to the account — and
+    // won't clear without the user changing their Tuya project. Since PR #71 the
+    // cloud backs *every* device as a fallback, so a LAN-only device whose cloud
+    // project lacks permission would otherwise log an error every 30s forever.
+    // Two things keep that out of the log: a given message is surfaced once and then
+    // suppressed to debug until it changes (or the device connects), and the retry
+    // interval backs off (30s → 30m cap) instead of hammering the OpenAPI.
+    _onConnectFailure(ex) {
+        const message = ex && ex.message ? ex.message : String(ex);
+        const {level, text} = this._describeConnectFailure(message);
+
+        // The full (level + wording) is what the dedup tracks, not just the raw
+        // message: it means a device that flips from "reachable over the LAN"
+        // (harmless, debug) to "not reachable over the LAN either" (warn) re-surfaces
+        // the change, while an unchanged situation stays quiet.
+        if (text !== this._lastConnectError) {
+            this.log[level](text);
+            this._lastConnectError = text;
+        } else {
+            this.log.debug(`${this.context.name}: Tuya Cloud connection still failing: ${message}`);
         }
+
+        if (this._stopped) return;
+        // Exponential backoff: 30s after the first failure, doubling to a 30m cap.
+        this._retryDelay = Math.min(this._retryDelay ? this._retryDelay * 2 : 30000, 1800000);
+        this._retryTimer = setTimeout(() => this._connect(), this._retryDelay);
+        if (this._retryTimer && this._retryTimer.unref) this._retryTimer.unref();
+    }
+
+    // Pick the log level and wording for a connect failure from what we know about
+    // the device: whether the cloud is merely a fallback (the device has a local
+    // key) and, if so, whether that LAN path is reachable right now.
+    _describeConnectFailure(message) {
+        const lanFallback = !!this.context.key;
+        const lanReachable = lanFallback && !!(this.isLanConnected && this.isLanConnected());
+
+        // "permission deny" (1106) is specifically a visibility problem: the cloud
+        // project can't see this device. A device that has been offline for a long
+        // time is a prime candidate for having been removed/unbound/reset, which
+        // produces exactly this — so point at that, but only for this error (a
+        // timeout or token failure is unrelated).
+        const unbound = /permission deny|\b1106\b/i.test(message)
+            ? ' Note: a device left offline for a long time can be removed or unbound from the account (e.g. reset or re-paired), which also produces this "permission deny".'
+            : '';
+
+        let level, hint;
+        if (lanReachable) {
+            // Confirmed reachable over the LAN, so the cloud fallback we couldn't
+            // reach isn't needed. Keep it out of the way at debug.
+            level = 'debug';
+            hint = ' The device is reachable over the LAN, so only the (unused) cloud fallback is affected — harmless.';
+        } else if (lanFallback) {
+            // LAN-capable but not connected right now, so the cloud is currently the
+            // only path and the device may be unresponsive in HomeKit.
+            level = 'warn';
+            hint = ` The cloud is only a fallback, but the device isn't reachable over the LAN right now either, so it may show as unresponsive in HomeKit. Check that it is linked to this cloud project (matching account/home and datacenter region).${unbound}`;
+        } else {
+            level = 'error';
+            hint = ` This device is cloud-only, so it stays unreachable until this clears — check that it is linked to the cloud project (matching account/home and datacenter region).${unbound}`;
+        }
+
+        return {level, text: `${this.context.name}: Tuya Cloud connection failed: ${message}.${hint}`};
     }
 
     /* ------------------------------------------------------------------ *
@@ -102,6 +203,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,27 +215,76 @@ 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
      * ------------------------------------------------------------------ */
 
-    // Convert a Tuya `[{code, value}]` status array into a flat { code: value }.
-    _statusToState(status) {
+    // Read the device's initial data-points. Prefer the thing-shadow (it carries
+    // the numeric dp_id alongside each code, so LAN<->cloud bridging works); fall
+    // back to the plain status endpoint (code+value only) when the shadow isn't
+    // available. Returns an array of {code, value, dp_id?}.
+    async _readInitialProperties() {
+        if (typeof this.api.getShadowProperties === 'function') {
+            const props = await this.api.getShadowProperties(this.context.id);
+            if (Array.isArray(props)) return props;
+        }
+        return this.api.getStatus(this.context.id);
+    }
+
+    // Learn the code <-> numeric dp_id mapping from a shadow-properties read.
+    _learnDpMap(props) {
+        (props || []).forEach(p => {
+            if (!p || typeof p.code !== 'string' || p.dp_id == null) return;
+            const dp = String(p.dp_id);
+            this.codeByDpId[dp] = p.code;
+            this.dpIdByCode[p.code] = dp;
+        });
+    }
+
+    // Index a data-point under BOTH its string code and (when known) its numeric
+    // dp id, so an accessory configured the LAN way (numeric) or the cloud way
+    // (code) both resolve. The dp id comes from the shadow item, or — for code-only
+    // realtime deltas — from the map learned on connect.
+    _indexInto(target, code, value, dpId) {
+        target[code] = value;
+        const dp = dpId != null ? String(dpId) : this.dpIdByCode[code];
+        if (dp != null) target[dp] = value;
+    }
+
+    // Build the dual-keyed state object from a properties/status array.
+    _propsToState(props) {
         const state = {};
-        (status || []).forEach(item => {
-            if (item && typeof item.code === 'string') state[item.code] = item.value;
+        (props || []).forEach(item => {
+            if (item && typeof item.code === 'string') {
+                this._indexInto(state, item.code, item.value, item.dp_id != null ? item.dp_id : item.dpId);
+            }
         });
         return state;
     }
 
     // Apply a fresh snapshot (initial / catch-up) or a realtime delta, diff it
     // against what we hold, and emit only what changed — exactly mirroring
-    // TuyaAccessory._change so accessories behave identically.
+    // TuyaAccessory._change so accessories behave identically. State is dual-keyed
+    // (code + numeric dp) so a LAN-style or cloud-style config both resolve.
     _applyStatus(status) {
-        const incoming = this._statusToState(status);
+        const incoming = this._propsToState(status);
         const changes = {};
-        Object.keys(incoming).forEach(code => {
-            if (incoming[code] !== this.state[code]) changes[code] = incoming[code];
+        Object.keys(incoming).forEach(key => {
+            if (incoming[key] !== this.state[key]) changes[key] = incoming[key];
         });
         if (Object.keys(changes).length) {
             this.state = {...this.state, ...incoming};
@@ -138,10 +293,13 @@ class TuyaCloudDevice extends EventEmitter {
         return changes;
     }
 
-    _logDiscoveredCodes(status) {
+    _logDiscoveredCodes(props) {
         try {
-            const list = (status || []).map(i => `${i.code}=${JSON.stringify(i.value)}`).join(', ');
-            this.log.info(`${this.context.name}: Tuya Cloud data-point codes → ${list || '(none reported)'}`);
+            const list = (props || []).map(i => {
+                const dp = i.dp_id != null ? i.dp_id : (i.dpId != null ? i.dpId : this.dpIdByCode[i.code]);
+                return `${i.code}${dp != null ? `(dp ${dp})` : ''}=${JSON.stringify(i.value)}`;
+            }).join(', ');
+            this.log.debug(`${this.context.name}: Tuya Cloud data-points → ${list || '(none reported)'}`);
         } catch (_) { /* logging must never throw */ }
     }
 
@@ -154,11 +312,22 @@ class TuyaCloudDevice extends EventEmitter {
     // `this.state`: the accessory already reflects the user's intent in HomeKit
     // immediately, and leaving `state` untouched lets the realtime stream
     // confirm the real device state without a spurious "revert" while a sleepy
-    // device catches up. Returns truthy like TuyaAccessory.update().
+    // device catches up.
+    //
+    // Return contract mirrors TuyaAccessory.update() as far as a synchronous
+    // caller is concerned (truthy on a no-op, `false` when not connected) but,
+    // unlike the LAN class, the actual command travels over HTTP and only its
+    // outcome reveals a failure. So when a command IS dispatched we return the
+    // promise that resolves to the boolean result (and never rejects), letting
+    // `BaseAccessory.setMultiStateAsync` await it and surface a rejected cloud
+    // command to HomeKit instead of silently dropping it.
     update(dps) {
         if (!dps || typeof dps !== 'object') return true;
 
-        const commands = Object.keys(dps).map(code => ({code, value: dps[code]}));
+        // Keys may be numeric LAN dp ids (when a LAN-configured accessory falls
+        // back to the cloud) or string codes (a cloud-configured accessory); the
+        // commands API speaks codes, so translate via the learned map.
+        const commands = Object.keys(dps).map(key => ({code: this._toCode(key), value: dps[key]}));
         if (!commands.length) return true;
 
         if (!this.connected) {
@@ -166,13 +335,23 @@ class TuyaCloudDevice extends EventEmitter {
             return false;
         }
 
-        this.api.sendCommands(this.context.id, commands)
+        return this.api.sendCommands(this.context.id, commands)
             .then(ok => {
                 if (!ok) this.log.warn(`${this.context.name}: Tuya Cloud rejected command ${JSON.stringify(commands)}`);
+                return ok;
             })
-            .catch(ex => this.log.error(`${this.context.name}: cloud command failed: ${ex.message}`));
+            .catch(ex => {
+                this.log.error(`${this.context.name}: cloud command failed: ${ex.message}`);
+                return false;
+            });
+    }
 
-        return true;
+    // Resolve a write key (a numeric LAN dp id or a string code) to the Tuya Cloud
+    // `code` the commands API expects. A numeric id with a known code is
+    // translated; anything else (already a code, or an unmapped id) is passed
+    // through unchanged.
+    _toCode(key) {
+        return this.codeByDpId[key] || key;
     }
 
     /* ------------------------------------------------------------------ *

package/lib/TuyaCloudMessaging.js

@@ -6,36 +6,27 @@ const crypto = require('crypto');
 /*
  * TuyaCloudMessaging
  * ------------------
- * Optional realtime updates for cloud-backed devices, over Tuya's MQTT message
- * service. ONE instance is shared by every cloud device on the same Tuya
- * project (one broker connection delivers status for all of them); messages are
- * fanned out to the right device by its `devId`.
+ * Realtime updates for cloud-backed devices, over Tuya's MQTT message service.
+ * ONE instance is shared by every cloud device on the same Tuya project (one
+ * broker connection delivers status for all of them); messages are fanned out
+ * to the right device by its `devId`.
  *
- * This is intentionally a best-effort accelerator layered on top of polling:
- * if the optional `mqtt` package is missing, or the broker can't be reached, or
- * a message can't be decrypted, nothing breaks — the devices simply keep
- * polling. When it IS working, changes (including physical button presses and
- * the rain sensor) show up in HomeKit within a second or two.
+ * Cloud updates (including physical button presses and the rain sensor) arrive
+ * over this stream rather than by polling, so they show up in HomeKit within a
+ * second or two. `mqtt` is a required dependency; if the broker can't be
+ * reached or a message can't be decrypted nothing crashes — the stream simply
+ * reconnects and the cloud REST reads still cover initial state.
  *
  * The connection + AES-GCM message decryption are faithful to the
  * actively-maintained `0x5e/homebridge-tuya-platform` (`src/core/TuyaOpenMQ.ts`),
  * re-implemented here with Node's built-in `crypto`.
  */
 
+const mqtt = require('mqtt');
+
 const GCM_TAG_LENGTH = 16;
 const PROTOCOL_DEVICE_STATUS = 4;
 
-// `mqtt` is an OPTIONAL dependency: realtime is a bonus, polling is the
-// guarantee. Loading it lazily keeps the plugin LAN-first and lets it run in
-// environments where mqtt isn't (or can't be) installed.
-let mqtt = null;
-let mqttLoadError = null;
-try {
-    mqtt = require('mqtt');
-} catch (ex) {
-    mqttLoadError = ex;
-}
-
 class TuyaCloudMessaging extends EventEmitter {
     constructor({api, log} = {}) {
         super();
@@ -56,10 +47,6 @@ class TuyaCloudMessaging extends EventEmitter {
         this.setMaxListeners(0);
     }
 
-    static isAvailable() {
-        return !!mqtt;
-    }
-
     // Register a device's status handler and lazily start the shared connection.
     subscribeDevice(devId, handler) {
         const id = '' + devId;
@@ -72,13 +59,8 @@ class TuyaCloudMessaging extends EventEmitter {
         if (this._stopped || this._started) return;
         this._started = true;
 
-        if (!mqtt) {
-            this.log.warn(`Tuya Cloud realtime disabled: the optional "mqtt" package is not installed${mqttLoadError ? ` (${mqttLoadError.message})` : ''}. Devices will poll instead. Install it with "npm install mqtt" in the plugin folder to enable instant updates.`);
-            return;
-        }
-
         this._connect().catch(ex => {
-            this.log.warn(`Tuya Cloud realtime could not start (${ex.message}); devices will poll instead.`);
+            this.log.warn(`Tuya Cloud realtime could not start (${ex.message}); it will keep retrying.`);
             this._scheduleRenew(60);
         });
     }
@@ -145,12 +127,12 @@ class TuyaCloudMessaging extends EventEmitter {
             envelope = JSON.parse(payload.toString());
         } catch (_) { return; }
 
-        const {protocol, data, t} = envelope;
+        const {protocol, data} = envelope;
         if (!data) return;
 
         let plaintext;
         try {
-            plaintext = this._decrypt(data, this.config && this.config.password, t);
+            plaintext = this._decrypt(data, this.config && this.config.password);
         } catch (ex) {
             this.log.debug(`Tuya Cloud realtime decrypt failed: ${ex.message}`);
             return;
@@ -179,26 +161,31 @@ class TuyaCloudMessaging extends EventEmitter {
     // Decrypt the MQTT `data` field. msg_encrypted_version 2.0 → AES-128-GCM,
     // 1.0 → AES-128-ECB. The AES key is the middle 16 chars of the broker
     // password (NOT the project Access Secret).
-    _decrypt(data, password, t) {
+    //
+    // The GCM auth tag is intentionally NOT verified: Tuya's real status frames
+    // do not carry a tag that verifies against the documented AAD, so calling
+    // `decipher.final()` would throw on every genuine message and silently drop
+    // all realtime updates. AES-GCM is a stream cipher, so `update()` alone
+    // recovers the plaintext correctly regardless of the tag; a wrong key just
+    // yields garbage that the subsequent JSON.parse rejects. Both the official
+    // `tuya/tuya-homebridge` and `0x5e/homebridge-tuya-platform` decrypt with
+    // `update()` only, for exactly this reason — `final()` here was the bug that
+    // stopped external changes (physical buttons, the Tuya app) from showing up.
+    _decrypt(data, password) {
         const key = Buffer.from(('' + (password || '')).substring(8, 24), 'utf8');
         const buf = Buffer.from(data, 'base64');
 
         // GCM (v2.0) layout: [ivLen(4) BE][iv(ivLen)][ciphertext][tag(16)].
-        // Try it first; if the header doesn't look like a sane IV length, or
-        // auth fails, fall back to ECB (v1.0).
+        // Try it first; if the header doesn't look like a sane IV length, fall
+        // back to ECB (v1.0).
         if (buf.length > 4 + GCM_TAG_LENGTH) {
             const ivLen = buf.readUIntBE(0, 4);
             if (ivLen >= 12 && ivLen <= 16 && (4 + ivLen + GCM_TAG_LENGTH) <= buf.length) {
                 try {
                     const iv = buf.slice(4, 4 + ivLen);
                     const ciphertext = buf.slice(4 + ivLen, buf.length - GCM_TAG_LENGTH);
-                    const tag = buf.slice(buf.length - GCM_TAG_LENGTH);
                     const decipher = crypto.createDecipheriv('aes-128-gcm', key, iv);
-                    decipher.setAuthTag(tag);
-                    const aad = Buffer.allocUnsafe(6);
-                    aad.writeUIntBE(Number(t) || 0, 0, 6);
-                    decipher.setAAD(aad);
-                    return Buffer.concat([decipher.update(ciphertext), decipher.final()]).toString('utf8');
+                    return decipher.update(ciphertext).toString('utf8');
                 } catch (gcmEx) {
                     // fall through to ECB
                 }