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

package/lib/device/purifier-H7123.js

@@ -7,9 +7,10 @@ import {
   statusToActionCode,
 } from '../utils/functions.js'
 import platformLang from '../utils/lang-en.js'
+import { logUnknownData } from '../utils/report-unknown.js'
 
 /*
-  H7123
+  H7123 and H7124
   {
     "mode": {
       "options": [
@@ -38,7 +39,7 @@ import platformLang from '../utils/lang-en.js'
   }
  */
 
-export default class {
+export default class GoveePurifierH7123 {
   constructor(platform, accessory) {
     // Set up variables from the platform
     this.cusChar = platform.cusChar
@@ -497,7 +498,12 @@ export default class {
           break
         }
         default:
-          this.accessory.logDebugWarn(`${platformLang.newScene}: [${command}] [${hexString}]`)
+          logUnknownData(this.accessory, {
+            kind: 'scene',
+            source: params.source,
+            raw: command,
+            hex: hexString,
+          })
           break
       }
     })

package/lib/device/purifier-H7126.js

@@ -5,6 +5,7 @@ import {
   parseError,
 } from '../utils/functions.js'
 import platformLang from '../utils/lang-en.js'
+import { logUnknownData } from '../utils/report-unknown.js'
 
 export default class {
   constructor(platform, accessory) {
@@ -351,7 +352,12 @@ export default class {
           break
         }
         default:
-          this.accessory.logDebugWarn(`${platformLang.newScene}: [${command}] [${hexString}]`)
+          logUnknownData(this.accessory, {
+            kind: 'scene',
+            source: params.source,
+            raw: command,
+            hex: hexString,
+          })
           break
       }
     })

package/lib/device/{sensor-button.js → sensor-basic.js}

@@ -1,6 +1,14 @@
 import platformLang from '../utils/lang-en.js'
+import { logUnknownData } from '../utils/report-unknown.js'
 
