@switchbot/homebridge-switchbot 4.0.1-beta.5 → 4.1.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "@switchbot/homebridge-switchbot",
   "displayName": "SwitchBot",
   "type": "module",
-  "version": "4.0.1-beta.5",
+  "version": "4.1.0",
   "description": "The SwitchBot plugin allows you to access your SwitchBot device(s) from HomeKit.",
   "author": "SwitchBot <support@wondertechlabs.com> (https://github.com/SwitchBot)",
   "contributors": [
@@ -81,7 +81,7 @@
     "async-mqtt": "^2.6.3",
     "fakegato-history": "^0.6.5",
     "homebridge-lib": "^7.0.9",
-    "node-switchbot": "^3.1.2-beta.5",
+    "node-switchbot": "^3.2.1",
     "rxjs": "^7.8.1"
   },
   "devDependencies": {
@@ -90,7 +90,7 @@
     "@types/debug": "^4.1.12",
     "@types/fs-extra": "^11.0.4",
     "@types/mdast": "^4.0.4",
-    "@types/node": "^22.7.7",
+    "@types/node": "^22.7.8",
     "@types/semver": "^7.5.8",
     "@types/source-map-support": "^0.5.10",
     "@vitest/coverage-v8": "^2.1.3",

package/src/device/meterpro.ts

@@ -0,0 +1,417 @@
+/* Copyright(C) 2021-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
+ *
+ * MeterPro.ts: @switchbot/homebridge-switchbot.
+ */
+import type { CharacteristicValue, PlatformAccessory, Service } from 'homebridge'
+import type { device, meterProServiceData, meterProStatus, meterProWebhookContext } from 'node-switchbot'
+
+import type { SwitchBotPlatform } from '../platform.js'
+import type { devicesConfig, meterConfig } from '../settings.js'
+
+import { Units } from 'homebridge'
+/*
+* For Testing Locally:
+* import { SwitchBotBLEModel, SwitchBotBLEModelName } from '/Users/Shared/GitHub/OpenWonderLabs/node-switchbot/dist/index.js';
+*/
+import { SwitchBotBLEModel, SwitchBotBLEModelName } from 'node-switchbot'
+import { interval, skipWhile, Subject } from 'rxjs'
+
+import { convertUnits, formatDeviceIdAsMac, validHumidity } from '../utils.js'
+import { deviceBase } from './device.js'
+
+/**
+ * Platform Accessory
+ * An instance of this class is created for each accessory your platform registers
+ * Each accessory may expose multiple services of different service types.
+ */
+export class MeterPro extends deviceBase {
+  // Services
+  private Battery: {
+    Name: CharacteristicValue
+    Service: Service
+    BatteryLevel: CharacteristicValue
+    StatusLowBattery: CharacteristicValue
+  }
+
+  private HumiditySensor?: {
+    Name: CharacteristicValue
+    Service: Service
+    CurrentRelativeHumidity: CharacteristicValue
+  }
+
+  private TemperatureSensor?: {
+    Name: CharacteristicValue
+    Service: Service
+    CurrentTemperature: CharacteristicValue
+  }
+
+  // OpenAPI
+  deviceStatus!: meterProStatus
+
+  // Webhook
+  webhookContext!: meterProWebhookContext
+
+  // BLE
+  serviceData!: meterProServiceData
+
+  // Updates
+  meterUpdateInProgress!: boolean
+  doMeterUpdate: Subject<void>
+
+  constructor(
+    readonly platform: SwitchBotPlatform,
+    accessory: PlatformAccessory,
+    device: device & devicesConfig,
+  ) {
+    super(platform, accessory, device)
+    // Set category
+    accessory.category = this.hap.Categories.SENSOR
+
+    // this is subject we use to track when we need to POST changes to the SwitchBot API
+    this.doMeterUpdate = new Subject()
+    this.meterUpdateInProgress = false
+
+    // Initialize Battery Service
+    accessory.context.Battery = accessory.context.Battery ?? {}
+    this.Battery = {
+      Name: `${accessory.displayName} Battery`,
+      Service: accessory.getService(this.hap.Service.Battery) ?? accessory.addService(this.hap.Service.Battery) as Service,
+      BatteryLevel: accessory.context.BatteryLevel ?? 100,
+      StatusLowBattery: accessory.context.StatusLowBattery ?? this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL,
+    }
+    accessory.context.Battery = this.Battery as object
+
+    // Initialize Battery Characteristics
+    this.Battery.Service.setCharacteristic(this.hap.Characteristic.Name, this.Battery.Name).setCharacteristic(this.hap.Characteristic.ChargingState, this.hap.Characteristic.ChargingState.NOT_CHARGEABLE).getCharacteristic(this.hap.Characteristic.BatteryLevel).onGet(() => {
+      return this.Battery.BatteryLevel
+    })
+
+    this.Battery.Service.getCharacteristic(this.hap.Characteristic.StatusLowBattery).onGet(() => {
+      return this.Battery.StatusLowBattery
+    })
+
+    // Initialize Temperature Sensor Service
+    if ((device as meterConfig).hide_temperature) {
+      if (this.TemperatureSensor) {
+        this.debugLog('Removing Temperature Sensor Service')
+        this.TemperatureSensor.Service = this.accessory.getService(this.hap.Service.TemperatureSensor) as Service
+        accessory.removeService(this.TemperatureSensor.Service)
+      }
+    } else {
+      accessory.context.TemperatureSensor = accessory.context.TemperatureSensor ?? {}
+      this.TemperatureSensor = {
+        Name: `${accessory.displayName} Temperature Sensor`,
+        Service: accessory.getService(this.hap.Service.TemperatureSensor) ?? this.accessory.addService(this.hap.Service.TemperatureSensor) as Service,
+        CurrentTemperature: accessory.context.CurrentTemperature ?? 30,
+      }
+      accessory.context.TemperatureSensor = this.TemperatureSensor as object
+
+      // Initialize Temperature Sensor Characteristics
+      this.TemperatureSensor.Service.setCharacteristic(this.hap.Characteristic.Name, this.TemperatureSensor.Name).getCharacteristic(this.hap.Characteristic.CurrentTemperature).setProps({
+        unit: Units.CELSIUS,
+        validValueRanges: [-273.15, 100],
+        minValue: -273.15,
+        maxValue: 100,
+        minStep: 0.1,
+      }).onGet(() => {
+        return this.TemperatureSensor!.CurrentTemperature!
+      })
+    }
+    // Initialize Humidity Sensor Service
+    if ((device as meterConfig).hide_humidity) {
+      if (this.HumiditySensor) {
+        this.debugLog('Removing Humidity Sensor Service')
+        this.HumiditySensor.Service = this.accessory.getService(this.hap.Service.HumiditySensor) as Service
+        accessory.removeService(this.HumiditySensor.Service)
+      }
+    } else {
+      accessory.context.HumiditySensor = accessory.context.HumiditySensor ?? {}
+      this.HumiditySensor = {
+        Name: `${accessory.displayName} Humidity Sensor`,
+        Service: accessory.getService(this.hap.Service.HumiditySensor) ?? this.accessory.addService(this.hap.Service.HumiditySensor) as Service,
+        CurrentRelativeHumidity: accessory.context.CurrentRelativeHumidity ?? 50,
+      }
+      accessory.context.HumiditySensor = this.HumiditySensor as object
+
+      // Initialize Humidity Sensor Characteristics
+      this.HumiditySensor.Service.setCharacteristic(this.hap.Characteristic.Name, this.HumiditySensor.Name).getCharacteristic(this.hap.Characteristic.CurrentRelativeHumidity).setProps({
+        minStep: 0.1,
+      }).onGet(() => {
+        return this.HumiditySensor!.CurrentRelativeHumidity!
+      })
+    }
+
+    // Retrieve initial values and updateHomekit
+    try {
+      this.debugLog('Retrieve initial values and update Homekit')
+      this.refreshStatus()
+    } catch (e: any) {
+      this.errorLog(`failed to retrieve initial values and update Homekit, Error: ${e.message ?? e}`)
+    }
+
+    // regisiter webhook event handler if enabled
+    try {
+      this.debugLog('Registering Webhook Event Handler')
+      this.registerWebhook()
+    } catch (e: any) {
+      this.errorLog(`failed to registerWebhook, Error: ${e.message ?? e}`)
+    }
+
+    // regisiter platform BLE event handler if enabled
+    try {
+      this.debugLog('Registering Platform BLE Event Handler')
+      this.registerPlatformBLE()
+    } catch (e: any) {
+      this.errorLog(`failed to registerPlatformBLE, Error: ${e.message ?? e}`)
+    }
+
+    // Start an update interval
+    interval(this.deviceRefreshRate * 1000)
+      .pipe(skipWhile(() => this.meterUpdateInProgress))
+      .subscribe(async () => {
+        await this.refreshStatus()
+      })
+  }
+
+  async BLEparseStatus(): Promise<void> {
+    await this.debugLog('BLEparseStatus')
+    await this.debugLog(`(temperature, humidity) = BLE:(${this.serviceData.celsius}, ${this.serviceData.humidity}), current:(${this.TemperatureSensor?.CurrentTemperature}, ${this.HumiditySensor?.CurrentRelativeHumidity})`)
+
+    // CurrentRelativeHumidity
+    if (!(this.device as meterConfig).hide_humidity && this.HumiditySensor?.Service) {
+      this.HumiditySensor.CurrentRelativeHumidity = validHumidity(this.serviceData.humidity, 0, 100)
+      await this.debugLog(`CurrentRelativeHumidity: ${this.HumiditySensor.CurrentRelativeHumidity}%`)
+    }
+    // Current Temperature
+    if (!(this.device as meterConfig).hide_temperature && this.TemperatureSensor?.Service) {
+      const CELSIUS = this.serviceData.celsius < 0 ? 0 : this.serviceData.celsius > 100 ? 100 : this.serviceData.celsius
+      this.TemperatureSensor.CurrentTemperature = CELSIUS
+      await this.debugLog(`CurrentTemperature: ${this.TemperatureSensor.CurrentTemperature}°c`)
+    }
+    // BatteryLevel
+    this.Battery.BatteryLevel = this.serviceData.battery
+    await this.debugLog(`BatteryLevel: ${this.Battery.BatteryLevel}`)
+    // StatusLowBattery
+    this.Battery.StatusLowBattery = this.Battery.BatteryLevel < 10
+      ? this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW
+      : this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL
+    await this.debugLog(`StatusLowBattery: ${this.Battery.StatusLowBattery}`)
+  }
+
+  async openAPIparseStatus(): Promise<void> {
+    await this.debugLog('openAPIparseStatus')
+    await this.debugLog(`(temperature, humidity) = OpenAPI:(${this.deviceStatus.temperature}, ${this.deviceStatus.humidity}), current:(${this.TemperatureSensor?.CurrentTemperature}, ${this.HumiditySensor?.CurrentRelativeHumidity})`)
+
+    // CurrentRelativeHumidity
+    if (!(this.device as meterConfig).hide_humidity && this.HumiditySensor?.Service) {
+      this.HumiditySensor.CurrentRelativeHumidity = this.deviceStatus.humidity
+      await this.debugLog(`CurrentRelativeHumidity: ${this.HumiditySensor.CurrentRelativeHumidity}%`)
+    }
+
+    // CurrentTemperature
+    if (!(this.device as meterConfig).hide_temperature && this.TemperatureSensor?.Service) {
+      this.TemperatureSensor.CurrentTemperature = this.deviceStatus.temperature
+      await this.debugLog(`CurrentTemperature: ${this.TemperatureSensor.CurrentTemperature}°c`)
+    }
+
+    // BatteryLevel
+    this.Battery.BatteryLevel = this.deviceStatus.battery
+    await this.debugLog(`BatteryLevel: ${this.Battery.BatteryLevel}`)
+
+    // StatusLowBattery
+    this.Battery.StatusLowBattery = this.Battery.BatteryLevel < 10
+      ? this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW
+      : this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL
+    await this.debugLog(`StatusLowBattery: ${this.Battery.StatusLowBattery}`)
+
+    // FirmwareVersion
+    if (this.deviceStatus.version) {
+      const version = this.deviceStatus.version.toString()
+      this.debugLog(`Firmware Version: ${version.replace(/^V|-.*$/g, '')}`)
+      const deviceVersion = version.replace(/^V|-.*$/g, '') ?? '0.0.0'
+      this.accessory
+        .getService(this.hap.Service.AccessoryInformation)!
+        .setCharacteristic(this.hap.Characteristic.HardwareRevision, deviceVersion)
+        .setCharacteristic(this.hap.Characteristic.FirmwareRevision, deviceVersion)
+        .getCharacteristic(this.hap.Characteristic.FirmwareRevision)
+        .updateValue(deviceVersion)
+      this.accessory.context.version = deviceVersion
+      this.debugSuccessLog(`v: ${this.accessory.context.version}`)
+    }
+  }
+
+  async parseStatusWebhook(): Promise<void> {
+    await this.debugLog('parseStatusWebhook')
+    await this.debugLog(`(scale, temperature, humidity) = Webhook:(${this.webhookContext.scale}, ${convertUnits(this.webhookContext.temperature, this.webhookContext.scale, (this.device as meterConfig).convertUnitTo)}, ${this.webhookContext.humidity}) current:(${this.TemperatureSensor?.CurrentTemperature}, ${this.HumiditySensor?.CurrentRelativeHumidity})`)
+    // Check if the scale is not CELSIUS
+    if (this.webhookContext.scale !== 'CELSIUS' && (this.device as meterConfig).convertUnitTo === undefined) {
+      await this.warnLog(`received a non-CELSIUS Webhook scale: ${this.webhookContext.scale}, Use the *convertUnitsTo* config under Hub settings, if displaying incorrectly in HomeKit.`)
+    }
+
+    // CurrentRelativeHumidity
+    if (!(this.device as meterConfig).hide_humidity && this.HumiditySensor?.Service) {
+      this.HumiditySensor.CurrentRelativeHumidity = this.webhookContext.humidity
+      await this.debugLog(`CurrentRelativeHumidity: ${this.HumiditySensor.CurrentRelativeHumidity}`)
+    }
+
+    // CurrentTemperature
+    if (!(this.device as meterConfig).hide_temperature && this.TemperatureSensor?.Service) {
+      this.TemperatureSensor.CurrentTemperature = convertUnits(this.webhookContext.temperature, this.webhookContext.scale, (this.device as meterConfig).convertUnitTo)
+      await this.debugLog(`CurrentTemperature: ${this.TemperatureSensor.CurrentTemperature}`)
+    }
+  }
+
+  /**
+   * Asks the SwitchBot API for the latest device information
+   */
+  async refreshStatus(): Promise<void> {
+    if (!this.device.enableCloudService && this.OpenAPI) {
+      await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`)
+    } else if (this.BLE) {
+      await this.BLERefreshStatus()
+    } else if (this.OpenAPI && this.platform.config.credentials?.token) {
+      await this.openAPIRefreshStatus()
+    } else {
+      await this.offlineOff()
+      await this.debugWarnLog(`Connection Type: ${this.device.connectionType}, refreshStatus will not happen.`)
+    }
+  }
+
+  async BLERefreshStatus(): Promise<void> {
+    await this.debugLog('BLERefreshStatus')
+    const switchBotBLE = await this.switchbotBLE()
+    if (switchBotBLE === undefined) {
+      await this.BLERefreshConnection(switchBotBLE)
+    } else {
+      // Start to monitor advertisement packets
+      (async () => {
+        // Start to monitor advertisement packets
+        const serviceData = await this.monitorAdvertisementPackets(switchBotBLE) as meterProServiceData
+        // Update HomeKit
+        if (serviceData.model === SwitchBotBLEModel.MeterPro && serviceData.modelName === SwitchBotBLEModelName.MeterPro) {
+          this.serviceData = serviceData
+          await this.BLEparseStatus()
+          await this.updateHomeKitCharacteristics()
+        } else {
+          await this.errorLog(`failed to get serviceData, serviceData: ${JSON.stringify(serviceData)}`)
+          await this.BLERefreshConnection(switchBotBLE)
+        }
+      })()
+    }
+  }
+
+  async registerPlatformBLE(): Promise<void> {
+    await this.debugLog('registerPlatformBLE')
+    if (this.config.options?.BLE) {
+      await this.debugLog('is listening to Platform BLE.')
+      try {
+        const formattedDeviceId = formatDeviceIdAsMac(this.device.deviceId)
+        this.device.bleMac = formattedDeviceId
+        await this.debugLog(`bleMac: ${this.device.bleMac}`)
+        this.platform.bleEventHandler[this.device.bleMac] = async (context: meterProServiceData) => {
+          try {
+            await this.debugLog(`received BLE: ${JSON.stringify(context)}`)
+            this.serviceData = context
+            await this.BLEparseStatus()
+            await this.updateHomeKitCharacteristics()
+          } catch (e: any) {
+            await this.errorLog(`failed to handle BLE. Received: ${JSON.stringify(context)} Error: ${e.message ?? e}`)
+          }
+        }
+      } catch (error) {
+        await this.errorLog(`failed to format device ID as MAC, Error: ${error}`)
+      }
+    } else {
+      await this.debugLog('is not listening to Platform BLE')
+    }
+  }
+
+  async openAPIRefreshStatus(): Promise<void> {
+    await this.debugLog('openAPIRefreshStatus')
+    try {
+      const { body } = await this.deviceRefreshStatus()
+      const deviceStatus: any = await body
+      await this.debugLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`)
+      if (await this.successfulStatusCodes(deviceStatus)) {
+        await this.debugSuccessLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`)
+        this.deviceStatus = deviceStatus.body
+        await this.openAPIparseStatus()
+        await this.updateHomeKitCharacteristics()
+      } else {
+        await this.debugWarnLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`)
+        await this.debugWarnLog(deviceStatus)
+      }
+    } catch (e: any) {
+      await this.apiError(e)
+      await this.errorLog(`failed openAPIRefreshStatus with ${this.device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`)
+    }
+  }
+
+  async registerWebhook() {
+    if (this.device.webhook) {
+      await this.debugLog('is listening webhook.')
+      this.platform.webhookEventHandler[this.device.deviceId] = async (context: meterProWebhookContext) => {
+        try {
+          await this.debugLog(`received Webhook: ${JSON.stringify(context)}`)
+          this.webhookContext = context
+          await this.parseStatusWebhook()
+          await this.updateHomeKitCharacteristics()
+        } catch (e: any) {
+          await this.errorLog(`failed to handle webhook. Received: ${JSON.stringify(context)} Error: ${e.message ?? e}`)
+        }
+      }
+    } else {
+      await this.debugLog('is not listening webhook.')
+    }
+  }
+
+  /**
+   * Updates the status for each of the HomeKit Characteristics
+   */
+  async updateHomeKitCharacteristics(): Promise<void> {
+    // CurrentRelativeHumidity
+    if (!(this.device as meterConfig).hide_humidity && this.HumiditySensor?.Service) {
+      await this.updateCharacteristic(this.HumiditySensor.Service, this.hap.Characteristic.CurrentRelativeHumidity, this.HumiditySensor.CurrentRelativeHumidity, 'CurrentRelativeHumidity')
+    }
+    // CurrentTemperature
+    if (!(this.device as meterConfig).hide_temperature && this.TemperatureSensor?.Service) {
+      await this.updateCharacteristic(this.TemperatureSensor.Service, this.hap.Characteristic.CurrentTemperature, this.TemperatureSensor.CurrentTemperature, 'CurrentTemperature')
+    }
+    // BatteryLevel
+    await this.updateCharacteristic(this.Battery.Service, this.hap.Characteristic.BatteryLevel, this.Battery.BatteryLevel, 'BatteryLevel')
+    // StatusLowBattery
+    await this.updateCharacteristic(this.Battery.Service, this.hap.Characteristic.StatusLowBattery, this.Battery.StatusLowBattery, 'StatusLowBattery')
+  }
+
+  async BLERefreshConnection(switchbot: any): Promise<void> {
+    await this.errorLog(`wasn't able to establish BLE Connection, node-switchbot: ${switchbot}`)
+    if (this.platform.config.credentials?.token && this.device.connectionType === 'BLE/OpenAPI') {
+      await this.warnLog('Using OpenAPI Connection to Refresh Status')
+      await this.openAPIRefreshStatus()
+    }
+  }
+
+  async offlineOff(): Promise<void> {
+    if (this.device.offline) {
+      if (!(this.device as meterConfig).hide_humidity && this.HumiditySensor?.Service) {
+        this.HumiditySensor.Service.updateCharacteristic(this.hap.Characteristic.CurrentRelativeHumidity, 50)
+      }
+      if (!(this.device as meterConfig).hide_temperature && this.TemperatureSensor?.Service) {
+        this.TemperatureSensor.Service.updateCharacteristic(this.hap.Characteristic.CurrentTemperature, 30)
+      }
+      this.Battery.Service.updateCharacteristic(this.hap.Characteristic.BatteryLevel, 100)
+      this.Battery.Service.updateCharacteristic(this.hap.Characteristic.StatusLowBattery, this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL)
+    }
+  }
+
+  async apiError(e: any): Promise<void> {
+    if (!(this.device as meterConfig).hide_humidity && this.HumiditySensor?.Service) {
+      this.HumiditySensor.Service.updateCharacteristic(this.hap.Characteristic.CurrentRelativeHumidity, e)
+    }
+    if (!(this.device as meterConfig).hide_temperature && this.TemperatureSensor?.Service) {
+      this.TemperatureSensor.Service.updateCharacteristic(this.hap.Characteristic.CurrentTemperature, e)
+    }
+    this.Battery.Service.updateCharacteristic(this.hap.Characteristic.BatteryLevel, e)
+    this.Battery.Service.updateCharacteristic(this.hap.Characteristic.StatusLowBattery, e)
+  }
+}

