@homebridge-plugins/homebridge-ewelink 12.13.1-beta.2 → 12.14.1-beta.0

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 All notable changes to `@homebridge-plugins/homebridge-ewelink` will be documented in this file.
 
+## v12.14.1 (Pending Release)
+
+- fix(garage-one): send single-outlet payload on switchSCM devices (#774) (@nico81)
+- fix(ws): do not retry sendUpdate on timeout (#775) (@nico81)
+- fix(platform): do not serialize hidden accessories to the cache
+- chore: dependency updates
+
+## v12.14.0 (2026-05-05)
+
+### Changed
+
+- dependency updates
+
 ## v12.13.0 (2026-04-12)
 
 ### Changed

package/lib/connection/ws.js

@@ -11,7 +11,7 @@ import { hasProperty, parseError, sleep } from '../utils/functions.js'
 const emitter = new events()
 
 export default class {
-  constructor(platform, authData, httpClient) {
+  constructor(platform, authData) {
     // Set up variables from the platform
     this.appId = platform.config.appId || platformConsts.appId
     this.appSecret = platform.config.appSecret || platformConsts.appSecret
@@ -19,9 +19,6 @@ export default class {
     this.lang = platform.lang
     this.log = platform.log
 
-    // HTTP client used to refresh the bearer token when a 406 invalidates the session
-    this.httpClient = httpClient
-
     // Set up variables from the authData (from HTTP)
     this.httpHost = authData.httpHost
     this.aToken = authData.aToken
@@ -29,51 +26,6 @@ export default class {
 
     // Flag used to determine ws connection status
     this.wsIsConnected = false
-
-    // Retry state — a single counter/timer serialises all reconnection paths
-    this.retryCount = 0
-    this.loginInProgress = false
-    this.reconnectTimer = null
-  }
-
-  scheduleReconnect(reason) {
-    // Another retry is already queued or a login is actively running — nothing to do
-    if (this.reconnectTimer || this.loginInProgress) {
-      return
-    }
-    if (this.retryCount >= 10) {
-      this.log.warn('%s [giving up after %s attempts, reason: %s].', this.lang.wsLoginError, this.retryCount, reason)
-      return
-    }
-    const delay = Math.min(5000 * 2 ** this.retryCount, 300000)
-    this.retryCount += 1
-    // Log recovery at info level — users need to see that retries are happening
-    this.log('WS reconnect scheduled [%s] in %s ms (attempt %s).', reason, delay, this.retryCount)
-    this.reconnectTimer = setTimeout(() => {
-      this.reconnectTimer = null
-      this.login().catch(() => {
-        // login() schedules its own retry on internal failure — nothing to do here
-      })
-    }, delay)
-  }
-
-  async refreshHttpToken() {
-    // Re-run HTTP login to get a fresh aToken; a 406 means the old one is invalidated.
-    // This does NOT re-fetch homes/devices — only the bearer token changes.
-    if (!this.httpClient) {
-      return false
-    }
-    try {
-      const authData = await this.httpClient.login()
-      this.aToken = authData.aToken
-      this.apiKey = authData.apiKey
-      this.httpHost = authData.httpHost
-      this.log('HTTP token refreshed after 406.')
-      return true
-    } catch (err) {
-      this.log.warn('%s %s.', 'HTTP token refresh failed:', parseError(err))
-      return false
-    }
   }
 
   async getHost(attempt = 0) {
@@ -129,21 +81,17 @@ export default class {
   }
 
   async login() {
-    // Used to create the web socket connection and authenticate.
-    // All reconnection paths (onClose, onError, 406, open-fail) funnel through
-    // scheduleReconnect(), which guards against concurrent logins via loginInProgress.
-    if (this.loginInProgress) {
-      return
-    }
-    this.loginInProgress = true
-
-    // Cancel any pending reconnect — we're attempting a login right now
-    if (this.reconnectTimer) {
-      clearTimeout(this.reconnectTimer)
-      this.reconnectTimer = null
-    }
-
+    // Used to create the web socket connection and authenticate
     try {
+      // This may be called onClose and onError, we just want it to run once
+      if (this.debounce) {
+        return
+      }
+      this.debounce = true
+      setTimeout(() => {
+        this.debounce = false
+      }, 4000)
+
       // Close any existing web socket connection
       await this.closeConnection()
 
@@ -211,19 +159,20 @@ export default class {
               }
             }, (res.config.hbInterval + 7) * 1000)
 
-            // Login was successful — reset the retry counter and log if appropriate
-            this.retryCount = 0
+            // Login was successful and log if appropriate
+            this.authRetries = 0
             if (this.debug) {
               this.log('%s.', this.lang.wsLoginSuccess)
             }
           } else if (res.error === 406) {
-            // Token invalidated (e.g. concurrent session from the mobile app).
-            // Re-sending userOnline with the same aToken will keep returning 406,
-            // so refresh the HTTP token first, then reconnect with backoff.
+            // Token invalidated (e.g. concurrent session), re-authenticate with backoff
             this.log.warn(this.lang.wsLogin406)
-            await this.refreshHttpToken()
-            await this.closeConnection()
-            this.scheduleReconnect('406')
+            const delay = Math.min(5000 * 2 ** (this.authRetries || 0), 300000)
+            this.authRetries = (this.authRetries || 0) + 1
+            if (this.authRetries <= 10) {
+              await sleep(delay)
+              await this.login()
+            }
           } else {
             // There was a problem with the authentication response
             const str = JSON.stringify(res, null, 2)
@@ -232,8 +181,6 @@ export default class {
         } catch (err) {
           // Catch any errors authenticating the WS connection
           this.log.warn('%s %s.', this.lang.wsLoginError, parseError(err))
-          await this.closeConnection()
-          this.scheduleReconnect('auth-error')
         }
       })
 
@@ -320,14 +267,14 @@ export default class {
             msg.params.updateSource = 'WS'
             emitter.emit('update', { deviceid: msg.deviceid, params: msg.params })
           }
-        } else if (msg.error !== 406) {
+        } else {
           // WS message received has an unknown action
           this.log.warn('%s.\n%s', this.lang.wsUnkCmd, JSON.stringify(msg, null, 2))
         }
       })
 
       // Add a listener for when the web socket closes for any reason
-      this.wsClient.onClose.addListener((e) => {
+      this.wsClient.onClose.addListener(async (e) => {
         // Don't continue further with logging/reconnection if it's a wanted closure
         if (e === 1005) {
           return
@@ -337,23 +284,30 @@ export default class {
           this.log.warn('%s [%s].', this.lang.wsReconnectError, e)
         }
 
-        this.wsIsConnected = false
-        this.scheduleReconnect(`close-${e}`)
+        // Reconnect with exponential backoff
+        this.reconnectAttempts = (this.reconnectAttempts || 0) + 1
+        const delay = Math.min(5000 * 2 ** (this.reconnectAttempts - 1), 300000)
+        await sleep(delay)
+        await this.login()
       })
 
       // Add a listener for when the web socket throws an error
-      this.wsClient.onError.addListener((e) => {
+      this.wsClient.onError.addListener(async (e) => {
         if (this.debug) {
           this.log.warn('%s [%s].', this.lang.wsReconnectClose, e)
         }
 
-        this.scheduleReconnect('error')
+        this.reconnectAttempts = (this.reconnectAttempts || 0) + 1
+        const delay = Math.min(5000 * 2 ** (this.reconnectAttempts - 1), 300000)
+        await sleep(delay)
+        await this.login()
       })
 
-      // Open the web socket connection.
-      // NB: retryCount is reset only on successful auth, not on TCP handshake —
-      // otherwise a repeated auth-failure loop would reset backoff every cycle.
+      // Open the web socket connection
       await this.wsClient.open()
+
+      // Reset reconnect counter on successful connection
+      this.reconnectAttempts = 0
     } catch (err) {
       const errToShow = parseError(err)
 
@@ -361,13 +315,14 @@ export default class {
         this.log('%s: %s.', this.lang.wsLoginErrRecon, errToShow)
       }
 
-      this.scheduleReconnect('open-failed')
-    } finally {
-      this.loginInProgress = false
+      this.reconnectAttempts = (this.reconnectAttempts || 0) + 1
+      const delay = Math.min(5000 * 2 ** (this.reconnectAttempts - 1), 300000)
+      await sleep(delay)
+      await this.login()
     }
   }
 
-  async sendUpdate(json, retries = 0) {
+  async sendUpdate(json) {
     // Generate the payload to send
     const toSend = {
       ...json,
@@ -413,13 +368,11 @@ export default class {
             throw new Error(`${this.lang.wsUnkRes} [${res.error}]`)
         }
       } catch (err) {
-        // Retry up to 3 times on timeout errors only
-        const errMsg = parseError(err)
-        if (retries < 3 && (errMsg.includes('504') || errMsg.includes('timeout') || errMsg.includes('Timeout'))) {
-          await sleep(1000)
-          return this.sendUpdate(json, retries + 1)
-        }
-        throw new Error(errMsg)
+        // Do not retry on timeout: the original command may have already been
+        // applied by the device but the cloud failed to deliver a formal ACK.
+        // Retrying non-idempotent writes (e.g. inching/momentary actuators)
+        // produces additional physical pulses, causing actuators to bounce.
+        throw new Error(parseError(err))
       }
     } else {
       // The web socket isn't currently open so log this
@@ -464,8 +417,7 @@ export default class {
   }
 
   async closeConnection() {
-    // This is called when refreshing connection or if Homebridge shuts down.
-    // Idempotent — safe to call regardless of current connection state.
+    // This is called when refreshing connection or if Homebridge shuts down
 
     // Clear any existing ping interval
     if (this.hbInterval) {
@@ -475,22 +427,21 @@ export default class {
 
     // Check the ws client is set up
     if (this.wsClient) {
-      const wasConnected = this.wsIsConnected
-
-      // Remove any existing listeners so onClose/onError don't retrigger reconnection
+      // Remove any existing listeners
       this.wsClient.removeAllListeners()
-      this.wsIsConnected = false
 
-      // Always attempt to close the underlying socket — auth-failure paths (e.g. 406)
-      // leave wsIsConnected=false but the TCP/WS socket is still open.
-      try {
+      // Close the web socket connection
+      if (this.wsIsConnected) {
+        // Set the connection flag to false
+        this.wsIsConnected = false
+
+        // Close the connection
         await this.wsClient.close()
-      } catch {
-        // Already closed, never fully opened, or close threw — nothing actionable
-      }
 
-      if (wasConnected && this.debug) {
-        this.log('%s.', this.lang.stoppedWS)
+        // Log if appropriate
+        if (this.debug) {
+          this.log('%s.', this.lang.stoppedWS)
+        }
       }
     }
   }

package/lib/device/simulation/garage-one.js

@@ -205,21 +205,33 @@ export default class {
       await sleep(delay)
       this.service.updateCharacteristic(this.hapChar.TargetDoorState, newPos)
       this.service.updateCharacteristic(this.hapChar.CurrentDoorState, newPos + 2)
+      // SCM (single-channel multi-format) devices use the switches[] array
+      // but only expose outlet 0. True dual-channel garage controllers
+      // (e.g. DUALR3) use separate outlets for open/close relay action.
+      const isScm = platformConsts.devices.switchSCM.includes(this.accessory.context.eweUIID)
+        || platformConsts.devices.switchSCMPower.includes(this.accessory.context.eweUIID)
+
       switch (this.setup) {
         case 'switchSingle':
           params.switch = 'on'
           break
         case 'switchMulti':
-          params.switches = [
-            {
-              switch: newPos === 0 ? 'on' : 'off',
-              outlet: 0,
-            },
-            {
-              switch: newPos === 1 ? 'on' : 'off',
-              outlet: 1,
-            },
-          ]
+          if (isScm) {
+            // SCM device: send a single momentary pulse on outlet 0
+            params.switches = [{ switch: 'on', outlet: 0 }]
+          } else {
+            // Dual-channel device with separate open/close relays
+            params.switches = [
+              {
+                switch: newPos === 0 ? 'on' : 'off',
+                outlet: 0,
+              },
+              {
+                switch: newPos === 1 ? 'on' : 'off',
+                outlet: 1,
+              },
+            ]
+          }
           break
         default:
           return

package/lib/platform.js

@@ -513,7 +513,7 @@ export default class {
 
         // Set up the WS client, get the user WS host and login
         if (this.config.mode !== 'lan') {
-          this.wsClient = new wsClient(this, authData, this.httpClient)
+          this.wsClient = new wsClient(this, authData)
           await this.wsClient.login()
 
           // Refresh the WS connection every 60 minutes
@@ -1427,8 +1427,7 @@ export default class {
           }
 
           // Update any changes to the sub accessory to the platform
-          this.api.updatePlatformAccessories([subAccessory])
-          devicesInHB.set(subAccessory.UUID, subAccessory)
+          this.saveAccessoryUpdate(subAccessory)
           if (i === 0) {
             accessory = subAccessory
           }
@@ -1567,8 +1566,7 @@ export default class {
           }
 
           // Update any changes to the sub accessory to the platform
-          this.api.updatePlatformAccessories([subAccessory])
-          devicesInHB.set(subAccessory.UUID, subAccessory)
+          this.saveAccessoryUpdate(subAccessory)
 
           // Increment the counter
           rfChlCounter += Object.keys(subDevice.buttons || {}).length
@@ -1826,8 +1824,7 @@ export default class {
       }
 
       // Update any changes to the device into our devicesInHB map
-      this.api.updatePlatformAccessories([accessory])
-      devicesInHB.set(accessory.UUID, accessory)
+      this.saveAccessoryUpdate(accessory)
       if (uiid === 5000) {
         this.log(
           '[%s] %s [%s] [%s].',
@@ -1947,6 +1944,20 @@ export default class {
     }
   }
 
+  saveAccessoryUpdate(accessory) {
+    // Persist any context/characteristic changes to Homebridge, then keep the
+    // accessory in our in-memory map. Hidden accessories are deliberately never
+    // registered (see addAccessory), so they have no associated plugin and would
+    // make Homebridge throw when it serialises its accessory cache to disk
+    // ('Cannot serialize accessory ... - missing associated plugin'). We still
+    // keep them in devicesInHB so lookups (e.g. the SW0 master of a multi-channel
+    // device) continue to work.
+    if (!accessory.context.hidden) {
+      this.api.updatePlatformAccessories([accessory])
+    }
+    devicesInHB.set(accessory.UUID, accessory)
+  }
+
   addExternalAccessory(device, hbDeviceId, category) {
     try {
       // Add the new accessory to Homebridge
@@ -2092,8 +2103,7 @@ export default class {
       // The update is from WS so update the WS online/offline status
       if (device.params.online !== accessory.context.reachableWAN) {
         accessory.context.reachableWAN = device.params.online
-        this.api.updatePlatformAccessories([accessory])
-        devicesInHB.set(accessory.UUID, accessory)
+        this.saveAccessoryUpdate(accessory)
 
         // Flag this true to update the sub accessories later
         reachableChange = true
@@ -2154,8 +2164,7 @@ export default class {
 
       // Update the accessory context if the device is back online or the IP changed
       if (reachableChange) {
-        this.api.updatePlatformAccessories([accessory])
-        devicesInHB.set(accessory.UUID, accessory)
+        this.saveAccessoryUpdate(accessory)
       }
     }
 
@@ -2183,8 +2192,7 @@ export default class {
           }
 
           // Save the sub accessory updates to the platform
-          this.api.updatePlatformAccessories([subAccessory])
-          devicesInHB.set(subAccessory.UUID, subAccessory)
+          this.saveAccessoryUpdate(subAccessory)
         }
       }
     }

package/package.json

@@ -3,7 +3,7 @@
   "displayName": "Homebridge eWeLink",
   "alias": "eWeLink",
   "type": "module",
-  "version": "12.13.1-beta.2",
+  "version": "12.14.1-beta.0",
   "description": "Homebridge plugin to integrate eWeLink devices into HomeKit.",
   "author": {
     "name": "bwp91",
@@ -53,22 +53,22 @@
   ],
   "main": "lib/index.js",
   "engines": {
-    "homebridge": "^1.6.0 || ^2.0.0-beta.0",
-    "node": "^22 || ^24"
+    "homebridge": "^1.6.0 || ^2.0.0",
+    "node": "^22.12.0 || ^24.0.0"
   },
   "scripts": {
     "lint": "eslint . --max-warnings=0",
     "lint:fix": "npm run lint -- --fix"
   },
   "dependencies": {
-    "@homebridge/plugin-ui-utils": "^2.2.3",
-    "axios": "^1.15.1",
+    "@homebridge/plugin-ui-utils": "^2.2.4",
+    "axios": "^1.17.0",
     "node-persist": "^4.0.4",
-    "p-queue": "^9.1.2",
+    "p-queue": "^9.3.0",
     "websocket-as-promised": "^3.0.1",
-    "ws": "^8.20.0"
+    "ws": "^8.21.0"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^8.2.0"
+    "@antfu/eslint-config": "^9.0.0"
   }
 }