@homebridge-plugins/homebridge-govee 11.32.2-beta.21 → 11.32.2-beta.22

package/CHANGELOG.md

@@ -40,6 +40,7 @@ All notable changes to `@homebridge-plugins/homebridge-govee` will be documented
 - test: check what the plugin sends over aws, the local network and the public api, none of which was covered before
 - feat: say when govee has not listed a capability the plugin is about to use, since the request then succeeds and the device does nothing
 - docs: note that the local network api accepts the raw command form, which is how scenes work without the cloud
+- refactor: give every device one shared starting point, so the way a failed command is reported and undone is decided in one place rather than a hundred
 
 ## v11.32.1 (2026-08-02)
 

package/lib/device/appliance-basic.js

@@ -1,7 +1,8 @@
 import { describeSources, resolveControls } from '../utils/capabilities.js'
-import { base64ToHex, getTwoItemPosition, hexToTwoItems, parseError } from '../utils/functions.js'
+import { base64ToHex, getTwoItemPosition, hexToTwoItems } from '../utils/functions.js'
 import platformLang from '../utils/lang-en.js'
 import { logUnknownData, reportUnsupportedControl } from '../utils/report-unknown.js'
+import GoveeDevice from './base.js'
 
 /**
  * A starting point for any appliance whose power command is known but whose
@@ -20,16 +21,10 @@ import { logUnknownData, reportUnsupportedControl } from '../utils/report-unknow
  *
  * Once that data arrives the model gets a proper handler and stops using this.
  */
