@homebridge-plugins/homebridge-ewelink 12.18.0 → 12.18.2-beta.0

package/CHANGELOG.md

@@ -2,6 +2,33 @@
 
 All notable changes to `@homebridge-plugins/homebridge-ewelink` will be documented in this file.
 
+## v12.18.2 (Pending Release)
+
+### Changed
+
+- chore: exclude test files and the test config from the published package
+- fix: restore debug logging when the plugin runs in a child bridge
+- fix: only turn adaptive lighting off when a colour is genuinely chosen elsewhere
+- fix: send a colour change when only the saturation moves, and mend the al cleanup
+- fix: follow the saturation on the b1 bulb, in both directions
+- fix: explain a port clash on the built-in api instead of crashing the bridge
+- fix: survive a network change on the lan discovery socket instead of crashing the bridge
+- fix: set a garage's sensor up after the garage, so it gets its open and closed feedback
+- fix: make the per-device logging override settable, and drop the debug option that never was
+
+## v12.18.1 (2026-08-02)
+
+### Changed
+
+- chore: add a test setup with tests for the shared helper functions
+- chore(github): run the build and tests in ci, on node 22, 24 and 26
+- chore: use the same lint setup across every plugin
+- chore: add a changelog:sync script to populate the pending section from the commits
+- chore: count a repeated commit subject once when syncing the changelog
+- chore(github): check the changelog against the commits in ci
+- chore(deps): dependency updates
+- docs: add node 26 to the supported node versions
+
 ## v12.18.0 (2026-07-27)
 
 ### Changed

package/README.md

@@ -27,7 +27,7 @@ Homebridge plugin to integrate eWeLink devices into HomeKit
 ### Prerequisites
 
 - To use this plugin, you will need to already have:
