@switchbot/homebridge-switchbot 4.1.6-beta.1 → 4.1.6-beta.11

package/src/device/colorbulb.ts

@@ -82,25 +82,6 @@ export class ColorBulb extends deviceBase {
     }
     accessory.context.LightBulb = this.LightBulb as object
 
-    if (this.adaptiveLighting && this.adaptiveLightingShift === -1 && this.LightBulb) {
-      accessory.removeService(this.LightBulb.Service)
-      this.LightBulb.Service = accessory.addService(this.hap.Service.Lightbulb)
-      accessory.context.adaptiveLighting = false
-      this.debugLog(`adaptiveLighting: ${this.adaptiveLighting}`)
-    } else if (this.adaptiveLighting && this.adaptiveLightingShift >= 0 && this.LightBulb) {
-      this.AdaptiveLightingController = new platform.api.hap.AdaptiveLightingController(this.LightBulb.Service, {
-        controllerMode: this.hap.AdaptiveLightingControllerMode.AUTOMATIC,
-        customTemperatureAdjustment: this.adaptiveLightingShift,
-      })
-      accessory.configureController(this.AdaptiveLightingController)
-      accessory.context.adaptiveLighting = true
-      this.debugLog(`adaptiveLighting: ${this.adaptiveLighting}, adaptiveLightingShift: ${this.adaptiveLightingShift}`,
-      )
-    } else {
-      accessory.context.adaptiveLighting = false
-      this.debugLog(`adaptiveLighting: ${accessory.context.adaptiveLighting}`)
-    }
-
     // Initialize LightBulb Characteristics
     this.LightBulb.Service.setCharacteristic(this.hap.Characteristic.Name, this.LightBulb.Name).getCharacteristic(this.hap.Characteristic.On).onGet(() => {
       return this.LightBulb.On
@@ -139,6 +120,25 @@ export class ColorBulb extends deviceBase {
       return this.LightBulb.Saturation
     }).onSet(this.SaturationSet.bind(this))
 
+    if (this.adaptiveLighting && this.adaptiveLightingShift === -1 && this.LightBulb) {
+      accessory.removeService(this.LightBulb.Service)
+      this.LightBulb.Service = accessory.addService(this.hap.Service.Lightbulb)
+      accessory.context.adaptiveLighting = false
+      this.debugLog(`adaptiveLighting: ${this.adaptiveLighting}`)
+    } else if (this.adaptiveLighting && this.adaptiveLightingShift >= 0 && this.LightBulb) {
+      this.AdaptiveLightingController = new platform.api.hap.AdaptiveLightingController(this.LightBulb.Service, {
+        controllerMode: this.hap.AdaptiveLightingControllerMode.AUTOMATIC,
+        customTemperatureAdjustment: this.adaptiveLightingShift,
+      })
+      accessory.configureController(this.AdaptiveLightingController)
+      accessory.context.adaptiveLighting = true
+      this.debugLog(`adaptiveLighting: ${this.adaptiveLighting}, adaptiveLightingShift: ${this.adaptiveLightingShift}`,
+      )
+    } else {
+      accessory.context.adaptiveLighting = false
+      this.debugLog(`adaptiveLighting: ${accessory.context.adaptiveLighting}`)
+    }
+
     // Retrieve initial values and updateHomekit
     try {
       this.debugLog('Retrieve initial values and update Homekit')

package/src/device/curtain.ts

@@ -844,7 +844,6 @@ export class Curtain extends deviceBase {
       this.hasLoggedStandby = false
       this.infoLog('Checking Status ...')
       this.curtainMoving = true
-      await this.setMinMax()
       if (this.WindowCovering.TargetPosition > this.WindowCovering.CurrentPosition) {
         this.debugLog(`Closing, CurrentPosition: ${this.WindowCovering.CurrentPosition}`)
         this.WindowCovering.PositionState = this.hap.Characteristic.PositionState.INCREASING
@@ -877,13 +876,13 @@ export class Curtain extends deviceBase {
 
   async setMinMax(): Promise<void> {
     if ((this.device as curtainConfig).set_min) {
-      if (Number(this.WindowCovering.CurrentPosition) <= (this.device as curtainConfig).set_min!) {
-        this.WindowCovering.CurrentPosition = 0
+      if (Number(this.WindowCovering.CurrentPosition) >= (this.device as curtainConfig).set_min!) {
+        this.WindowCovering.CurrentPosition = 100
       }
     }
     if ((this.device as curtainConfig).set_max) {
-      if (Number(this.WindowCovering.CurrentPosition) >= (this.device as curtainConfig).set_max!) {
-        this.WindowCovering.CurrentPosition = 100
+      if (Number(this.WindowCovering.CurrentPosition) <= (this.device as curtainConfig).set_max!) {
+        this.WindowCovering.CurrentPosition = 0
       }
     }
     if (this.device.history) {

package/src/device/device.ts

@@ -14,7 +14,7 @@ import { hostname } from 'node:os'
 
 import { SwitchBotBLEModel, SwitchBotBLEModelFriendlyName, SwitchBotBLEModelName, SwitchBotModel } from 'node-switchbot'
 
-import { formatDeviceIdAsMac, sleep } from '../utils.js'
+import { formatDeviceIdAsMac, safeStringify, sleep } from '../utils.js'
 
 export abstract class deviceBase {
   public readonly api: API
@@ -169,6 +169,7 @@ export abstract class deviceBase {
         deviceSpecificConfig = device as indoorOutdoorSensorConfig
         break
       case 'Humidifier':
+      case 'Humidifier2':
         deviceSpecificConfig = device as humidifierConfig
         break
       case 'Curtain':
@@ -315,6 +316,7 @@ export abstract class deviceBase {
     // Set an event handler
     let serviceData = { model: this.device.bleModel, modelName: this.device.bleModelName } as ad['serviceData']
     switchbot.onadvertisement = (ad: ad) => {
+      this.debugLog(`ad: ${safeStringify(ad)}`)
       if (this.device.bleMac === ad.address && ad.serviceData.model === this.device.bleModel) {
         this.debugLog(`${JSON.stringify(ad, null, '  ')}`)
         this.debugLog(`address: ${ad.address}, model: ${ad.serviceData.model}`)
@@ -413,6 +415,12 @@ export abstract class deviceBase {
         bleModelName: SwitchBotBLEModelName.Humidifier,
         bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Humidifier,
       },
+      'Humidifier2': {
+        model: SwitchBotModel.Humidifier2,
+        bleModel: SwitchBotBLEModel.Humidifier2,
+        bleModelName: SwitchBotBLEModelName.Humidifier2,
+        bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Humidifier2,
+      },
       'Hub Mini': {
         model: SwitchBotModel.HubMini,
         bleModel: SwitchBotBLEModel.Unknown,

package/src/device/fan.ts

@@ -460,14 +460,13 @@ export class Fan extends deviceBase {
           switchBotBLE
             .discover({ model: this.device.bleModel, id: this.device.bleMac })
             .then(async (device_list: SwitchbotDevice[]) => {
-              const deviceList = device_list as SwitchbotDevice[]
               return await this.retryBLE({
                 max: this.maxRetryBLE(),
                 fn: async () => {
                   if (this.Fan.Active) {
-                    return await deviceList[0].turnOn()
+                    return await (device_list[0] as any).turnOn()
                   } else {
-                    return await deviceList[0].turnOff()
+                    return await (device_list[0] as any).turnOff()
                   }
                 },
               })

package/src/device/humidifier.ts

@@ -3,7 +3,7 @@
  * humidifier.ts: @switchbot/homebridge-switchbot.
  */
 import type { CharacteristicValue, PlatformAccessory, Service } from 'homebridge'
-import type { bodyChange, device, humidifierServiceData, humidifierStatus, humidifierWebhookContext, SwitchbotDevice, WoHumi } from 'node-switchbot'
+import type { bodyChange, device, humidifier2ServiceData, humidifier2Status, humidifier2WebhookContext, humidifierServiceData, humidifierStatus, humidifierWebhookContext, SwitchbotDevice, WoHumi } from 'node-switchbot'
 
 import type { SwitchBotPlatform } from '../platform.js'
 import type { devicesConfig, humidifierConfig } from '../settings.js'
@@ -43,13 +43,13 @@ export class Humidifier extends deviceBase {
   }
 
   // OpenAPI
-  deviceStatus!: humidifierStatus
+  deviceStatus!: humidifierStatus | humidifier2Status
 
   // Webhook
-  webhookContext!: humidifierWebhookContext
+  webhookContext!: humidifierWebhookContext | humidifier2WebhookContext
 
   // BLE
-  serviceData!: humidifierServiceData
+  serviceData!: humidifierServiceData | humidifier2ServiceData
 
   // Updates
   humidifierUpdateInProgress!: boolean
@@ -324,7 +324,7 @@ export class Humidifier extends deviceBase {
       // Start to monitor advertisement packets
       (async () => {
         // Start to monitor advertisement packets
-        const serviceData = await this.monitorAdvertisementPackets(switchBotBLE) as humidifierServiceData
+        const serviceData = await this.monitorAdvertisementPackets(switchBotBLE) as humidifierServiceData | humidifier2ServiceData
         // Update HomeKit
         if (serviceData.model === SwitchBotBLEModel.Humidifier && serviceData.modelName === SwitchBotBLEModelName.Humidifier) {
           this.serviceData = serviceData
@@ -346,7 +346,7 @@ export class Humidifier extends deviceBase {
         const formattedDeviceId = formatDeviceIdAsMac(this.device.deviceId)
         this.device.bleMac = formattedDeviceId
         this.debugLog(`bleMac: ${this.device.bleMac}`)
-        this.platform.bleEventHandler[this.device.bleMac] = async (context: humidifierServiceData) => {
+        this.platform.bleEventHandler[this.device.bleMac] = async (context: humidifierServiceData | humidifier2ServiceData) => {
           try {
             this.debugLog(`received BLE: ${JSON.stringify(context)}`)
             this.serviceData = context
@@ -388,7 +388,7 @@ export class Humidifier extends deviceBase {
   async registerWebhook() {
     if (this.device.webhook) {
       this.debugLog('is listening webhook.')
-      this.platform.webhookEventHandler[this.device.deviceId] = async (context: humidifierWebhookContext) => {
+      this.platform.webhookEventHandler[this.device.deviceId] = async (context: humidifierWebhookContext | humidifier2WebhookContext) => {
         try {
           this.debugLog(`received Webhook: ${JSON.stringify(context)}`)
           this.webhookContext = context
@@ -438,8 +438,7 @@ export class Humidifier extends deviceBase {
           switchBotBLE
             .discover({ model: this.device.bleModel, quick: true, id: this.device.bleMac })
             .then(async (device_list: SwitchbotDevice[]) => {
-              const deviceList = device_list as WoHumi[]
-              return await deviceList[0].percentage(this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold)
+              return await (device_list[0] as WoHumi).percentage(Number(this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold))
             })
             .then(async () => {
               this.successLog(`RelativeHumidityHumidifierThreshold: ${this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold} sent over BLE, sent successfully`)

package/src/device/lightstrip.ts

@@ -512,7 +512,7 @@ export class StripLight extends deviceBase {
             .discover({ model: this.device.bleModel, id: this.device.bleMac })
             .then(async (device_list: SwitchbotDevice[]) => {
               this.infoLog(`Brightness: ${this.LightBulb.Brightness}`)
-              return await device_list[0].setBrightness(this.LightBulb.Brightness)
+              return await (device_list[0] as WoStrip).setBrightness(Number(this.LightBulb.Brightness))
             })
             .then(async () => {
               this.successLog(`Brightness: ${this.LightBulb.Brightness} sent over SwitchBot BLE, sent successfully`)
@@ -551,7 +551,7 @@ export class StripLight extends deviceBase {
             .discover({ model: this.device.bleModel, id: this.device.bleMac })
             .then(async (device_list: SwitchbotDevice[]) => {
               this.infoLog(`RGB: ${(this.LightBulb.Brightness, red, green, blue)}`)
-              return await device_list[0].setRGB(this.LightBulb.Brightness, red, green, blue)
+              return await (device_list[0] as WoStrip).setRGB(Number(this.LightBulb.Brightness), red, green, blue)
             })
             .then(async () => {
               this.successLog(`RGB: ${(this.LightBulb.Brightness, red, green, blue)} sent over SwitchBot BLE, sent successfully`)

package/src/device/lock.ts

@@ -3,7 +3,7 @@
  * lock.ts: @switchbot/homebridge-switchbot.
  */
 import type { CharacteristicValue, PlatformAccessory, Service } from 'homebridge'
-import type { bodyChange, device, lockProServiceData, lockProStatus, lockProWebhookContext, lockServiceData, lockStatus, lockWebhookContext, SwitchbotDevice } from 'node-switchbot'
+import type { bodyChange, device, lockProServiceData, lockProStatus, lockProWebhookContext, lockServiceData, lockStatus, lockWebhookContext, SwitchbotDevice, WoSmartLock } from 'node-switchbot'
 
 import type { SwitchBotPlatform } from '../platform.js'
 import type { devicesConfig, lockConfig } from '../settings.js'
@@ -451,9 +451,9 @@ export class Lock extends deviceBase {
                 max: this.maxRetryBLE(),
                 fn: async () => {
                   if (this.LockMechanism.LockTargetState === this.hap.Characteristic.LockTargetState.SECURED) {
-                    return await device_list[0].lock({ id: this.device.bleMac })
+                    return await (device_list[0] as WoSmartLock).lock()
                   } else {
-                    return await device_list[0].unlock({ id: this.device.bleMac })
+                    return await (device_list[0] as WoSmartLock).unlock()
                   }
                 },
               })

package/src/device/robotvacuumcleaner.ts

@@ -392,15 +392,14 @@ export class RobotVacuumCleaner extends deviceBase {
           switchBotBLE
             .discover({ model: this.device.bleModel, id: this.device.bleMac })
             .then(async (device_list: SwitchbotDevice[]) => {
-              const deviceList = device_list as SwitchbotDevice[]
               this.infoLog(`On: ${this.LightBulb.On}`)
               return await this.retryBLE({
                 max: this.maxRetryBLE(),
                 fn: async () => {
                   if (this.LightBulb.On) {
-                    return await deviceList[0].turnOn()
+                    return await (device_list[0] as any).turnOn()
                   } else {
-                    return await deviceList[0].turnOff()
+                    return await (device_list[0] as any).turnOff()
                   }
                 },
               })

package/src/platform.ts

@@ -6,22 +6,22 @@ import type { Server } from 'node:http'
 
 import type { API, DynamicPlatformPlugin, Logging, PlatformAccessory } from 'homebridge'
 import type { MqttClient } from 'mqtt'
+/*
+* For Testing Locally:
+* import type { blindTilt, curtain, curtain3, device, irdevice } from '/Users/Shared/GitHub/OpenWonderLabs/node-switchbot/dist/index.js';
+* import { LogLevel, SwitchBotBLE, SwitchBotModel, SwitchBotOpenAPI } from '/Users/Shared/GitHub/OpenWonderLabs/node-switchbot/dist/index.js';
+*/
+import type { blindTilt, curtain, curtain3, device, deviceStatus, deviceStatusRequest, irdevice } from 'node-switchbot'
 
 import type { blindTiltConfig, curtainConfig, devicesConfig, irDevicesConfig, options, SwitchBotPlatformConfig } from './settings.js'
 
 import { readFileSync } from 'node:fs'
+import { hostname } from 'node:os'
 import process, { argv } from 'node:process'
 
 import asyncmqtt from 'async-mqtt'
 import fakegato from 'fakegato-history'
 import { EveHomeKitTypes } from 'homebridge-lib/EveHomeKitTypes'
-/*
-* For Testing Locally:
-* import type { blindTilt, curtain, curtain3, device, irdevice } from '/Users/Shared/GitHub/OpenWonderLabs/node-switchbot/dist/index.js';
-* import { LogLevel, SwitchBotBLE, SwitchBotModel, SwitchBotOpenAPI } from '/Users/Shared/GitHub/OpenWonderLabs/node-switchbot/dist/index.js';
-*/
-import type { blindTilt, curtain, curtain3, device, deviceStatus, deviceStatusRequest, irdevice } from 'node-switchbot'
-
 import { LogLevel, SwitchBotBLE, SwitchBotModel, SwitchBotOpenAPI } from 'node-switchbot'
 import { queueScheduler } from 'rxjs'
 
@@ -54,7 +54,7 @@ import { TV } from './irdevice/tv.js'
 import { VacuumCleaner } from './irdevice/vacuumcleaner.js'
 import { WaterHeater } from './irdevice/waterheater.js'
 import { PLATFORM_NAME, PLUGIN_NAME } from './settings.js'
-import { formatDeviceIdAsMac, isBlindTiltDevice, isCurtainDevice, sleep } from './utils.js'
+import { formatDeviceIdAsMac, isBlindTiltDevice, isCurtainDevice, safeStringify, sleep } from './utils.js'
 
 /**
  * HomebridgePlatform
@@ -139,7 +139,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
 
     // SwitchBot OpenAPI
     if (this.config.credentials?.token && this.config.credentials?.secret) {
-      this.switchBotAPI = new SwitchBotOpenAPI(this.config.credentials.token, this.config.credentials.secret)
+      this.switchBotAPI = new SwitchBotOpenAPI(this.config.credentials.token, this.config.credentials.secret, this.config.options?.hostname)
     } else {
       this.debugErrorLog('Missing SwitchBot API credentials (token or secret).')
     }
@@ -583,6 +583,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
   private async createDevice(device: device & devicesConfig) {
     const deviceTypeHandlers: { [key: string]: (device: device & devicesConfig) => Promise<void> } = {
       'Humidifier': this.createHumidifier.bind(this),
+      'Humidifier2': this.createHumidifier.bind(this),
       'Hub 2': this.createHub2.bind(this),
       'Bot': this.createBot.bind(this),
       'Meter': this.createMeter.bind(this),
@@ -685,7 +686,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.device = device
         existingAccessory.context.deviceId = device.deviceId
         existingAccessory.context.deviceType = device.deviceType
-        existingAccessory.context.model = SwitchBotModel.Humidifier
+        existingAccessory.context.model = device.deviceType === 'Humidifier2' ? SwitchBotModel.Humidifier2 : SwitchBotModel.Humidifier
         existingAccessory.displayName = device.configDeviceName
           ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
           : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName)
@@ -711,7 +712,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.device = device
       accessory.context.deviceId = device.deviceId
       accessory.context.deviceType = device.deviceType
-      accessory.context.model = SwitchBotModel.Humidifier
+      accessory.context.model = device.deviceType === 'Humidifier2' ? SwitchBotModel.Humidifier2 : SwitchBotModel.Humidifier
       accessory.displayName = device.configDeviceName
         ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
         : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName)
@@ -2630,7 +2631,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
   async connectBLE(accessory: PlatformAccessory, device: device & devicesConfig): Promise<any> {
     try {
       queueScheduler.schedule(async () => this.switchBotBLE)
-      this.debugLog(`${device.deviceType}: ${accessory.displayName} 'node-switchbot' found: ${this.switchBotBLE}`)
+      this.debugLog(`${device.deviceType}: ${accessory.displayName} 'node-switchbot' found: ${safeStringify(this.switchBotBLE)}`)
       return this.switchBotBLE
     } catch (e: any) {
       this.errorLog(`${device.deviceType}: ${accessory.displayName} 'node-switchbot' not found, Error: ${e.message ?? e}`)

package/src/settings.ts

@@ -43,6 +43,7 @@ export interface options {
   discoverBLE?: boolean
   disableLogsforBLE?: boolean
   disableLogsforOpenAPI?: boolean
+  hostname?: string
   webhookURL?: string
   maxRetries?: number
   delayBetweenRetries?: number
@@ -118,7 +119,7 @@ export interface indoorOutdoorSensorConfig extends BaseDeviceConfig {
 };
 
 export interface humidifierConfig extends BaseDeviceConfig {
-  configDeviceType: 'Humidifier'
+  configDeviceType: 'Humidifier' | 'Humidifier2'
   hide_temperature?: boolean
   convertUnitTo?: string
   set_minStep?: number

package/src/utils.ts

@@ -54,6 +54,25 @@ export function convertUnits(value: number, unit: string, convert?: string): num
   return value
 }
 
+/**
+ * Safely serializes an object to a JSON string, handling circular references.
+ *
+ * @param obj - The object to be serialized.
+ * @returns The JSON string representation of the object.
+ */
+export function safeStringify(obj: any) {
+  const seen = new WeakSet()
+  return JSON.stringify(obj, (_key, value) => {
+    if (typeof value === 'object' && value !== null) {
+      if (seen.has(value)) {
+        return
+      }
+      seen.add(value)
+    }
+    return value
+  }, '  ')
+}
+
 /**
  * Formats a device ID as a MAC address.
  * Ensures the device ID does not already contain colons.