@homebridge-plugins/homebridge-wemo 7.7.0 → 7.7.1-beta.0

package/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to `@homebridge-plugins/homebridge-wemo` will be documented in this file.
 
+## v7.7.1 (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: explain a port clash on the notification listener instead of crashing the bridge
+- fix: stop gating a few log lines on a debug setting that was never readable
+
 ## v7.7.0 (2026-08-02)
 
 ### Changed

package/lib/device/link-bulb.js

@@ -57,10 +57,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
     }
 
@@ -85,6 +97,14 @@ export default class {
       this.service.getCharacteristic(this.hapChar.Hue).onSet(async (value) => {
         await this.internalColourUpdate(value)
       })
+      // Saturation needs a handler of its own. HomeKit writes hue and saturation
+      // separately, so with only hue listened for, dragging saturation alone -
+      // the same colour made paler or richer - reached nothing and the bulb
+      // never changed. Both handlers share one update, and the debounce inside
+      // it collapses a hue-and-saturation pair into a single command.
+      this.service.getCharacteristic(this.hapChar.Saturation).onSet(async () => {
+        await this.internalColourUpdate(this.service.getCharacteristic(this.hapChar.Hue).value)
+      })
       this.cacheHue = this.service.getCharacteristic(this.hapChar.Hue).value
       this.cacheSat = this.service.getCharacteristic(this.hapChar.Saturation).value
     } else {
@@ -109,6 +129,10 @@ export default class {
           customTemperatureAdjustment: this.alShift,
         })
         this.accessory.configureController(this.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
       }
     }
 
@@ -289,13 +313,15 @@ export default class {
         return
       }
 
