homebridge-tuya-plus 3.14.0-dev.25 → 3.14.0-dev.26

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-tuya-plus",
-  "version": "3.14.0-dev.25",
+  "version": "3.14.0-dev.26",
   "description": "A community-maintained Homebridge plugin for controlling Tuya devices in HomeKit. LAN-first, with an optional Tuya Cloud fallback for any device the LAN can't reach.",
   "main": "index.js",
   "scripts": {

package/wiki/Tuya-Cloud-Setup.md

@@ -4,12 +4,9 @@ This plugin is **LAN-first** — every Tuya device is controlled locally wheneve
 
 It helps in two situations:
 
-> **Devices that are never on the LAN.** Battery-powered **"sleepy"** devices — most notably multi-zone **irrigation / faucet timers** — sleep almost all the time to save battery and only ever connect *outbound* to Tuya's cloud (over MQTT) for a brief moment when they wake. They never keep the local port open and never answer LAN discovery, so the local protocol can't reach them. (Tuya's own developer docs state LAN control is unavailable in low-power mode.)
+> **Devices that are never on the LAN.** Some devices, most notably some battery-powered **"sleepy"** ones, never keep the local port open and never answer LAN discovery, so the local protocol can't reach them. (Tuya's own developer docs state LAN control is unavailable in low-power mode.)
 
-> **Devices that occasionally drop off the LAN.** If a normally-local device sometimes shows "No Response" in HomeKit, the cloud fallback quietly covers those moments — local control still runs first.
-
-* Initial state + control go through the Tuya OpenAPI (signed HTTPS).
-* Live updates (including physical button presses) arrive over Tuya's **MQTT** message service — no polling.
+> **Devices that occasionally drop off the LAN.** If a normally-local device sometimes shows "No Response" in HomeKit, the cloud fallback quietly covers those moments.
 
 ---
 
@@ -38,107 +35,10 @@ Still in the project: **Devices → Link App Account → Add App Account**, then
 
 ## 4. Find the device ID
 
-**Devices → All Devices** → click your device → copy its **Device ID** (a string like `bfae6739…tfx`). (You can also find it in the Smart Life app: device → ✎/⚙ → *Device Information*.)
-
----
-
-## 5. Configure the plugin
-
-Add a **top-level `cloud` block** with your credentials. That's all that's needed — every device then tries the LAN first and uses the cloud as a backup.
-
-A device that is **never** reachable on the LAN (a battery-powered "sleepy" timer) simply has **no local `key`**: without one it can't speak the LAN protocol, so the plugin reaches it through the cloud session. There are two project styles:
-
-### Smart Home project (recommended — what most people have)
-
-Authenticates as your app account (username/password), so it sees exactly the devices linked in step 3.
-
-```json5
-{
-    "platform": "TuyaLan",
-    "cloud": {
-        "accessId": "your-access-id",
-        "accessKey": "your-access-secret",
-        "region": "eu",                         // eu / us / cn / in / sg / eu-w / us-e
-        "username": "you@example.com",          // your Tuya/Smart Life app login
-        "password": "your-app-password",
-        "countryCode": "48",                    // your phone country code (e.g. 1, 44, 48)
-        "schema": "tuyaSmart"                   // or "smartlife" if you use the Smart Life app
-    },
-    "devices": [
-        {
-            "name": "Garden Irrigation",
-            "type": "IrrigationSystem",
-            "id": "bfae6739xxxxxxxxxxxxxx",      // the cloud Device ID
-            "valveCount": 4
-            // no "key" -> this device is reached over the cloud
-        }
-    ]
-}
-```
-
-### Custom project
-
-If you created a **Custom** project (devices linked by QR to the project's asset) just omit `username`/`password`/`countryCode`/`schema`:
-
-```json5
-"cloud": {
-    "accessId": "your-access-id",
-    "accessKey": "your-access-secret",
-    "region": "eu"
-}
-```
-
-> There is one global session. The plugin doesn't support per-device cloud credentials or multiple Tuya accounts — put your credentials in the single top-level `cloud` block. A cloud-only device just omits its local `key`.
+**Devices → All Devices** → click your device → copy its **Device ID** (a string like `bfae6739…tfx`). (You can also find it in Tuya/Smart Life apps: device → ✎/⚙ → *Device Information*.)
 
 ---
 
-## Data-points: numbers on the LAN, codes on the cloud
-
-Over the LAN, data-points are numbered (1, 2, …). Over the **cloud** they're named **codes** (e.g. `switch_1`, `battery_percentage`). You normally don't need to care which is which: when the cloud session connects, the plugin reads the device's *thing shadow*, which lists both the code **and** the numeric id for each data-point, and learns the mapping. From then on a configuration written either way works over either transport — a numeric-DP config falls back to the cloud, and a code-based config works on the LAN.
-
-When a cloud device connects, the plugin **logs the data-points** it reports (code and numeric id), e.g.:
-
-```
-Garden Irrigation: Tuya Cloud data-points → switch_1(dp 1)=false, switch_2(dp 2)=false, switch_3(dp 3)=false, switch_4(dp 4)=false, countdown_1(dp 5)=0, …, battery_percentage(dp 46)=99
-```
-
-The `IrrigationSystem` defaults already match the common 4-zone layout (`switch_1`…`switch_4`, battery `battery_percentage`). If your device differs, use the logged codes:
-
-```json5
-"valves": [
-    { "name": "Front Lawn", "dp": "switch_1", "defaultDuration": 900 },
-    { "name": "Back Lawn",  "dp": "switch_2", "defaultDuration": 900 }
-],
-"dpBattery": "battery_percentage"
-```
-
-See **[Irrigation Systems / Sprinklers](https://github.com/adrianjagielak/homebridge-tuya-plus/blob/main/wiki/Supported-Device-Types.md#irrigation-systems--sprinklers)** for all options (per-zone durations, master switch, etc.).
-
----
-
-## Realtime updates (MQTT)
-
-Live updates use Tuya's MQTT message service via the **`mqtt`** package, which is an *optional dependency* installed automatically. If it's missing (or `"realtime": false`), cloud devices still work and stay controllable, but external changes (a physical button, the device's own timer) won't show up until Homebridge restarts. To force-install it:
-
-```
-sudo npm install -g mqtt
-```
-
-The realtime stream connects out to Tuya's broker on **port 8883** — make sure your firewall allows that outbound (it's open on normal home networks).
-
----
-
-## Troubleshooting
-
-| Symptom | Cause / fix |
-|---|---|
-| `Tuya Cloud connection failed: token request failed … (code 1004)` | Wrong **Access ID/Secret**, or host clock skew — the signature includes a timestamp, so keep the machine **NTP-synced**. |
-| `… (code 1106) permission deny` / `(code 40001900) No space permission` | API service not authorized or **trial expired** (step 2), or **wrong region**, or you logged in with the developer account instead of the **app** account, or this specific device isn't linked to the project (step 3). The cloud backs every device as a fallback, so a single LAN-only device that isn't in the project logs this once — harmless if that device already works over the LAN. |
-| Device connects but shows nothing / `0` devices | **Region mismatch**, or the device isn't linked to the project (step 3), or the linked account isn't the device's **owner** (shared/guest access hides devices). |
-| `realtime disabled: the optional "mqtt" package is not installed` | Install `mqtt` (above), or ignore if you don't need live external updates. |
-| Realtime never connects (control works, external changes don't) | Outbound **port 8883** blocked by a firewall. |
-| Logs show different codes than expected | Use the codes from the startup log line shown above. |
-
 ### Security note
 
-Your **Access Secret** and app password are sensitive. Keep them only in your Homebridge `config.json`. If you ever share a config for support, redact them — and you can always reset the Access Secret on the Tuya IoT platform.
+Your **Access Secret** and app password are sensitive. Keep them only in your Homebridge `config.json`. If you ever share a config for support, redact them.