package/src/platform.ts

@@ -39,6 +39,7 @@ import { StripLight } from './device/lightstrip.js'
 import { Lock } from './device/lock.js'
 import { Meter } from './device/meter.js'
 import { MeterPlus } from './device/meterplus.js'
+import { MeterPro } from './device/meterpro.js'
 import { Motion } from './device/motion.js'
 import { Plug } from './device/plug.js'
 import { RobotVacuumCleaner } from './device/robotvacuumcleaner.js'
@@ -630,6 +631,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       'Meter': this.createMeter.bind(this),
       'MeterPlus': this.createMeterPlus.bind(this),
       'Meter Plus (JP)': this.createMeterPlus.bind(this),
+      'Meter Pro': this.createMeterPro.bind(this),
       'WoIOSensor': this.createIOSensor.bind(this),
       'Water Detector': this.createWaterDetector.bind(this),
       'Motion Sensor': this.createMotion.bind(this),
@@ -960,6 +962,69 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
     }
   }
 
+  private async createMeterPro(device: device & devicesConfig) {
+    const uuid = this.api.hap.uuid.generate(`${device.deviceId}-${device.deviceType}`)
+
+    // see if an accessory with the same uuid has already been registered and restored from
+    // the cached devices we stored in the `configureAccessory` method above
+    const existingAccessory = this.accessories.find(accessory => accessory.UUID === uuid)
+
+    if (existingAccessory) {
+      // the accessory already exists
+      if (await this.registerDevice(device)) {
+        // console.log("existingAccessory", existingAccessory);
+        // if you need to update the accessory.context then you should run `api.updatePlatformAccessories`. eg.:
+        existingAccessory.context.device = device
+        existingAccessory.context.model = SwitchBotModel.MeterPro ?? SwitchBotModel.MeterProCO2
+        existingAccessory.context.deviceId = device.deviceId
+        existingAccessory.context.deviceType = device.deviceType
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName)
+        existingAccessory.context.connectionType = await this.connectionType(device)
+        existingAccessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0'
+        this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`)
+        this.api.updatePlatformAccessories([existingAccessory])
+        // create the accessory handler for the restored accessory
+        // this is imported from `platformAccessory.ts`
+        new MeterPro(this, existingAccessory, device)
+        await this.debugLog(`${device.deviceType} uuid: ${device.deviceId}-${device.deviceType}, (${existingAccessory.UUID})`)
+      } else {
+        this.unregisterPlatformAccessories(existingAccessory)
+      }
+    } else if (await this.registerDevice(device)) {
+      // create a new accessory
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid)
+
+      // store a copy of the device object in the `accessory.context`
+      // the `context` property can be used to store any data about the accessory you may need
+      accessory.context.device = device
+      accessory.context.model = SwitchBotModel.MeterPro ?? SwitchBotModel.MeterProCO2
+      accessory.context.deviceId = device.deviceId
+      accessory.context.deviceType = device.deviceType
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName)
+      accessory.context.connectionType = await this.connectionType(device)
+      accessory.context.connectionType = await this.connectionType(device)
+      accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0'
+      const newOrExternal = !device.external ? 'Adding new' : 'Loading external'
+      await this.infoLog(`${newOrExternal} accessory: ${accessory.displayName} deviceId: ${device.deviceId}`)
+      // create the accessory handler for the newly create accessory
+      // this is imported from `platformAccessory.ts`
+      new MeterPro(this, accessory, device)
+      await this.debugLog(`${device.deviceType} uuid: ${device.deviceId}-${device.deviceType}, (${accessory.UUID})`)
+
+      // publish device externally or link the accessory to your platform
+      this.externalOrPlatform(device, accessory)
+      this.accessories.push(accessory)
+    } else {
+      await this.debugLog(`Device not registered: ${device.deviceName} ${device.deviceType} deviceId: ${device.deviceId}`)
+    }
+  }
+
   private async createHub2(device: device & devicesConfig) {
     const uuid = this.api.hap.uuid.generate(`${device.deviceId}-${device.deviceType}`)
 

package/.github/npm-version-script.cjs

@@ -1,81 +0,0 @@
-#!/bin/env node
-
-/**
- * This scripts queries the npm registry to pull out the latest version for a given tag.
- */
-
-const fs = require("fs");
-const semver = require("semver");
-const child_process = require("child_process");
-const assert = require("assert");
-
-const BRANCH_VERSION_PATTERN = /^([A-Za-z]*)-(\d+.\d+.\d+)$/
-
-// Load the contents of the package.json file
-const packageJSON = JSON.parse(fs.readFileSync("package.json", "utf8"));
-
-let refArgument = process.argv[2];
-let tagArgument = process.argv[3] || "latest";
-
-if (refArgument == null) {
-  console.error("ref argument is missing");
-  console.error("Usage: npm-version-script.cjs <ref> [tag]");
-  process.exit(1);
-}
-
-/**
- * Queries the NPM registry for the latest version for the provided tag.
- * @param tag The tag to query for.
- * @returns {string} Returns the version.
- */
-function getTagVersionFromNpm(tag) {
-  try {
-    return child_process.execSync(`npm info ${packageJSON.name} version --tag="${tag}"`).toString("utf8").trim();
-  } catch (e) {
-    throw e;
-  }
-}
-
-function desiredTargetVersion(ref) {
-  // ref is a GitHub action ref string
-  if (ref.startsWith("refs/pull/")) {
-    throw Error("The version script was executed inside a PR!");
-  }
-
-  assert(ref.startsWith("refs/heads/"))
-  let branchName = ref.slice("refs/heads/".length);
-
-  let results = branchName.match(BRANCH_VERSION_PATTERN);
-  if (results != null) {
-    if (results[1] !== tagArgument) {
-      console.warn(`The base branch name (${results[1]}) differs from the tag name ${tagArgument}`);
-    }
-
-    return results[2];
-  }
-
-  // legacy mode were we use the `betaVersion` property in the package.json
-  if (branchName === "beta" && packageJSON.betaVersion) {
-    return packageJSON.betaVersion
-  }
-
-  throw new Error("Malformed branch name for ref: " + ref + ". Can't derive the base version. Use a branch name like: beta-x.x.x!");
-}
-
-// derive the base version from the branch ref
-const baseVersion = desiredTargetVersion(refArgument);
-
-// query the npm registry for the latest version of the provided tag name
-const latestReleasedVersion = getTagVersionFromNpm(tagArgument); // e.g. 0.7.0-beta.12
-const latestReleaseBase = semver.inc(latestReleasedVersion, "patch"); // will produce 0.7.0 (removing the preid, needed for the equality check below)
-
-let publishTag;
-if (semver.eq(baseVersion, latestReleaseBase)) { // check if we are releasing another version for the latest beta
-  publishTag = latestReleasedVersion; // set the current latest beta to be incremented
-} else {
-  publishTag = baseVersion; // start of with a new beta version
-}
-
-// save the package.json
-packageJSON.version = publishTag;
-fs.writeFileSync("package.json", JSON.stringify(packageJSON, null, 2));