@homebridge-plugins/homebridge-govee 11.32.0-beta.2 → 11.32.0-beta.21

package/lib/device/fan-H7111.js

@@ -1,7 +1,9 @@
 import {
   base64ToHex,
+  fanSpeedToHkPercent,
   getTwoItemPosition,
   hexToTwoItems,
+  hkPercentToFanSpeed,
   parseError,
 } from '../utils/functions.js'
 import platformLang from '../utils/lang-en.js'
@@ -91,6 +93,8 @@ export default class {
       9: 'MwUAAwAAAAAAAAAAAAAAAAAAADU=', // auto mode
     }
     this.autoSpeed = 9
+    // Real speed steps, excluding auto - HomeKit percentages map onto these
+    this.speedSteps = 8
 
     // Remove any old original Fan services
     if (this.accessory.getService(this.hapServ.Fan)) {
@@ -176,12 +180,8 @@ export default class {
         return
       }
 
-      // HomeKit sends percentages
-      if (value >= 100) {
-        value = this.autoSpeed
-      } else if (value > 8) {
-        value = Math.max(1, Math.min(8, Math.round(value * 8 / 100)))
-      }
+      // HomeKit sends a percentage - map it onto this model's real speed steps
+      value = hkPercentToFanSpeed(value, this.speedSteps)
 
       // Don't continue if the new value is the same as before
       if (this.cacheSpeed === value) {
@@ -210,7 +210,7 @@ export default class {
 
       // Throw a 'no response' error and set a timeout to revert this after 2 seconds
       setTimeout(() => {
-        this.service.updateCharacteristic(this.hapChar.RotationSpeed, this.cacheSpeed)
+        this.service.updateCharacteristic(this.hapChar.RotationSpeed, fanSpeedToHkPercent(this.cacheSpeed, this.speedSteps, this.autoSpeed))
       }, 2000)
       throw new this.hapErr(-70402)
     }
@@ -265,14 +265,11 @@ export default class {
       } else {
         newSpeed = params.workMode.modeValue
       }
-      if (Number.isFinite(newSpeed) && newSpeed >= 1 && newSpeed <= this.autoSpeed) {
-        const hkSpeed = newSpeed === this.autoSpeed ? 100 : Math.round((newSpeed / 8) * 100)
-
-        if (this.cacheSpeed !== hkSpeed) {
-          this.cacheSpeed = hkSpeed
-          this.service.updateCharacteristic(this.hapChar.RotationSpeed, hkSpeed)
-          this.accessory.log(`${platformLang.curSpeed} [${newSpeed} -> ${hkSpeed}%]`)
-        }
+      if (Number.isFinite(newSpeed) && newSpeed >= 1 && newSpeed <= this.autoSpeed && this.cacheSpeed !== newSpeed) {
+        this.cacheSpeed = newSpeed
+        const hkSpeed = fanSpeedToHkPercent(newSpeed, this.speedSteps, this.autoSpeed)
+        this.service.updateCharacteristic(this.hapChar.RotationSpeed, hkSpeed)
+        this.accessory.log(`${platformLang.curSpeed} [${newSpeed} -> ${hkSpeed}%]`)
       }
     }
 
@@ -309,10 +306,9 @@ export default class {
         case '0501': {
           // Fan speed
           const newSpeed = Number.parseInt(getTwoItemPosition(hexParts, 4), 16)
-          if (newSpeed >= 1 && newSpeed <= 8) {
-            const hkSpeed = Math.round((newSpeed / 8) * 100)
-
-            this.cacheSpeed = hkSpeed
+          if (newSpeed >= 1 && newSpeed <= this.speedSteps && this.cacheSpeed !== newSpeed) {
+            this.cacheSpeed = newSpeed
+            const hkSpeed = fanSpeedToHkPercent(newSpeed, this.speedSteps, this.autoSpeed)
             this.service.updateCharacteristic(this.hapChar.RotationSpeed, hkSpeed)
             this.accessory.log(`${platformLang.curSpeed} [${newSpeed} -> ${hkSpeed}%]`)
           }
@@ -321,7 +317,8 @@ export default class {
         case '0500': {
           // Mode change (auto = 0x03)
           if (getTwoItemPosition(hexParts, 4) === '03' && this.cacheSpeed !== this.autoSpeed) {
-            this.cacheSpeed = 100
+            // Cache auto so we can tell it apart from "user asked for max speed"
+            this.cacheSpeed = this.autoSpeed
             this.service.updateCharacteristic(this.hapChar.RotationSpeed, 100)
             this.accessory.log(`${platformLang.curSpeed} [auto -> 100%]`)
           }

package/lib/device/outlet-double.js

@@ -1,6 +1,10 @@
-import { parseError } from '../utils/functions.js'
+import { base64ToHex, generateCodeFromHexValues, parseError } from '../utils/functions.js'
 import platformLang from '../utils/lang-en.js'
 
+// Models here with a night light, reported as status code `aa 1b 01 [on] [level]`
+// and set with the matching `33 1b 01 [on] [level]` (H5089, #1323)
+const nightLightModels = ['H5089']
+
 export default class {
   constructor(platform, accessory) {
     // Set up variables from the platform
@@ -20,6 +24,14 @@ export default class {
       this.accessory.removeService(this.accessory.getService('Switch 2'))
     }
 
+    // A model that used to be treated as a single switch or outlet leaves an
+    // unnumbered service behind, which would sit next to the numbered pair as
+    // a tile that no longer does anything (#1323)
+    this.accessory.services
+      .filter(service => !service.subtype
+        && [this.hapServ.Switch.UUID, this.hapServ.Outlet.UUID].includes(service.UUID))
+      .forEach(service => this.accessory.removeService(service))
+
     // Add the outlet services if they don't already exist
     this.service1 = this.accessory.getService('Outlet 1')
       || this.accessory.addService(this.hapServ.Outlet, 'Outlet 1', 'outlet1')
@@ -53,18 +65,39 @@ export default class {
     })
     this.service2.cacheState = this.service2.getCharacteristic(this.hapChar.On).value ? 'on' : 'off'
 
+    // Add a night light service for the models that have one
+    if (nightLightModels.includes(this.accessory.context.gvModel)) {
+      this.lightService = this.accessory.getService('Night Light')
+        || this.accessory.addService(this.hapServ.Lightbulb, 'Night Light', 'nightlight')
+      if (!this.lightService.testCharacteristic(this.hapChar.ConfiguredName)) {
+        this.lightService.addCharacteristic(this.hapChar.ConfiguredName)
+        this.lightService.updateCharacteristic(this.hapChar.ConfiguredName, 'Night Light')
+      }
+      this.lightService.getCharacteristic(this.hapChar.On).onSet(async (value) => {
+        await this.internalLightStateUpdate(value)
+      })
+      this.cacheLightState = this.lightService.getCharacteristic(this.hapChar.On).value ? 'on' : 'off'
+      this.lightService.getCharacteristic(this.hapChar.Brightness).onSet(async (value) => {
+        await this.internalLightBrightnessUpdate(value)
+      })
+      this.cacheLightBright = this.lightService.getCharacteristic(this.hapChar.Brightness).value || 100
+    } else if (this.accessory.getService('Night Light')) {
+      this.accessory.removeService(this.accessory.getService('Night Light'))
+    }
+
     // Output the customised options to the log
     const opts = JSON.stringify({
       showAs: 'outlet',
     })
     platform.log('[%s] %s %s.', accessory.displayName, platformLang.devInitOpts, opts)
 
+    // The value is (which outlets to change << 4) | (which of those to turn on)
     // 51 turns BOTH ON
     // 48 turns BOTH OFF
-    // 34 turns outlet 1 ON
-    // 32 turns outlet 1 OFF
-    // 17 turns outlet 2 ON
-    // 16 turns outlet 2 OFF
+    // 17 turns outlet 1 ON
+    // 16 turns outlet 1 OFF
+    // 34 turns outlet 2 ON
+    // 32 turns outlet 2 OFF
   }
 
   async internalStateUpdate(service, value) {
@@ -99,23 +132,99 @@ export default class {
     }
   }
 
-  externalUpdate(params) {
-    if (!Array.isArray(params.state)) {
-      return
+  async internalLightStateUpdate(value) {
+    try {
+      const newValue = value ? 'on' : 'off'
+      if (this.cacheLightState === newValue) {
+        return
+      }
+
+      // Keep the current level when toggling, so turning the light on does not
+      // also change how bright it is
+      await this.platform.sendDeviceUpdate(this.accessory, {
+        cmd: 'ptReal',
+        value: generateCodeFromHexValues([0x33, 0x1B, 0x01, value ? 0x01 : 0x00, this.cacheLightBright]),
+      })
+
+      this.cacheLightState = newValue
+      this.accessory.log(`[Night Light] ${platformLang.curState} [${newValue}]`)
+    } catch (err) {
+      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
+      setTimeout(() => {
+        this.lightService.updateCharacteristic(this.hapChar.On, this.cacheLightState === 'on')
+      }, 2000)
+      throw new this.hapErr(-70402)
     }
+  }
 
-    if (params.state[0] !== this.service1.cacheState) {
-      this.service1.cacheState = params.state[0]
-      this.service1.updateCharacteristic(this.hapChar.On, this.service1.cacheState === 'on')
+  async internalLightBrightnessUpdate(value) {
+    try {
+      if (value === 0 || this.cacheLightBright === value) {
+        return
+      }
+
+      // Setting a level also turns the light on, matching how HomeKit sends
+      // brightness changes alongside an on command
+      await this.platform.sendDeviceUpdate(this.accessory, {
+        cmd: 'ptReal',
+        value: generateCodeFromHexValues([0x33, 0x1B, 0x01, 0x01, value]),
+      })
 
-      this.accessory.log(`[${this.service1.getCharacteristic(this.hapChar.ConfiguredName).value}] ${platformLang.curState} [${this.service1.cacheState}]`)
+      this.cacheLightBright = value
+      this.accessory.log(`[Night Light] ${platformLang.curBright} [${value}%]`)
+    } catch (err) {
+      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
+      setTimeout(() => {
+        this.lightService.updateCharacteristic(this.hapChar.Brightness, this.cacheLightBright)
+      }, 2000)
+      throw new this.hapErr(-70402)
     }
+  }
+
+  externalUpdate(params) {
+    if (Array.isArray(params.state)) {
+      if (params.state[0] !== this.service1.cacheState) {
+        this.service1.cacheState = params.state[0]
+        this.service1.updateCharacteristic(this.hapChar.On, this.service1.cacheState === 'on')
+
+        this.accessory.log(`[${this.service1.getCharacteristic(this.hapChar.ConfiguredName).value}] ${platformLang.curState} [${this.service1.cacheState}]`)
+      }
 
-    if (params.state[1] !== this.service2.cacheState) {
-      this.service2.cacheState = params.state[1]
-      this.service2.updateCharacteristic(this.hapChar.On, this.service2.cacheState === 'on')
+      if (params.state[1] !== this.service2.cacheState) {
+        this.service2.cacheState = params.state[1]
+        this.service2.updateCharacteristic(this.hapChar.On, this.service2.cacheState === 'on')
 
-      this.accessory.log(`[${this.service2.getCharacteristic(this.hapChar.ConfiguredName).value}] ${platformLang.curState} [${this.service2.cacheState}]`)
+        this.accessory.log(`[${this.service2.getCharacteristic(this.hapChar.ConfiguredName).value}] ${platformLang.curState} [${this.service2.cacheState}]`)
+      }
+    }
+
+    // The night light reports as `aa 1b 01 [on] [level]` (#1323)
+    if (this.lightService && Array.isArray(params.commands)) {
+      params.commands.forEach((command) => {
+        let hexString
+        try {
+          hexString = base64ToHex(command)
+        } catch {
+          return
+        }
+        if (!hexString.startsWith('aa1b01')) {
+          return
+        }
+
+        const newState = hexString.substring(6, 8) === '01' ? 'on' : 'off'
+        if (newState !== this.cacheLightState) {
+          this.cacheLightState = newState
+          this.lightService.updateCharacteristic(this.hapChar.On, newState === 'on')
+          this.accessory.log(`[Night Light] ${platformLang.curState} [${newState}]`)
+        }
+
+        const newBright = Number.parseInt(hexString.substring(8, 10), 16)
+        if (newBright >= 1 && newBright <= 100 && newBright !== this.cacheLightBright) {
+          this.cacheLightBright = newBright
+          this.lightService.updateCharacteristic(this.hapChar.Brightness, newBright)
+          this.accessory.log(`[Night Light] ${platformLang.curBright} [${newBright}%]`)
+        }
+      })
     }
   }
 }

package/lib/device/switch-double.js

@@ -1,6 +1,10 @@
-import { parseError } from '../utils/functions.js'
+import { base64ToHex, generateCodeFromHexValues, parseError } from '../utils/functions.js'
 import platformLang from '../utils/lang-en.js'
 
+// Models here with a night light, reported as status code `aa 1b 01 [on] [level]`
+// and set with the matching `33 1b 01 [on] [level]` (H5089, #1323)
+const nightLightModels = ['H5089']
+
 export default class {
   constructor(platform, accessory) {
     // Set up variables from the platform
@@ -20,6 +24,14 @@ export default class {
       this.accessory.removeService(this.accessory.getService('Outlet 2'))
     }
 
+    // A model that used to be treated as a single switch or outlet leaves an
+    // unnumbered service behind, which would sit next to the numbered pair as
+    // a tile that no longer does anything (#1323)
+    this.accessory.services
+      .filter(service => !service.subtype
+        && [this.hapServ.Switch.UUID, this.hapServ.Outlet.UUID].includes(service.UUID))
+      .forEach(service => this.accessory.removeService(service))
+
     // Add the switch services if they don't already exist
     this.service1 = this.accessory.getService('Switch 1')
       || this.accessory.addService(this.hapServ.Switch, 'Switch 1', 'switch1')
@@ -53,18 +65,39 @@ export default class {
     })
     this.service2.cacheState = this.service2.getCharacteristic(this.hapChar.On).value ? 'on' : 'off'
 
+    // Add a night light service for the models that have one
+    if (nightLightModels.includes(this.accessory.context.gvModel)) {
+      this.lightService = this.accessory.getService('Night Light')
+        || this.accessory.addService(this.hapServ.Lightbulb, 'Night Light', 'nightlight')
+      if (!this.lightService.testCharacteristic(this.hapChar.ConfiguredName)) {
+        this.lightService.addCharacteristic(this.hapChar.ConfiguredName)
+        this.lightService.updateCharacteristic(this.hapChar.ConfiguredName, 'Night Light')
+      }
+      this.lightService.getCharacteristic(this.hapChar.On).onSet(async (value) => {
+        await this.internalLightStateUpdate(value)
+      })
+      this.cacheLightState = this.lightService.getCharacteristic(this.hapChar.On).value ? 'on' : 'off'
+      this.lightService.getCharacteristic(this.hapChar.Brightness).onSet(async (value) => {
+        await this.internalLightBrightnessUpdate(value)
+      })
+      this.cacheLightBright = this.lightService.getCharacteristic(this.hapChar.Brightness).value || 100
+    } else if (this.accessory.getService('Night Light')) {
+      this.accessory.removeService(this.accessory.getService('Night Light'))
+    }
+
     // Output the customised options to the log
     const opts = JSON.stringify({
       showAs: 'switch',
     })
     platform.log('[%s] %s %s.', accessory.displayName, platformLang.devInitOpts, opts)
 
+    // The value is (which outlets to change << 4) | (which of those to turn on)
     // 51 turns BOTH ON
     // 48 turns BOTH OFF
-    // 34 turns outlet 1 ON
-    // 32 turns outlet 1 OFF
-    // 17 turns outlet 2 ON
-    // 16 turns outlet 2 OFF
+    // 17 turns outlet 1 ON
+    // 16 turns outlet 1 OFF
+    // 34 turns outlet 2 ON
+    // 32 turns outlet 2 OFF
   }
 
   async internalStateUpdate(service, value) {
@@ -99,23 +132,99 @@ export default class {
     }
   }
 
-  externalUpdate(params) {
-    if (!Array.isArray(params.state)) {
-      return
+  async internalLightStateUpdate(value) {
+    try {
+      const newValue = value ? 'on' : 'off'
+      if (this.cacheLightState === newValue) {
+        return
+      }
+
+      // Keep the current level when toggling, so turning the light on does not
+      // also change how bright it is
+      await this.platform.sendDeviceUpdate(this.accessory, {
+        cmd: 'ptReal',
+        value: generateCodeFromHexValues([0x33, 0x1B, 0x01, value ? 0x01 : 0x00, this.cacheLightBright]),
+      })
+
+      this.cacheLightState = newValue
+      this.accessory.log(`[Night Light] ${platformLang.curState} [${newValue}]`)
+    } catch (err) {
+      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
+      setTimeout(() => {
+        this.lightService.updateCharacteristic(this.hapChar.On, this.cacheLightState === 'on')
+      }, 2000)
+      throw new this.hapErr(-70402)
     }
+  }
 
-    if (params.state[0] !== this.service1.cacheState) {
-      this.service1.cacheState = params.state[0]
-      this.service1.updateCharacteristic(this.hapChar.On, this.service1.cacheState === 'on')
+  async internalLightBrightnessUpdate(value) {
+    try {
+      if (value === 0 || this.cacheLightBright === value) {
+        return
+      }
+
+      // Setting a level also turns the light on, matching how HomeKit sends
+      // brightness changes alongside an on command
+      await this.platform.sendDeviceUpdate(this.accessory, {
+        cmd: 'ptReal',
+        value: generateCodeFromHexValues([0x33, 0x1B, 0x01, 0x01, value]),
+      })
 
-      this.accessory.log(`[${this.service1.getCharacteristic(this.hapChar.ConfiguredName).value}] ${platformLang.curState} [${this.service1.cacheState}]`)
+      this.cacheLightBright = value
+      this.accessory.log(`[Night Light] ${platformLang.curBright} [${value}%]`)
+    } catch (err) {
+      this.accessory.logWarn(`${platformLang.devNotUpdated} ${parseError(err)}`)
+      setTimeout(() => {
+        this.lightService.updateCharacteristic(this.hapChar.Brightness, this.cacheLightBright)
+      }, 2000)
+      throw new this.hapErr(-70402)
     }
+  }
+
+  externalUpdate(params) {
+    if (Array.isArray(params.state)) {
+      if (params.state[0] !== this.service1.cacheState) {
+        this.service1.cacheState = params.state[0]
+        this.service1.updateCharacteristic(this.hapChar.On, this.service1.cacheState === 'on')
+
+        this.accessory.log(`[${this.service1.getCharacteristic(this.hapChar.ConfiguredName).value}] ${platformLang.curState} [${this.service1.cacheState}]`)
+      }
 
-    if (params.state[1] !== this.service2.cacheState) {
-      this.service2.cacheState = params.state[1]
-      this.service2.updateCharacteristic(this.hapChar.On, this.service2.cacheState === 'on')
+      if (params.state[1] !== this.service2.cacheState) {
+        this.service2.cacheState = params.state[1]
+        this.service2.updateCharacteristic(this.hapChar.On, this.service2.cacheState === 'on')
 
-      this.accessory.log(`[${this.service2.getCharacteristic(this.hapChar.ConfiguredName).value}] ${platformLang.curState} [${this.service2.cacheState}]`)
+        this.accessory.log(`[${this.service2.getCharacteristic(this.hapChar.ConfiguredName).value}] ${platformLang.curState} [${this.service2.cacheState}]`)
+      }
+    }
+
+    // The night light reports as `aa 1b 01 [on] [level]` (#1323)
+    if (this.lightService && Array.isArray(params.commands)) {
+      params.commands.forEach((command) => {
+        let hexString
+        try {
+          hexString = base64ToHex(command)
+        } catch {
+          return
+        }
+        if (!hexString.startsWith('aa1b01')) {
+          return
+        }
+
+        const newState = hexString.substring(6, 8) === '01' ? 'on' : 'off'
+        if (newState !== this.cacheLightState) {
+          this.cacheLightState = newState
+          this.lightService.updateCharacteristic(this.hapChar.On, newState === 'on')
+          this.accessory.log(`[Night Light] ${platformLang.curState} [${newState}]`)
+        }
+
+        const newBright = Number.parseInt(hexString.substring(8, 10), 16)
+        if (newBright >= 1 && newBright <= 100 && newBright !== this.cacheLightBright) {
+          this.cacheLightBright = newBright
+          this.lightService.updateCharacteristic(this.hapChar.Brightness, newBright)
+          this.accessory.log(`[Night Light] ${platformLang.curBright} [${newBright}%]`)
+        }
+      })
     }
   }
 }