-      // Don't continue if this value is same as before
-      if (this.cacheHue === value) {
+      // Don't continue if this colour is the same as before. Saturation is part
+      // of that question: comparing hue alone meant a change of saturation at
+      // the same hue looked like no change at all, and nothing was sent.
+      const currentSat = this.service.getCharacteristic(this.hapChar.Saturation).value
+      if (this.cacheHue === value && this.cacheSat === currentSat) {
         return
       }
 
       // First convert to RGB
-      const currentSat = this.service.getCharacteristic(this.hapChar.Saturation).value
       const [r, g, b] = hs2rgb(value, currentSat)
 
       // Then convert the RGB to the values needed for Wemo
@@ -424,7 +450,10 @@ export default class {
         // Log the change if appropriate
         this.accessory.log(`${platformLang.curColour} [X:${valueX} Y:${valueY}]`)
 
-        // Colour chosen externally so disable adaptive lighting
+        // Somebody chose this colour outside HomeKit - in the Wemo app, on a
+        // remote, or at the wall. Homebridge catches changes made in the Home
+        // app itself, but nothing else sees these, so adaptive lighting would
+        // carry on and move the bulb off that colour within minutes.
         if (this.alController?.isAdaptiveLightingActive()) {
           this.alController.disableAdaptiveLighting()
           this.accessory.log(platformLang.alDisabled)
@@ -449,7 +478,12 @@ export default class {
       const mToK = Math.round(1000000 / value)
       this.accessory.log(`${platformLang.curCCT} [${mToK}K / ${value}M]`)
 
-      // If the difference is significant (>20) then disable adaptive lighting
+      // A bulb repeating back the temperature adaptive lighting just set can
+      // land a few mireds off through the conversion, and treating that as the
+      // owner's doing would switch adaptive lighting off moments after it was
+      // switched on. Further apart than that and somebody set this temperature
+      // themselves, outside HomeKit - which nothing else would notice, so
+      // adaptive lighting has to be stopped here.
       if (!Number.isNaN(this.cacheMired)) {
         const diff = Math.abs(value - this.cacheMired) > 20
         if (this.alController?.isAdaptiveLightingActive() && diff) {

package/lib/platform.js

@@ -41,7 +41,6 @@ export default class {
     try {
       this.api = api
       this.log = log
-      this.isBeta = process.argv.includes('-D')
 
       // Configuration objects for accessories
       this.ignoredDevices = []
@@ -344,13 +343,16 @@ export default class {
       this.log('%s.', platformLang.initialised)
 
       // Sort out some logging functions
-      if (this.isBeta) {
-        this.log.debug = this.log
-        this.log.debugWarn = this.log.warn
-      } else {
-        this.log.debug = () => {}
-        this.log.debugWarn = () => {}
-      }
+      // Homebridge already decides whether debug lines are shown, and it gets it
+      // right in a child bridge too. This used to work it out for itself by
+      // looking for `-D` in the plugin's own process arguments, which a child
+      // bridge does not receive unless that bridge has its own debug setting
+      // turned on - so debug logging silently disappeared for anyone running the
+      // plugin in a child bridge with debug enabled globally.
+      //
+      // `debugWarn` has no equivalent on Homebridge's logger, so it goes out as
+      // a debug line too rather than being invented here.
+      this.log.debugWarn = (...args) => this.log.debug(...args)
 
       // Set up the discovery run counter
       this.discoveryRun = -1
@@ -454,34 +456,38 @@ export default class {
         res.end()
       })
 
+      // A failure to listen - the configured port already taken, or a privileged
+      // port without the rights to use it - arrives as an 'error' event, not
+      // through the listen callback. Node throws an 'error' event that nobody is
+      // listening for, so without this the bridge dies on a port clash and
+      // restarts into the same clash. The callback below only ever runs on
+      // success, and node calls it with no arguments.
+      listenerServer.on('error', (err) => {
+        this.log.warn('%s: %s.', platformLang.listenerError, parseError(err))
+      })
+
+      const logListenerPort = () => {
+        this.log.debug('%s [%s].', platformLang.listenerPort, listenerServer.address().port)
+      }
+
       // Start listening on the above created server
       if (this.config.wemoClient.listen_interface) {
         // User has defined a specific network interface to listen on
-        listenerServer.listen(this.config.wemoClient.port, this.getLocalInterfaceAddress(), (err) => {
-          if (err) {
-            this.log.warn('%s: %s.', platformLang.listenerError, err)
-          } else if (this.config.debug) {
-            // Log the port of the listener server in debug mode
-            this.log('%s [%s].', platformLang.listenerPort, listenerServer.address().port)
-          }
-        })
+        listenerServer.listen(this.config.wemoClient.port, this.getLocalInterfaceAddress(), logListenerPort)
       } else {
         // User has not defined a specific network interface to listen on
-        listenerServer.listen(this.config.wemoClient.port, (err) => {
-          if (err) {
-            this.log.warn('%s: %s', platformLang.listenerError, err)
-          } else if (this.config.debug) {
-            // Log the port of the listener server in debug mode
-            this.log('%s [%s].', platformLang.listenerPort, listenerServer.address().port)
-          }
-        })
+        listenerServer.listen(this.config.wemoClient.port, logListenerPort)
       }
 
       // Set up the SSDP client if the user has not specified manual devices only
       if (this.config.mode !== 'manual') {
-        if (this.isBeta) {
-          this.config.wemoClient.discover_opts.customLogger = this.log
-        }
+        // The discovery client's own chatter goes to the debug log, where
+        // Homebridge decides whether it is shown. It used to be handed the
+        // normal logger only when the plugin thought debug was on, which it
+        // could not tell in a child bridge. The wrapper matters: Homebridge's
+        // `debug` is not bound to its logger, so passing it bare would throw
+        // the first time the discovery client tried to log anything.
+        this.config.wemoClient.discover_opts.customLogger = (...args) => this.log.debug(...args)
         ssdpClient = new ssdp(this.config.wemoClient.discover_opts)
       }
 
@@ -511,19 +517,13 @@ export default class {
 
       // Shutdown the listener server if it's running
       if (listenerServer) {
-        listenerServer.close(() => {
-          if (this.config.debug) {
-            this.log('%s.', platformLang.listenerClosed)
-          }
-        })
+        listenerServer.close(() => this.log.debug('%s.', platformLang.listenerClosed))
       }
 
       // Stop the SSDP client if it's running
       if (ssdpClient) {
         ssdpClient.stop()
-        if (this.config.debug) {
-          this.log('%s.', platformLang.ssdpStopped)
-        }
+        this.log.debug('%s.', platformLang.ssdpStopped)
       }
 
       // Close accessory subscriptions
@@ -778,22 +778,21 @@ export default class {
   }
 
   applyAccessoryLogging(accessory) {
-    if (this.isBeta) {
-      accessory.log = msg => this.log('[%s] %s.', accessory.displayName, msg)
-      accessory.logWarn = msg => this.log.warn('[%s] %s.', accessory.displayName, msg)
-      accessory.logDebug = msg => this.log('[%s] %s.', accessory.displayName, msg)
-      accessory.logDebugWarn = msg => this.log.warn('[%s] %s.', accessory.displayName, msg)
-    } else {
-      if (this.config.disableDeviceLogging) {
-        accessory.log = () => {}
-        accessory.logWarn = () => {}
-      } else {
-        accessory.log = msg => this.log('[%s] %s.', accessory.displayName, msg)
-        accessory.logWarn = msg => this.log.warn('[%s] %s.', accessory.displayName, msg)
-      }
-      accessory.logDebug = () => {}
-      accessory.logDebugWarn = () => {}
+    // Debug lines always go to Homebridge's debug logger, which prints them only
+    // when debug is on - so there is nothing to decide here. Working it out from
+    // the process arguments instead is what lost debug logging entirely for
+    // anyone running the plugin in a child bridge.
+    accessory.logDebug = msg => this.log.debug('[%s] %s.', accessory.displayName, msg)
+    accessory.logDebugWarn = accessory.logDebug
+
+    if (this.config.disableDeviceLogging) {
+      accessory.log = () => {}
+      accessory.logWarn = () => {}
+      return
     }
+
+    accessory.log = msg => this.log('[%s] %s.', accessory.displayName, msg)
+    accessory.logWarn = msg => this.log.warn('[%s] %s.', accessory.displayName, msg)
   }
 
   async initialiseDevice(device) {

package/lib/utils/lang-en.js

@@ -1,7 +1,7 @@
 export default {
   accNotFound: 'accessory not found',
   accNotReady: 'has not been discovered yet so commands will fail',
-  alDisabled: 'adaptive lighting disabled due to significant colour change',
+  alDisabled: 'adaptive lighting turned off, as the colour was changed outside HomeKit',
   awaiting: 'The following devices have still not been initially found',
   brand: 'Belkin Wemo',
   brightnessFail: 'could not obtain updated brightness as',

package/package.json

@@ -2,7 +2,7 @@
   "name": "@homebridge-plugins/homebridge-wemo",
   "alias": "Wemo",
   "type": "module",
-  "version": "7.7.0",
+  "version": "7.7.1-beta.0",
   "description": "Homebridge plugin to integrate Wemo devices into HomeKit.",
   "author": {
     "name": "bwp91",

package/lib/utils/functions.test.js

@@ -1,98 +0,0 @@
-import { describe, expect, it } from 'vitest'
-
-import { decodeXML, generateRandomString, hasProperty, parseError, parseSerialNumber } from './functions.js'
-
-describe('decodeXML', () => {
-  it('decodes the entities wemo devices put in their soap responses', () => {
-    expect(decodeXML('&lt;tag&gt;')).toBe('<tag>')
-    expect(decodeXML('Tom &amp; Jerry')).toBe('Tom & Jerry')
-    expect(decodeXML('&quot;quoted&quot;')).toBe('"quoted"')
-    expect(decodeXML('it&#039;s')).toBe('it\'s')
-  })
-
-  it('decodes a realistic nested payload', () => {
-    // Wemo wraps its state XML inside another XML document, so the inner
-    // document arrives entity-encoded and has to be decoded before parsing.
-    expect(decodeXML('&lt;BinaryState&gt;1&lt;/BinaryState&gt;'))
-      .toBe('<BinaryState>1</BinaryState>')
-  })
-
-  it('leaves text with no entities untouched', () => {
-    expect(decodeXML('plain text')).toBe('plain text')
-    expect(decodeXML('')).toBe('')
-  })
-
-  it('decodes an escaped ampersand entity twice, because &amp; is replaced first', () => {
-    // ⚠️ Documenting real behaviour, not endorsing it. The replacements run in
-    // order with &amp; first, so "&amp;lt;" becomes "&lt;" and is then decoded
-    // again to "<". Anything relying on a literal "&lt;" surviving would be
-    // disappointed - worth knowing if this is ever reused elsewhere.
-    expect(decodeXML('&amp;lt;')).toBe('<')
-  })
-})
-
-describe('parseSerialNumber', () => {
-  it('uppercases and strips the spacing users paste in', () => {
-    expect(parseSerialNumber('abc 123')).toBe('ABC123')
-    expect(parseSerialNumber('  abc123  ')).toBe('ABC123')
-  })
-
-  it('strips quotes, which get added when copying from a log', () => {
-    expect(parseSerialNumber('"ABC123"')).toBe('ABC123')
-    expect(parseSerialNumber('\'ABC123\'')).toBe('ABC123')
-  })
-
-  it('accepts a non-string value without throwing', () => {
-    expect(parseSerialNumber(123456)).toBe('123456')
-  })
-
-  it('leaves an already-clean serial alone', () => {
-    expect(parseSerialNumber('ABC123')).toBe('ABC123')
-  })
-})
-
-describe('generateRandomString', () => {
-  it('returns the requested length', () => {
-    expect(generateRandomString(16)).toHaveLength(16)
-  })
-
-  it('uses only lowercase letters and digits', () => {
-    expect(generateRandomString(200)).toMatch(/^[a-z0-9]+$/)
-  })
-
-  it('does not return the same value twice in a row', () => {
-    expect(generateRandomString(32)).not.toBe(generateRandomString(32))
-  })
-})
-
-describe('hasProperty', () => {
-  it('detects own properties only', () => {
-    expect(hasProperty({ a: 1 }, 'a')).toBe(true)
-    expect(hasProperty({ a: undefined }, 'a')).toBe(true)
-    expect(hasProperty({}, 'a')).toBe(false)
-  })
-
-  it('ignores inherited properties', () => {
-    expect(hasProperty({}, 'toString')).toBe(false)
-  })
-})
-
-describe('parseError', () => {
-  it('appends the first stack frame to the message', () => {
-    const err = new Error('boom')
-    err.stack = 'Error: boom\n    at thing (/a.js:1:1)'
-    expect(parseError(err)).toBe('boom at thing (/a.js:1:1)')
-  })
-
-  it('hides the stack for errors the caller expects', () => {
-    const err = new Error('EHOSTUNREACH')
-    err.stack = 'Error: EHOSTUNREACH\n    at thing (/a.js:1:1)'
-    expect(parseError(err, ['EHOSTUNREACH'])).toBe('EHOSTUNREACH')
-  })
-
-  it('returns the message when there is no stack', () => {
-    const err = new Error('nostack')
-    err.stack = ''
-    expect(parseError(err)).toBe('nostack')
-  })
-})