-class ApplianceBasic {
+class ApplianceBasic extends GoveeDevice {
   constructor(platform, accessory, config) {
-    // Set up variables from the platform
-    this.hapChar = platform.api.hap.Characteristic
-    this.hapErr = platform.api.hap.HapStatusError
-    this.hapServ = platform.api.hap.Service
-    this.platform = platform
-
+    super(platform, accessory)
     // Set up variables from the accessory
-    this.accessory = accessory
     this.config = config
 
     // Work out what this particular device can do, rather than what its model
@@ -174,11 +169,9 @@ class ApplianceBasic {
       this.cacheToggles[control] = value
       this.accessory.log(`current ${control} [${value ? 'on' : 'off'}]`)
     } catch (err) {
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.service.updateCharacteristic(characteristic, previous)
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }
 
@@ -211,14 +204,9 @@ class ApplianceBasic {
       }
       this.accessory.log(`${platformLang.curState} [${newValue}]`)
     } catch (err) {
-      // Catch any errors during the process
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-
-      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.service.updateCharacteristic(this.hapChar.Active, this.cacheState === 'on' ? 1 : 0)
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }
 

package/lib/device/base.js

@@ -0,0 +1,80 @@
+import { parseError } from '../utils/functions.js'
+import platformLang from '../utils/lang-en.js'
+
+/**
+ * What every device handler needs, in one place.
+ *
+ * Each handler used to open with the same five assignments, build its tiles the
+ * same way, and end every control with the same six-line failure block. That
+ * last one was written out a hundred times over, which meant the delay before a
+ * control snaps back, and the error HomeKit is given, were a hundred separate
+ * decisions that happened to agree.
+ */
+export default class GoveeDevice {
+  constructor(platform, accessory) {
+    this.hapChar = platform.api.hap.Characteristic
+    this.hapErr = platform.api.hap.HapStatusError
+    this.hapServ = platform.api.hap.Service
+    this.platform = platform
+    this.accessory = accessory
+  }
+
+  /**
+   * The line at startup saying which of this device's settings are not the
+   * defaults.
+   */
+  logInitOptions(options = {}) {
+    this.platform.log(
+      '[%s] %s %s.',
+      this.accessory.displayName,
+      platformLang.devInitOpts,
+      JSON.stringify(options),
+    )
+  }
+
+  /**
+   * Get a tile, making it if it is not there yet.
+   */
+  getOrAddService(serviceType, name, subtype) {
+    return this.accessory.getService(name ?? serviceType)
+      || this.accessory.addService(serviceType, name, subtype)
+  }
+
+  /**
+   * Drop a tile if the device has one, for when a setting has changed what this
+   * device should look like. Leaving the old one behind gives the owner a tile
+   * that no longer does anything.
+   */
+  removeServiceIfPresent(serviceType) {
+    const existing = this.accessory.getService(serviceType)
+    if (existing) {
+      this.accessory.removeService(existing)
+    }
+    return !!existing
+  }
+
+  /**
+   * Give up on a control, put it back the way it was, and tell HomeKit.
+   *
+   * The three parts matter together: the log line says what went wrong, the
+   * revert stops the tile showing a state the device is not in, and the error
+   * is what makes HomeKit show it as not responding rather than quietly
+   * accepting a change that never happened.
+   *
+   * `revert` is a function rather than a value so it is read when it runs, two
+   * seconds later, which is the behaviour this replaced.
+   *
+   * @param {Error} err whatever went wrong
+   * @param {Function} [revert] puts the control back
+   * @throws {object} always - the caller is expected to let this bubble up
+   */
+  failUpdate(err, revert) {
+    this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
+
+    if (revert) {
+      setTimeout(revert, 2000)
+    }
+
+    throw new this.hapErr(-70402)
+  }
+}

package/lib/device/cooler-single.js

@@ -1,16 +1,11 @@
 import { generateRandomString, hasProperty, parseError } from '../utils/functions.js'
 import platformLang from '../utils/lang-en.js'
+import GoveeDevice from './base.js'
 
-export default class {
+export default class extends GoveeDevice {
   constructor(platform, accessory) {
-    // Set up variables from the platform
-    this.hapChar = platform.api.hap.Characteristic
-    this.hapErr = platform.api.hap.HapStatusError
-    this.hapServ = platform.api.hap.Service
-    this.platform = platform
-
+    super(platform, accessory)
     // Set up variables from the accessory
-    this.accessory = accessory
     this.temperatureSource = accessory.context.temperatureSource;
 
     // Remove any old services from simulations
@@ -149,14 +144,9 @@ export default class {
         value === 1 ? newOnState : 0,
       )
     } catch (err) {
-      // Catch any errors during the process
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-
-      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.service.updateCharacteristic(this.hapChar.Active, this.cacheState === 'on' ? 1 : 0)
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }
 
@@ -211,17 +201,12 @@ export default class {
         this.cacheCool === 'on' ? 3 : 1,
       )
     } catch (err) {
-      // Catch any errors during the process
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-
-      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.service.updateCharacteristic(
           this.hapChar.CoolingThresholdTemperature,
           this.accessory.context.cacheTarget,
         )
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }
 

package/lib/device/dehumidifier-H7150.js

@@ -2,10 +2,10 @@ import {
   base64ToHex,
   getTwoItemPosition,
   hexToTwoItems,
-  parseError,
 } from '../utils/functions.js'
 import platformLang from '../utils/lang-en.js'
 import { logUnknownData } from '../utils/report-unknown.js'
+import GoveeDevice from './base.js'
 
 /*
   H7150, H7151 and H7152
@@ -32,17 +32,9 @@ import { logUnknownData } from '../utils/report-unknown.js'
     }
   }
  */
-export default class GoveeDehumidifierH7150 {
+export default class GoveeDehumidifierH7150 extends GoveeDevice {
   constructor(platform, accessory) {
-    // Set up variables from the platform
-    this.hapChar = platform.api.hap.Characteristic
-    this.hapErr = platform.api.hap.HapStatusError
-    this.hapServ = platform.api.hap.Service
-    this.platform = platform
-
-    // Set up variables from the accessory
-    this.accessory = accessory
-
+    super(platform, accessory)
     // Speed codes
     this.value2Code = {
       1: 'MwUBAQAAAAAAAAAAAAAAAAAAADY=',
@@ -108,14 +100,9 @@ export default class GoveeDehumidifierH7150 {
       this.cacheState = newValue
       this.accessory.log(`${platformLang.curState} [${newValue}]`)
     } catch (err) {
-      // Catch any errors during the process
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-
-      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.service.updateCharacteristic(this.hapChar.On, this.cacheState === 'on')
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }
 
@@ -147,14 +134,9 @@ export default class GoveeDehumidifierH7150 {
       this.cacheSpeed = value
       this.accessory.log(`${platformLang.curSpeed} [${value}]`)
     } catch (err) {
-      // Catch any errors during the process
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-
-      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.service.updateCharacteristic(this.hapChar.RotationSpeed, this.cacheSpeed)
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }
 

package/lib/device/diffuser-H7161.js

@@ -2,22 +2,14 @@ import {
   base64ToHex,
   getTwoItemPosition,
   hexToTwoItems,
-  parseError,
 } from '../utils/functions.js'
 import platformLang from '../utils/lang-en.js'
 import { logUnknownData } from '../utils/report-unknown.js'
+import GoveeDevice from './base.js'
 
-export default class {
+export default class extends GoveeDevice {
   constructor(platform, accessory) {
-    // Set up variables from the platform
-    this.hapChar = platform.api.hap.Characteristic
-    this.hapErr = platform.api.hap.HapStatusError
-    this.hapServ = platform.api.hap.Service
-    this.platform = platform
-
-    // Set up variables from the accessory
-    this.accessory = accessory
-
+    super(platform, accessory)
     // Remove fan service if exists
     if (this.accessory.getService(this.hapServ.Fan)) {
       this.accessory.removeService(this.accessory.getService(this.hapServ.Fan))
@@ -71,14 +63,9 @@ export default class {
 
       this.service.updateCharacteristic(this.hapChar.CurrentAirPurifierState, value === 1 ? 2 : 0)
     } catch (err) {
-      // Catch any errors during the process
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-
-      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.service.updateCharacteristic(this.hapChar.Active, this.cacheState === 'on' ? 1 : 0)
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }
 

package/lib/device/fan-H1370.js

@@ -6,11 +6,11 @@ import {
   getTwoItemPosition,
   hexToTwoItems,
   hkPercentToFanSpeed,
-  parseError,
   sleep,
 } from '../utils/functions.js'
 import platformLang from '../utils/lang-en.js'
 import { logUnknownData } from '../utils/report-unknown.js'
+import GoveeDevice from './base.js'
 
 /*
   Codes below were decoded from a real device's AWS status reports in
@@ -20,17 +20,9 @@ import { logUnknownData } from '../utils/report-unknown.js'
   The light reports through the standard state/brightness/kelvin fields
   (colour temperature only, 2700-6500K)
 */
-export default class {
+export default class extends GoveeDevice {
   constructor(platform, accessory) {
-    // Set up variables from the platform
-    this.hapChar = platform.api.hap.Characteristic
-    this.hapErr = platform.api.hap.HapStatusError
-    this.hapServ = platform.api.hap.Service
-    this.platform = platform
-
-    // Set up variables from the accessory
-    this.accessory = accessory
-
+    super(platform, accessory)
     // Set up custom variables for this device type
     const deviceConf = platform.deviceConf[accessory.context.gvDeviceId]
     this.hideLight = deviceConf && deviceConf.hideLight
@@ -138,14 +130,9 @@ export default class {
         this.accessory.log(`${platformLang.curState} [${newValue}]`)
       }
     } catch (err) {
-      // Catch any errors during the process
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-
-      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.service.updateCharacteristic(this.hapChar.Active, this.cacheState === 'on' ? 1 : 0)
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }
 
@@ -176,14 +163,9 @@ export default class {
         this.accessory.log(`${platformLang.curSpeed} [${value}]`)
       }
     } catch (err) {
-      // Catch any errors during the process
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-
-      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.service.updateCharacteristic(this.hapChar.RotationSpeed, fanSpeedToHkPercent(this.cacheSpeed, this.speedSteps))
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }
 
@@ -208,14 +190,9 @@ export default class {
         this.accessory.log(`${platformLang.curLight} [${newValue}]`)
       }
     } catch (err) {
-      // Catch any errors during the process
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-
-      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.lightService.updateCharacteristic(this.hapChar.On, this.cacheLightState === 'on')
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }
 
@@ -246,14 +223,9 @@ export default class {
         this.accessory.log(`${platformLang.curBright} [${value}%]`)
       }
     } catch (err) {
-      // Catch any errors during the process
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-
-      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.lightService.updateCharacteristic(this.hapChar.Brightness, this.cacheBright)
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }
 
@@ -287,14 +259,9 @@ export default class {
       this.cacheKelvin = k
       this.accessory.log(`${platformLang.curColour} [${k}K]`)
     } catch (err) {
-      // Catch any errors during the process
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-
-      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.lightService.updateCharacteristic(this.hapChar.ColorTemperature, this.cacheMired)
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }
 

package/lib/device/fan-H7100.js

@@ -5,10 +5,10 @@ import {
   getTwoItemPosition,
   hexToTwoItems,
   hkPercentToFanSpeed,
-  parseError,
 } from '../utils/functions.js'
 import platformLang from '../utils/lang-en.js'
 import { logUnknownData } from '../utils/report-unknown.js'
+import GoveeDevice from './base.js'
 
 /*
   The models on this handler and the modes each offers:
@@ -20,17 +20,9 @@ import { logUnknownData } from '../utils/report-unknown.js'
                          never been confirmed, so it is not read back
  */
 
-export default class GoveeFanH7100 {
+export default class GoveeFanH7100 extends GoveeDevice {
   constructor(platform, accessory) {
-    // Set up variables from the platform
-    this.hapChar = platform.api.hap.Characteristic
-    this.hapErr = platform.api.hap.HapStatusError
-    this.hapServ = platform.api.hap.Service
-    this.platform = platform
-
-    // Set up variables from the accessory
-    this.accessory = accessory
-
+    super(platform, accessory)
     // Which of the models on this handler have a confirmed meaning for the
     // oscillation status message
     this.readsSwingStatus = getDeviceCapabilities(accessory.context.gvModel).readsSwingStatus
@@ -119,14 +111,9 @@ export default class GoveeFanH7100 {
         this.accessory.log(`${platformLang.curState} [${newValue}]`)
       }
     } catch (err) {
-      // Catch any errors during the process
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-
-      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.service.updateCharacteristic(this.hapChar.Active, this.cacheState === 'on' ? 1 : 0)
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }
 
@@ -162,14 +149,9 @@ export default class GoveeFanH7100 {
         this.accessory.log(`${platformLang.curSpeed} [${value}]`)
       }
     } catch (err) {
-      // Catch any errors during the process
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-
-      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.service.updateCharacteristic(this.hapChar.RotationSpeed, fanSpeedToHkPercent(this.cacheSpeed, this.speedSteps, this.autoSpeed))
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }
 
@@ -195,14 +177,9 @@ export default class GoveeFanH7100 {
         this.accessory.log(`${platformLang.curSwing} [${newValue}]`)
       }
     } catch (err) {
-      // Catch any errors during the process
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-
-      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.service.updateCharacteristic(this.hapChar.SwingMode, this.cacheSwing === 'on' ? 1 : 0)
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }
 

package/lib/device/fan-H7105.js

@@ -8,23 +8,15 @@ import {
   hexToDecimal,
   hexToTwoItems,
   hkPercentToFanSpeed,
-  parseError,
   sleep,
 } from '../utils/functions.js'
 import platformLang from '../utils/lang-en.js'
 import { logUnknownData } from '../utils/report-unknown.js'
+import GoveeDevice from './base.js'
 
-export default class {
+export default class extends GoveeDevice {
   constructor(platform, accessory) {
-    // Set up variables from the platform
-    this.hapChar = platform.api.hap.Characteristic
-    this.hapErr = platform.api.hap.HapStatusError
-    this.hapServ = platform.api.hap.Service
-    this.platform = platform
-
-    // Set up variables from the accessory
-    this.accessory = accessory
-
+    super(platform, accessory)
     // Set up custom variables for this device type
     const deviceConf = platform.deviceConf[accessory.context.gvDeviceId]
     this.hideLight = deviceConf && deviceConf.hideLight
@@ -151,14 +143,9 @@ export default class {
         this.accessory.log(`${platformLang.curState} [${newValue}]`)
       }
     } catch (err) {
-      // Catch any errors during the process
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-
-      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.service.updateCharacteristic(this.hapChar.Active, this.cacheState === 'on' ? 1 : 0)
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }
 
@@ -192,14 +179,9 @@ export default class {
         this.accessory.log(`${platformLang.curSpeed} [${value}]`)
       }
     } catch (err) {
-      // Catch any errors during the process
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-
-      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.service.updateCharacteristic(this.hapChar.RotationSpeed, fanSpeedToHkPercent(this.cacheSpeed, this.speedSteps, this.autoSpeed))
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }
 
@@ -233,14 +215,9 @@ export default class {
       //   this.accessory.log(`${platformLang.curSwing} [${newValue}]`)
       // }
     } catch (err) {
-      // Catch any errors during the process
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-
-      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.service.updateCharacteristic(this.hapChar.SwingMode, this.cacheSwing === 'on' ? 1 : 0)
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }
 
@@ -268,14 +245,9 @@ export default class {
         this.accessory.log(`${platformLang.curLight} [${newValue}]`)
       }
     } catch (err) {
-      // Catch any errors during the process
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-
-      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.lightService.updateCharacteristic(this.hapChar.On, this.cacheLightState === 'on')
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }
 
@@ -322,14 +294,9 @@ export default class {
         this.accessory.log(`${platformLang.curBright} [${value}%]`)
       }
     } catch (err) {
-      // Catch any errors during the process
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-
-      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.lightService.updateCharacteristic(this.hapChar.Brightness, this.cacheBright)
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }
 
@@ -366,14 +333,9 @@ export default class {
         this.accessory.log(`${platformLang.curColour} [rgb ${newRGB.join(' ')}]`)
       }
     } catch (err) {
-      // Catch any errors during the process
-      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
-
-      // Throw a 'no response' error and set a timeout to revert this after 2 seconds
-      setTimeout(() => {
+      this.failUpdate(err, () => {
         this.lightService.updateCharacteristic(this.hapChar.Hue, this.cacheHue)
-      }, 2000)
-      throw new this.hapErr(-70402)
+      })
     }
   }