-  - [Node](https://nodejs.org): latest version of `v22` or `v24` - any other major version is not supported.
+  - [Node](https://nodejs.org): latest version of `v22`, `v24` or `v26` - any other major version is not supported.
   - [Homebridge](https://homebridge.io): `v1.6` or above - refer to link for more information and installation instructions.
 
 ### Setup

package/config.schema.json

@@ -154,6 +154,19 @@
               "minLength": 10,
               "maxLength": 10
             },
+            "overrideLogging": {
+              "type": "string",
+              "title": "Device Logging Override",
+              "description": "Override the plugin-wide logging setting for this device only.",
+              "oneOf": [
+                { "title": "Standard", "enum": ["standard"] },
+                { "title": "Debug", "enum": ["debug"] },
+                { "title": "Disable", "enum": ["disable"] }
+              ],
+              "condition": {
+                "functionBody": "return (model.singleDevices && model.singleDevices[arrayIndices] && model.singleDevices[arrayIndices].deviceId && model.singleDevices[arrayIndices].deviceId.length === 10);"
+              }
+            },
             "ignoreDevice": {
               "type": "boolean",
               "title": "Hide From HomeKit",
@@ -486,6 +499,19 @@
               "minLength": 10,
               "maxLength": 10
             },
+            "overrideLogging": {
+              "type": "string",
+              "title": "Device Logging Override",
+              "description": "Override the plugin-wide logging setting for this device only.",
+              "oneOf": [
+                { "title": "Standard", "enum": ["standard"] },
+                { "title": "Debug", "enum": ["debug"] },
+                { "title": "Disable", "enum": ["disable"] }
+              ],
+              "condition": {
+                "functionBody": "return (model.multiDevices && model.multiDevices[arrayIndices] && model.multiDevices[arrayIndices].deviceId && model.multiDevices[arrayIndices].deviceId.length === 10);"
+              }
+            },
             "ignoreDevice": {
               "type": "boolean",
               "title": "Hide From HomeKit",
@@ -804,6 +830,19 @@
               "minLength": 10,
               "maxLength": 10
             },
+            "overrideLogging": {
+              "type": "string",
+              "title": "Device Logging Override",
+              "description": "Override the plugin-wide logging setting for this device only.",
+              "oneOf": [
+                { "title": "Standard", "enum": ["standard"] },
+                { "title": "Debug", "enum": ["debug"] },
+                { "title": "Disable", "enum": ["disable"] }
+              ],
+              "condition": {
+                "functionBody": "return (model.lightDevices && model.lightDevices[arrayIndices] && model.lightDevices[arrayIndices].deviceId && model.lightDevices[arrayIndices].deviceId.length === 10);"
+              }
+            },
             "ignoreDevice": {
               "type": "boolean",
               "title": "Hide From HomeKit",
@@ -942,6 +981,19 @@
               "minLength": 10,
               "maxLength": 10
             },
+            "overrideLogging": {
+              "type": "string",
+              "title": "Device Logging Override",
+              "description": "Override the plugin-wide logging setting for this device only.",
+              "oneOf": [
+                { "title": "Standard", "enum": ["standard"] },
+                { "title": "Debug", "enum": ["debug"] },
+                { "title": "Disable", "enum": ["disable"] }
+              ],
+              "condition": {
+                "functionBody": "return (model.thDevices && model.thDevices[arrayIndices] && model.thDevices[arrayIndices].deviceId && model.thDevices[arrayIndices].deviceId.length === 10);"
+              }
+            },
             "ignoreDevice": {
               "type": "boolean",
               "title": "Hide From HomeKit",
@@ -1119,6 +1171,19 @@
               "minLength": 10,
               "maxLength": 10
             },
+            "overrideLogging": {
+              "type": "string",
+              "title": "Device Logging Override",
+              "description": "Override the plugin-wide logging setting for this device only.",
+              "oneOf": [
+                { "title": "Standard", "enum": ["standard"] },
+                { "title": "Debug", "enum": ["debug"] },
+                { "title": "Disable", "enum": ["disable"] }
+              ],
+              "condition": {
+                "functionBody": "return (model.fanDevices && model.fanDevices[arrayIndices] && model.fanDevices[arrayIndices].deviceId && model.fanDevices[arrayIndices].deviceId.length === 10);"
+              }
+            },
             "ignoreDevice": {
               "type": "boolean",
               "title": "Hide From HomeKit",
@@ -1179,6 +1244,19 @@
               "minLength": 10,
               "maxLength": 10
             },
+            "overrideLogging": {
+              "type": "string",
+              "title": "Device Logging Override",
+              "description": "Override the plugin-wide logging setting for this device only.",
+              "oneOf": [
+                { "title": "Standard", "enum": ["standard"] },
+                { "title": "Debug", "enum": ["debug"] },
+                { "title": "Disable", "enum": ["disable"] }
+              ],
+              "condition": {
+                "functionBody": "return (model.sensorDevices && model.sensorDevices[arrayIndices] && model.sensorDevices[arrayIndices].deviceId && model.sensorDevices[arrayIndices].deviceId.length === 10);"
+              }
+            },
             "ignoreDevice": {
               "type": "boolean",
               "title": "Hide From HomeKit",
@@ -1331,6 +1409,19 @@
               "minLength": 10,
               "maxLength": 10
             },
+            "overrideLogging": {
+              "type": "string",
+              "title": "Device Logging Override",
+              "description": "Override the plugin-wide logging setting for this device only.",
+              "oneOf": [
+                { "title": "Standard", "enum": ["standard"] },
+                { "title": "Debug", "enum": ["debug"] },
+                { "title": "Disable", "enum": ["disable"] }
+              ],
+              "condition": {
+                "functionBody": "return (model.rfDevices && model.rfDevices[arrayIndices] && model.rfDevices[arrayIndices].deviceId && model.rfDevices[arrayIndices].deviceId.length === 10);"
+              }
+            },
             "ignoreDevice": {
               "type": "boolean",
               "title": "Hide From HomeKit",
@@ -1562,6 +1653,7 @@
             "singleDevices[].label",
             "singleDevices[].deviceId",
             "singleDevices[].ignoreDevice",
+            "singleDevices[].overrideLogging",
             "singleDevices[].deviceModel",
             "singleDevices[].showAs",
             "singleDevices[].showAsMotor",
@@ -1595,6 +1687,7 @@
             "multiDevices[].label",
             "multiDevices[].deviceId",
             "multiDevices[].ignoreDevice",
+            "multiDevices[].overrideLogging",
             "multiDevices[].deviceModel",
             "multiDevices[].showAs",
             "multiDevices[].showAsMotor",
@@ -1627,6 +1720,7 @@
             "lightDevices[].label",
             "lightDevices[].deviceId",
             "lightDevices[].ignoreDevice",
+            "lightDevices[].overrideLogging",
             "lightDevices[].deviceModel",
             "lightDevices[].showAs",
             "lightDevices[].brightnessStep",
@@ -1651,6 +1745,7 @@
             "thDevices[].label",
             "thDevices[].deviceId",
             "thDevices[].ignoreDevice",
+            "thDevices[].overrideLogging",
             "thDevices[].deviceModel",
             "thDevices[].showAs",
             "thDevices[].showHeatCool",
@@ -1681,6 +1776,7 @@
             "fanDevices[].label",
             "fanDevices[].deviceId",
             "fanDevices[].ignoreDevice",
+            "fanDevices[].overrideLogging",
             "fanDevices[].deviceModel",
             "fanDevices[].hideLight",
             "fanDevices[].ipAddress"
@@ -1702,6 +1798,7 @@
             "sensorDevices[].label",
             "sensorDevices[].deviceId",
             "sensorDevices[].ignoreDevice",
+            "sensorDevices[].overrideLogging",
             "sensorDevices[].deviceModel",
             "sensorDevices[].showAs",
             "sensorDevices[].lowBattThreshold",
@@ -1730,6 +1827,7 @@
             "rfDevices[].label",
             "rfDevices[].deviceId",
             "rfDevices[].ignoreDevice",
+            "rfDevices[].overrideLogging",
             "rfDevices[].resetOnStartup",
             "rfDevices[].ipAddress"
           ]

package/lib/connection/api.js

@@ -4,7 +4,6 @@ export default class {
   constructor(platform, devicesInHB) {
     // Set up variables from the platform
     this.config = platform.config
-    this.debug = platform.config.debug
     this.devicesInHB = devicesInHB
     this.hapChar = platform.api.hap.Characteristic
     this.hapServ = platform.api.hap.Service
@@ -215,9 +214,7 @@ export default class {
 
   async action(req) {
     // Log the request if appropriate
-    if (this.debug) {
-      this.log('API request [%s].', req.url)
-    }
+    this.log.debug('API request [%s].', req.url)
 
     // Authenticate the request
     if (

package/lib/connection/http.js

@@ -12,7 +12,6 @@ export default class {
     this.appId = platform.config.appId || platformConsts.appId
     this.appSecret = platform.config.appSecret || platformConsts.appSecret
     this.countryCode = platform.config.countryCode
-    this.debug = platform.config.debug
     this.homeList = []
     this.httpHost = platform.config.httpHost
     this.ignoredDevices = platform.ignoredDevices
@@ -69,9 +68,7 @@ export default class {
       }
 
       // Log the data depending on the debug setting
-      if (this.debug) {
-        this.log('%s.', this.lang.sendLogin)
-      }
+      this.log.debug('%s.', this.lang.sendLogin)
 
       // Set up the request signature
       const dataToSign = createHmac('sha256', this.appSecret)
@@ -110,9 +107,7 @@ export default class {
         }
 
         // Log the new http host if appropriate
-        if (this.debug) {
-          this.log('%s [%s].', this.lang.newRegionRec, this.httpHost)
-        }
+        this.log.debug('%s [%s].', this.lang.newRegionRec, this.httpHost)
 
         // Retry the login with the new http host
         return await this.login()
@@ -261,7 +256,12 @@ export default class {
           }
           // Separate the sensors as these need to be set up last
           const isObstructSwitch = this.obstructSwitches[d.itemData.deviceid]
-          const isSensorSwitch = this.sensorSwitches[d.itemData.deviceid]
+          // sensorSwitches is a list of device ids, so it has to be searched, not
+          // indexed. Indexing it always gave undefined, so a non-DW2 sensor was
+          // never moved to the end of the list and could be set up before the
+          // garage that needs it - which fell back to a plain contact sensor until
+          // the next restart.
+          const isSensorSwitch = this.sensorSwitches.includes(d.itemData.deviceid)
           if (
             platformConsts.devices.garageSensors.includes(d.itemData.extra.uiid)
             || isObstructSwitch

package/lib/connection/lan.js

@@ -18,7 +18,6 @@ const emitter = new events()
 export default class {
   constructor(platform) {
     // Set up variables from the platform
-    this.debug = platform.config.debug
     this.ipOverride = platform.ipOverride
     this.lang = platform.lang
     this.log = platform.log
@@ -40,13 +39,9 @@ export default class {
     })
 
     // Perform an initial discovery of devices on the local network
-    if (this.debug) {
-      this.log('%s.', this.lang.lanStarting)
-    }
+    this.log.debug('%s.', this.lang.lanStarting)
     const res = await dnsSd.discover({ name: '_ewelink._tcp.local' })
-    if (this.debug) {
-      this.log('%s.', this.lang.lanStarted)
-    }
+    this.log.debug('%s.', this.lang.lanStarted)
 
     // Update the device map for each device found on the local network
     res.forEach((device) => {
@@ -342,8 +337,6 @@ export default class {
   async closeConnection() {
     // This is called when Homebridge is shutdown
     await dnsSd.stopMonitoring()
-    if (this.debug) {
-      this.log('%s.', this.lang.stoppedLAN)
-    }
+    this.log.debug('%s.', this.lang.stoppedLAN)
   }
 }

package/lib/connection/ws.js

@@ -15,7 +15,6 @@ export default class {
     // Set up variables from the platform
     this.appId = platform.config.appId || platformConsts.appId
     this.appSecret = platform.config.appSecret || platformConsts.appSecret
-    this.debug = platform.config.debug
     this.lang = platform.lang
     this.log = platform.log
 
@@ -57,9 +56,7 @@ export default class {
       }
 
       // Log the received host if appropriate
-      if (this.debug) {
-        this.log('%s [%s].', this.lang.wsHostRec, body.domain)
-      }
+      this.log.debug('%s [%s].', this.lang.wsHostRec, body.domain)
 
       // Return the received web socket host
       return body.domain
@@ -130,9 +127,7 @@ export default class {
         }
 
         // Log the web socket login if appropriate
-        if (this.debug) {
-          this.log('%s.', this.lang.wsLogin)
-        }
+        this.log.debug('%s.', this.lang.wsLogin)
 
         // Attempt to authenticate the web socket connection
         try {
@@ -153,17 +148,13 @@ export default class {
                 this.wsClient.send('ping')
               } catch (err) {
                 // Catch errors sending ping and show in debug mode
-                if (this.debug) {
-                  this.log.warn('%s %s.', this.lang.wsPingError, parseError(err))
-                }
+                this.log.debugWarn('%s %s.', this.lang.wsPingError, parseError(err))
               }
             }, (res.config.hbInterval + 7) * 1000)
 
             // Login was successful and log if appropriate
             this.authRetries = 0
-            if (this.debug) {
-              this.log('%s.', this.lang.wsLoginSuccess)
-            }
+            this.log.debug('%s.', this.lang.wsLoginSuccess)
           } else if (res.error === 406) {
             // Token invalidated (e.g. concurrent session), re-authenticate with backoff
             this.log.warn(this.lang.wsLogin406)
@@ -285,9 +276,7 @@ export default class {
           return
         }
 
-        if (this.debug) {
-          this.log.warn('%s [%s].', this.lang.wsReconnectError, e)
-        }
+        this.log.debugWarn('%s [%s].', this.lang.wsReconnectError, e)
 
         // Reconnect with exponential backoff
         this.reconnectAttempts = (this.reconnectAttempts || 0) + 1
@@ -298,9 +287,7 @@ export default class {
 
       // Add a listener for when the web socket throws an error
       this.wsClient.onError.addListener(async (e) => {
-        if (this.debug) {
-          this.log.warn('%s [%s].', this.lang.wsReconnectClose, e)
-        }
+        this.log.debugWarn('%s [%s].', this.lang.wsReconnectClose, e)
 
         this.reconnectAttempts = (this.reconnectAttempts || 0) + 1
         const delay = Math.min(5000 * 2 ** (this.reconnectAttempts - 1), 300000)
@@ -316,9 +303,7 @@ export default class {
     } catch (err) {
       const errToShow = parseError(err)
 
-      if (this.debug) {
-        this.log('%s: %s.', this.lang.wsLoginErrRecon, errToShow)
-      }
+      this.log.debug('%s: %s.', this.lang.wsLoginErrRecon, errToShow)
 
       this.reconnectAttempts = (this.reconnectAttempts || 0) + 1
       const delay = Math.min(5000 * 2 ** (this.reconnectAttempts - 1), 300000)
@@ -444,9 +429,7 @@ export default class {
         await this.wsClient.close()
 
         // Log if appropriate
-        if (this.debug) {
-          this.log('%s.', this.lang.stoppedWS)
-        }
+        this.log.debug('%s.', this.lang.stoppedWS)
       }
     }
   }

package/lib/device/air-conditioner.js

@@ -39,7 +39,7 @@ export default class {
         break
       default:
         this.enableLogging = !platform.config.disableDeviceLogging
-        this.enableDebugLogging = platform.config.debug
+        this.enableDebugLogging = false
         break
     }
 

package/lib/device/curtain.js

@@ -38,7 +38,7 @@ export default class {
         break
       default:
         this.enableLogging = !platform.config.disableDeviceLogging
-        this.enableDebugLogging = platform.config.debug
+        this.enableDebugLogging = false
         break
     }
 

package/lib/device/diffuser.js

@@ -37,7 +37,7 @@ export default class {
         break
       default:
         this.enableLogging = !platform.config.disableDeviceLogging
-        this.enableDebugLogging = platform.config.debug
+        this.enableDebugLogging = false
         break
     }
 

package/lib/device/fan-gear.js

@@ -43,7 +43,7 @@ export default class {
         break
       default:
         this.enableLogging = !platform.config.disableDeviceLogging
-        this.enableDebugLogging = platform.config.debug
+        this.enableDebugLogging = false
         break
     }
 

package/lib/device/fan.js

@@ -37,7 +37,7 @@ export default class {
         break
       default:
         this.enableLogging = !platform.config.disableDeviceLogging
-        this.enableDebugLogging = platform.config.debug
+        this.enableDebugLogging = false
         break
     }
 

package/lib/device/group.js

@@ -17,7 +17,7 @@ export default class {
 
     // Set the correct logging variables for this accessory
     this.enableLogging = !platform.config.disableDeviceLogging
-    this.enableDebugLogging = platform.config.debug
+    this.enableDebugLogging = false
 
     if (platformConsts.devices.switchSCM.includes(this.accessory.context.groupUIID)) {
       this.isSCM = true

package/lib/device/humidifier.js

@@ -36,7 +36,7 @@ export default class {
         break
       default:
         this.enableLogging = !platform.config.disableDeviceLogging
-        this.enableDebugLogging = platform.config.debug
+        this.enableDebugLogging = false
         break
     }
 

package/lib/device/light-cct.js

@@ -43,7 +43,7 @@ export default class {
         break
       default:
         this.enableLogging = !platform.config.disableDeviceLogging
-        this.enableDebugLogging = platform.config.debug
+        this.enableDebugLogging = false
         break
     }
 
@@ -67,10 +67,22 @@ export default class {
     this.service = this.accessory.getService(this.hapServ.Lightbulb)
       || this.accessory.addService(this.hapServ.Lightbulb)
 
-    // If adaptive lighting has just been disabled then remove and re-add service to hide AL icon
+    // Adaptive lighting has just been switched off, so take away the three
+    // characteristics that make Home offer it. Only these need to go: the whole
+    // Lightbulb service used to be thrown away and rebuilt here, which does hide
+    // the icon but presents Home with what looks like a different light, and an
+    // owner can lose that light's room and its automations as a result.
     if (this.alShift === -1 && this.accessory.context.adaptiveLighting) {
-      this.accessory.removeService(this.service)
-      this.service = this.accessory.addService(this.hapServ.Lightbulb)
+      [
+        'SupportedCharacteristicValueTransitionConfiguration',
+        'CharacteristicValueTransitionControl',
+        'CharacteristicValueActiveTransitionCount',
+      ].forEach((charName) => {
+        const char = this.hapChar[charName]
+        if (char && this.service.testCharacteristic(char)) {
+          this.service.removeCharacteristic(this.service.getCharacteristic(char))
+        }
+      })
       this.accessory.context.adaptiveLighting = false
     }
 
@@ -99,6 +111,10 @@ export default class {
         customTemperatureAdjustment: this.alShift,
       })
       this.accessory.configureController(this.accessory.alController)
+      // Without this the cleanup that removes the adaptive lighting
+      // characteristics can never run, because it is guarded on this flag - so
+      // switching adaptive lighting off left Home still offering it.
+      this.accessory.context.adaptiveLighting = true
     }
 
     // Add the get handlers only if the user hasn't disabled the disableNoResponse setting

package/lib/device/light-dimmer.js

@@ -42,7 +42,7 @@ export default class {
         break
       default:
         this.enableLogging = !platform.config.disableDeviceLogging
-        this.enableDebugLogging = platform.config.debug
+        this.enableDebugLogging = false
         break
     }