-export default class {
+/**
+ * A sensor whose broadcasts are not decoded yet.
+ *
+ * It offers no tile, because a tile that never updates is worse than none. What
+ * it does is report every message it receives in one copy-paste line, so an
+ * owner can send in exactly what is needed to finish the model off.
+ */
+export default class GoveeSensorBasic {
   constructor(platform, accessory) {
     // Set up variables from the platform
     this.hapChar = platform.api.hap.Characteristic
@@ -17,6 +25,10 @@ export default class {
   }
 
   externalUpdate(params) {
-    this.accessory.logWarn(`${platformLang.newScene}: [${params.scene}]`)
+    logUnknownData(this.accessory, {
+      kind: 'scene',
+      source: params.source,
+      raw: params.scene,
+    })
   }
 }

package/lib/device/sensor-presence.js

@@ -1,5 +1,6 @@
 import { base64ToHex, getTwoItemPosition, hexToTwoItems } from '../utils/functions.js'
 import platformLang from '../utils/lang-en.js'
+import { logUnknownData } from '../utils/report-unknown.js'
 
 export default class {
   constructor(platform, accessory) {
@@ -45,7 +46,12 @@ export default class {
           break
         }
         default:
-          this.accessory.logDebugWarn(`${platformLang.newScene}: [${command}] [${hexString}]`)
+          logUnknownData(this.accessory, {
+            kind: 'scene',
+            source: params.source,
+            raw: command,
+            hex: hexString,
+          })
           break
       }
     })

package/lib/device/sensor-thermo4.js

@@ -1,5 +1,6 @@
 import { base64ToHex, getTwoItemPosition, hexToTwoItems } from '../utils/functions.js'
 import platformLang from '../utils/lang-en.js'
+import { logUnknownData } from '../utils/report-unknown.js'
 
 export default class {
   constructor(platform, accessory) {
@@ -36,7 +37,12 @@ export default class {
       const hexString = base64ToHex(command)
       const hexParts = hexToTwoItems(hexString)
 
-      this.accessory.logDebugWarn(`${platformLang.newScene}: [${command}] [${hexString}]`)
+      logUnknownData(this.accessory, {
+        kind: 'scene',
+        source: params.source,
+        raw: command,
+        hex: hexString,
+      })
 
       // Return now if not a device query update code
       if (getTwoItemPosition(hexParts, 1) !== 'aa') {
@@ -47,7 +53,12 @@ export default class {
 
       switch (deviceFunction) {
         default:
-          this.accessory.logDebugWarn(`${platformLang.newScene}: [${command}] [${hexString}]`)
+          logUnknownData(this.accessory, {
+            kind: 'scene',
+            source: params.source,
+            raw: command,
+            hex: hexString,
+          })
           break
       }
     })

package/lib/device/switch-double.js

@@ -8,8 +8,8 @@ import platformLang from '../utils/lang-en.js'
 // outright rather than accepted and silently dropped (#1323).
 const nightLightModels = ['H5089']
 
-export default class {
-  constructor(platform, accessory) {
+class MultiSwitchDouble {
+  constructor(platform, accessory, config) {
     // Set up variables from the platform
     this.hapChar = platform.api.hap.Characteristic
     this.hapErr = platform.api.hap.HapStatusError
@@ -19,12 +19,13 @@ export default class {
     // Set up variables from the accessory
     this.accessory = accessory
 
-    // Remove outlet services if they exist
-    if (this.accessory.getService('Outlet 1')) {
-      this.accessory.removeService(this.accessory.getService('Outlet 1'))
+    // Drop the tiles of the other kind, left behind if this device has been
+    // shown as the other one before
+    if (this.accessory.getService(`${config.other} 1`)) {
+      this.accessory.removeService(this.accessory.getService(`${config.other} 1`))
     }
-    if (this.accessory.getService('Outlet 2')) {
-      this.accessory.removeService(this.accessory.getService('Outlet 2'))
+    if (this.accessory.getService(`${config.other} 2`)) {
+      this.accessory.removeService(this.accessory.getService(`${config.other} 2`))
     }
 
     // A model that used to be treated as a single switch or outlet leaves an
@@ -35,15 +36,15 @@ export default class {
         && [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')
-    this.service2 = this.accessory.getService('Switch 2')
-      || this.accessory.addService(this.hapServ.Switch, 'Switch 2', 'switch2')
+    // Add this device's tiles if they are not there already
+    this.service1 = this.accessory.getService(`${config.label} 1`)
+      || this.accessory.addService(this.hapServ[config.label], `${config.label} 1`, `${config.subtype}1`)
+    this.service2 = this.accessory.getService(`${config.label} 2`)
+      || this.accessory.addService(this.hapServ[config.label], `${config.label} 2`, `${config.subtype}2`)
 
     if (!this.service1.testCharacteristic(this.hapChar.ConfiguredName)) {
       this.service1.addCharacteristic(this.hapChar.ConfiguredName)
-      this.service1.updateCharacteristic(this.hapChar.ConfiguredName, 'Switch 1')
+      this.service1.updateCharacteristic(this.hapChar.ConfiguredName, `${config.label} 1`)
     }
     if (!this.service1.testCharacteristic(this.hapChar.ServiceLabelIndex)) {
       this.service1.addCharacteristic(this.hapChar.ServiceLabelIndex)
@@ -51,7 +52,7 @@ export default class {
     }
     if (!this.service2.testCharacteristic(this.hapChar.ConfiguredName)) {
       this.service2.addCharacteristic(this.hapChar.ConfiguredName)
-      this.service2.updateCharacteristic(this.hapChar.ConfiguredName, 'Switch 2')
+      this.service2.updateCharacteristic(this.hapChar.ConfiguredName, `${config.label} 2`)
     }
     if (!this.service2.testCharacteristic(this.hapChar.ServiceLabelIndex)) {
       this.service2.addCharacteristic(this.hapChar.ServiceLabelIndex)
@@ -86,7 +87,7 @@ export default class {
 
     // Output the customised options to the log
     const opts = JSON.stringify({
-      showAs: 'switch',
+      showAs: config.showAs,
     })
     platform.log('[%s] %s %s.', accessory.displayName, platformLang.devInitOpts, opts)
 
@@ -186,3 +187,21 @@ export default class {
     }
   }
 }
+
+/**
+ * A double switch and a double outlet are the same device with a different tile
+ * in the Home app, chosen by the owner's `showAs` setting. Only the service
+ * type, the tile names and the logged option differ, so they share this and are
+ * built from it rather than from a copy of it.
+ */
+function make(config) {
+  return class extends MultiSwitchDouble {
+    constructor(platform, accessory) {
+      super(platform, accessory, config)
+    }
+  }
+}
+
+export default make({ label: 'Switch', subtype: 'switch', other: 'Outlet', showAs: 'switch' })
+
+export const asOutlet = make({ label: 'Outlet', subtype: 'outlet', other: 'Switch', showAs: 'outlet' })

package/lib/device/switch-triple.js

@@ -1,8 +1,8 @@
 import { parseError } from '../utils/functions.js'
 import platformLang from '../utils/lang-en.js'
 
-export default class {
-  constructor(platform, accessory) {
+class MultiSwitchTriple {
+  constructor(platform, accessory, config) {
     // Set up variables from the platform
     this.hapChar = platform.api.hap.Characteristic
     this.hapErr = platform.api.hap.HapStatusError
@@ -12,24 +12,25 @@ export default class {
     // Set up variables from the accessory
     this.accessory = accessory
 
-    // Remove outlet services if they exist
-    if (this.accessory.getService('Outlet 1')) {
-      this.accessory.removeService(this.accessory.getService('Outlet 1'))
+    // Drop the tiles of the other kind, left behind if this device has been
+    // shown as the other one before
+    if (this.accessory.getService(`${config.other} 1`)) {
+      this.accessory.removeService(this.accessory.getService(`${config.other} 1`))
     }
-    if (this.accessory.getService('Outlet 2')) {
-      this.accessory.removeService(this.accessory.getService('Outlet 2'))
+    if (this.accessory.getService(`${config.other} 2`)) {
+      this.accessory.removeService(this.accessory.getService(`${config.other} 2`))
     }
-    if (this.accessory.getService('Outlet 3')) {
-      this.accessory.removeService(this.accessory.getService('Outlet 3'))
+    if (this.accessory.getService(`${config.other} 3`)) {
+      this.accessory.removeService(this.accessory.getService(`${config.other} 3`))
     }
 
-    // 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')
-    this.service2 = this.accessory.getService('Switch 2')
-      || this.accessory.addService(this.hapServ.Switch, 'Switch 2', 'switch2')
-    this.service3 = this.accessory.getService('Switch 3')
-      || this.accessory.addService(this.hapServ.Switch, 'Switch 3', 'switch3')
+    // Add this device's tiles if they are not there already
+    this.service1 = this.accessory.getService(`${config.label} 1`)
+      || this.accessory.addService(this.hapServ[config.label], `${config.label} 1`, `${config.subtype}1`)
+    this.service2 = this.accessory.getService(`${config.label} 2`)
+      || this.accessory.addService(this.hapServ[config.label], `${config.label} 2`, `${config.subtype}2`)
+    this.service3 = this.accessory.getService(`${config.label} 3`)
+      || this.accessory.addService(this.hapServ[config.label], `${config.label} 3`, `${config.subtype}3`)
 
     // Add the set handler to the switch on/off characteristic
     this.service1.getCharacteristic(this.hapChar.On).onSet(async (value) => {
@@ -47,7 +48,7 @@ export default class {
 
     // Output the customised options to the log
     const opts = JSON.stringify({
-      showAs: 'switch',
+      showAs: config.showAs,
     })
     platform.log('[%s] %s %s.', accessory.displayName, platformLang.devInitOpts, opts)
 
@@ -158,3 +159,21 @@ export default class {
     }
   }
 }
+
+/**
+ * A triple switch and a triple outlet are the same device with a different tile
+ * in the Home app, chosen by the owner's `showAs` setting. Only the service
+ * type, the tile names and the logged option differ, so they share this and are
+ * built from it rather than from a copy of it.
+ */
+function make(config) {
+  return class extends MultiSwitchTriple {
+    constructor(platform, accessory) {
+      super(platform, accessory, config)
+    }
+  }
+}
+
+export default make({ label: 'Switch', subtype: 'switch', other: 'Outlet', showAs: 'switch' })
+
+export const asOutlet = make({ label: 'Outlet', subtype: 'outlet', other: 'Switch', showAs: 'outlet' })

package/lib/device/template.js

@@ -1,5 +1,6 @@
 import { base64ToHex, getTwoItemPosition, hexToTwoItems } from '../utils/functions.js'
 import platformLang from '../utils/lang-en.js'
+import { logUnknownData } from '../utils/report-unknown.js'
 
 export default class {
   constructor(platform, accessory) {
@@ -19,7 +20,14 @@ export default class {
   }
 
   externalUpdate(params) {
-    this.accessory.logWarn(JSON.stringify(params))
+    // These are the models actively being worked out, so every payload is worth
+    // reporting in the full form rather than as a bare dump - it is the whole
+    // reason the accessory exists at this stage
+    logUnknownData(this.accessory, {
+      kind: 'payload',
+      source: params.source,
+      raw: params,
+    })
 
     // Check for some other scene/mode change
     ;(params.commands || []).forEach((command) => {
@@ -35,7 +43,12 @@ export default class {
 
       switch (deviceFunction) {
         default:
-          this.accessory.logDebugWarn(`${platformLang.newScene}: [${command}] [${hexString}]`)
+          logUnknownData(this.accessory, {
+            kind: 'scene',
+            source: params.source,
+            raw: command,
+            hex: hexString,
+          })
           break
       }
     })