@switchbot/homebridge-switchbot 3.5.1-beta.9 → 3.5.1

package/src/device/bot.ts

@@ -88,6 +88,15 @@ export class Bot extends deviceBase {
     On: CharacteristicValue;
   };
 
+  // OpenAPI
+  deviceStatus!: botStatus;
+
+  //Webhook
+  webhookContext!: botWebhookContext;
+
+  // BLE
+  serviceData!: botServiceData;
+
   // Config
   botMode!: string;
   allowPush?: boolean;
@@ -106,6 +115,7 @@ export class Bot extends deviceBase {
     device: device & devicesConfig,
   ) {
     super(platform, accessory, device);
+
     // default placeholders
     this.getBotConfigSettings(device);
 
@@ -131,6 +141,9 @@ export class Bot extends deviceBase {
 
     // deviceType
     if (this.botDeviceType === 'switch') {
+      // Set category
+      accessory.category = this.hap.Categories.SWITCH
+      ;
       // Initialize Switch Service
       accessory.context.Switch = accessory.context.Switch ?? {};
       this.Switch = {
@@ -162,6 +175,9 @@ export class Bot extends deviceBase {
       this.removeWindowCoveringService(accessory);
       this.removeStatefulProgrammableSwitchService(accessory);
     } else if (this.botDeviceType === 'garagedoor') {
+      // Set category
+      accessory.category = this.hap.Categories.GARAGE_DOOR_OPENER;
+
       // Initialize GarageDoor Service
       accessory.context.GarageDoor = accessory.context.GarageDoor ?? {};
       this.GarageDoor = {
@@ -198,6 +214,9 @@ export class Bot extends deviceBase {
       this.removeWindowCoveringService(accessory);
       this.removeStatefulProgrammableSwitchService(accessory);
     } else if (this.botDeviceType === 'door') {
+      // Set category
+      accessory.category = this.hap.Categories.DOOR;
+
       // Initialize Door Service
       accessory.context.Door = accessory.context.Door ?? {};
       this.Door = {
@@ -234,6 +253,9 @@ export class Bot extends deviceBase {
       this.removeWindowCoveringService(accessory);
       this.removeStatefulProgrammableSwitchService(accessory);
     } else if (this.botDeviceType === 'window') {
+      // Set category
+      accessory.category = this.hap.Categories.WINDOW;
+
       // Initialize Window Service
       accessory.context.Window = accessory.context.Window ?? {};
       this.Window = {
@@ -270,6 +292,9 @@ export class Bot extends deviceBase {
       this.removeWindowCoveringService(accessory);
       this.removeStatefulProgrammableSwitchService(accessory);
     } else if (this.botDeviceType === 'windowcovering') {
+      // Set category
+      accessory.category = this.hap.Categories.WINDOW_COVERING;
+
       // Initialize WindowCovering Service
       accessory.context.WindowCovering = accessory.context.WindowCovering ?? {};
       this.WindowCovering = {
@@ -306,6 +331,9 @@ export class Bot extends deviceBase {
       this.removeGarageDoorService(accessory);
       this.removeStatefulProgrammableSwitchService(accessory);
     } else if (this.botDeviceType === 'lock') {
+      // Set category
+      accessory.category = this.hap.Categories.DOOR_LOCK;
+
       // Initialize Lock Service
       accessory.context.LockMechanism = accessory.context.LockMechanism ?? {};
       this.LockMechanism = {
@@ -336,6 +364,9 @@ export class Bot extends deviceBase {
       this.removeWindowCoveringService(accessory);
       this.removeStatefulProgrammableSwitchService(accessory);
     } else if (this.botDeviceType === 'faucet') {
+      // Set category
+      accessory.category = this.hap.Categories.FAUCET;
+
       // Initialize Faucet Service
       accessory.context.Faucet = accessory.context.Faucet ?? {};
       this.Faucet = {
@@ -366,6 +397,9 @@ export class Bot extends deviceBase {
       this.removeWindowCoveringService(accessory);
       this.removeStatefulProgrammableSwitchService(accessory);
     } else if (this.botDeviceType === 'fan') {
+      // Set category
+      accessory.category = this.hap.Categories.FAN;
+
       // Initialize Fan Service
       accessory.context.Fan = accessory.context.Fan ?? {};
       this.Fan = {
@@ -396,6 +430,9 @@ export class Bot extends deviceBase {
       this.removeWindowCoveringService(accessory);
       this.removeStatefulProgrammableSwitchService(accessory);
     } else if (this.botDeviceType === 'stateful') {
+      // Set category
+      accessory.category = this.hap.Categories.PROGRAMMABLE_SWITCH;
+
       // Initialize StatefulProgrammableSwitch Service
       accessory.context.StatefulProgrammableSwitch = accessory.context.StatefulProgrammableSwitch ?? {};
       this.StatefulProgrammableSwitch = {
@@ -427,6 +464,9 @@ export class Bot extends deviceBase {
       this.removeGarageDoorService(accessory);
       this.removeWindowCoveringService(accessory);
     } else {
+      // Set category
+      accessory.category = this.hap.Categories.OUTLET;
+
       // Initialize Switch property
       accessory.context.Outlet = accessory.context.Outlet ?? {};
       this.Outlet = {
@@ -459,12 +499,11 @@ export class Bot extends deviceBase {
     }
 
     // Retrieve initial values and updateHomekit
+    this.debugLog('Retrieve initial values and update Homekit');
     this.refreshStatus();
 
-    // Retrieve initial values and updateHomekit
-    this.updateHomeKitCharacteristics();
-
-    // regisiter webhook event handler
+    //regisiter webhook event handler
+    this.debugLog('Registering Webhook Event Handler');
     this.registerWebhook();
 
     // Start an update interval
@@ -505,23 +544,26 @@ export class Bot extends deviceBase {
   /**
    * Parse the device status from the SwitchBotBLE API
    */
-  async BLEparseStatus(serviceData: botServiceData): Promise<void> {
+  async BLEparseStatus(): Promise<void> {
     await this.debugLog('BLEparseStatus');
+    await this.debugLog(`(power, battery, deviceMode) = BLE:(${this.serviceData.state}, ${this.serviceData.battery}, ${this.serviceData.mode}),`
+      + ` current:(${this.accessory.context.On}, ${this.Battery.BatteryLevel}, ${this.botMode})`);
+
     // BLEmode (true if Switch Mode) | (false if Press Mode)
-    if (serviceData.mode) {
+    if (this.serviceData.mode) {
       this.accessory.context.On = await this.getOn();
       if (this.getOn() === undefined) {
-        this.setOn(Boolean(serviceData.state));
+        this.setOn(Boolean(this.serviceData.state));
       }
-      this.debugLog(`Switch Mode, mode: ${serviceData.mode}, On: ${this.accessory.context.On}`);
+      this.debugLog(`Switch Mode, mode: ${this.serviceData.mode}, On: ${this.accessory.context.On}`);
     } else {
       this.setOn(false);
       this.accessory.context.On = await this.getOn();
-      this.debugLog(`Press Mode, mode: ${serviceData.mode}, On: ${this.accessory.context.On}`);
+      this.debugLog(`Press Mode, mode: ${this.serviceData.mode}, On: ${this.accessory.context.On}`);
     }
 
     // BatteryLevel
-    this.Battery.BatteryLevel = Number(serviceData.battery);
+    this.Battery.BatteryLevel = this.serviceData.battery;
     await this.debugLog(`BatteryLevel: ${this.Battery.BatteryLevel}`);
 
     // StatusLowBattery
@@ -534,8 +576,12 @@ export class Bot extends deviceBase {
   /**
    * Parse the device status from the SwitchBot OpenAPI
    */
-  async openAPIparseStatus(deviceStatus: botStatus): Promise<void> {
+  async openAPIparseStatus(): Promise<void> {
     await this.debugLog('openAPIparseStatus');
+    await this.debugLog(`(power, battery, deviceMode) = API:(${this.deviceStatus.power}, ${this.deviceStatus.battery}, ${this.botMode}),`
+      + ` current:(${this.accessory.context.On}, ${this.Battery.BatteryLevel}, ${this.botMode})`);
+
+    // On
     if (this.botMode === 'press') {
       this.setOn(false);
       this.accessory.context.On = await this.getOn();
@@ -548,7 +594,7 @@ export class Bot extends deviceBase {
     await this.debugLog(`On: ${this.accessory.context.On}`);
 
     // Battery Level
-    this.Battery.BatteryLevel = Number(deviceStatus.battery);
+    this.Battery.BatteryLevel = this.deviceStatus.battery;
     await this.debugLog(`BatteryLevel: ${this.Battery.BatteryLevel}`);
 
     // StatusLowBattery
@@ -557,9 +603,9 @@ export class Bot extends deviceBase {
     await this.debugLog(`StatusLowBattery: ${this.Battery.StatusLowBattery}`);
 
     // Firmware Version
-    const version = deviceStatus.version.toString();
-    this.debugLog(`Firmware Version: ${version.replace(/^V|-.*$/g, '')}`);
-    if (deviceStatus.version) {
+    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)!
@@ -567,29 +613,33 @@ export class Bot extends deviceBase {
         .setCharacteristic(this.hap.Characteristic.FirmwareRevision, deviceVersion)
         .getCharacteristic(this.hap.Characteristic.FirmwareRevision)
         .updateValue(deviceVersion);
-      this.accessory.context.deviceVersion = deviceVersion;
-      await this.debugLog(`deviceVersion: ${this.accessory.context.deviceVersion}`);
+      this.accessory.context.version = deviceVersion;
+      await this.debugLog(`version: ${this.accessory.context.version}`);
     }
   }
 
-  async parseStatusWebhook(context: botWebhookContext): Promise<void> {
+  async parseStatusWebhook(): Promise<void> {
     await this.debugLog('parseStatusWebhook');
     const getOn = await this.getOn();
-    await this.debugLog(`(power, battery, deviceMode) = Webhook:(${context.power}, ${context.battery}, ${context.deviceMode}),`
-      + ` current:(${getOn}, ${this.Battery.BatteryLevel}, ${this.botMode})`);
+    await this.debugLog(`(power, battery, deviceMode) = Webhook:(${this.webhookContext.power}, ${this.webhookContext.battery},`
+      + ` ${this.webhookContext.deviceMode}), current:(${getOn}, ${this.Battery.BatteryLevel}, ${this.botMode})`);
+
     // On
-    const setOn = context.power === 'on' ? true : false;
+    const setOn = this.webhookContext.power === 'on' ? true : false;
     await this.setOn(setOn);
     await this.debugLog(`On: ${setOn}`);
+
     // BatteryLevel
-    this.Battery.BatteryLevel = context.battery;
+    this.Battery.BatteryLevel = this.webhookContext.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}`);
+
     // Mode
-    this.botMode = context.deviceMode;
+    this.botMode = this.webhookContext.deviceMode;
     await this.debugLog(`Mode: ${this.botMode}`);
   }
 
@@ -622,7 +672,8 @@ export class Bot extends deviceBase {
         const serviceData = await this.monitorAdvertisementPackets(switchbot) as botServiceData;
         // Update HomeKit
         if (serviceData.model === SwitchBotBLEModel.Bot && serviceData.modelName === SwitchBotBLEModelName.Bot) {
-          await this.BLEparseStatus(serviceData);
+          this.serviceData = serviceData;
+          await this.BLEparseStatus();
           await this.updateHomeKitCharacteristics();
         } else {
           await this.errorLog(`failed to get serviceData, serviceData: ${serviceData}`);
@@ -640,7 +691,8 @@ export class Bot extends deviceBase {
       await this.debugLog(`statusCode: ${statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`);;
       if (await this.successfulStatusCodes(statusCode, deviceStatus)) {
         await this.debugSuccessLog(`statusCode: ${statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`);
-        await this.openAPIparseStatus(deviceStatus.body);
+        this.deviceStatus = deviceStatus.body;
+        await this.openAPIparseStatus();
         await this.updateHomeKitCharacteristics();
       } else {
         await this.debugWarnLog(`statusCode: ${statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`);
@@ -658,7 +710,8 @@ export class Bot extends deviceBase {
       this.platform.webhookEventHandler[this.device.deviceId] = async (context: botWebhookContext) => {
         try {
           await this.debugLog(`received Webhook: ${JSON.stringify(context)}`);
-          await this.parseStatusWebhook(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}`);

package/src/device/ceilinglight.ts

@@ -32,6 +32,15 @@ export class CeilingLight extends deviceBase {
     ColorTemperature?: CharacteristicValue;
   };
 
+  // OpenAPI
+  deviceStatus!: ceilingLightStatus | ceilingLightProStatus;
+
+  //Webhook
+  webhookContext!: ceilingLightWebhookContext | ceilingLightProWebhookContext;
+
+  // BLE
+  serviceData!: ceilingLightServiceData | ceilingLightProServiceData;
+
   // Adaptive Lighting
   AdaptiveLightingController?: ControllerConstructor | Controller<ControllerServiceMap>;
   adaptiveLightingShift?: number;
@@ -46,6 +55,9 @@ export class CeilingLight extends deviceBase {
     device: device & devicesConfig,
   ) {
     super(platform, accessory, device);
+    // Set category
+    accessory.category = this.hap.Categories.LIGHTBULB;
+
     // default placeholders
     this.adaptiveLighting(device);
 
@@ -147,10 +159,12 @@ export class CeilingLight extends deviceBase {
       .onSet(this.SaturationSet.bind(this));
 
     // Retrieve initial values and updateHomekit
+    this.debugLog('Retrieve initial values and update Homekit');
     this.refreshStatus();
 
-    // Update Homekit
-    this.updateHomeKitCharacteristics();
+    //regisiter webhook event handler
+    this.debugLog('Registering Webhook Event Handler');
+    this.registerWebhook();
 
     //regisiter webhook event handler
     this.registerWebhook();
@@ -185,41 +199,46 @@ export class CeilingLight extends deviceBase {
   /**
    * Parse the device status from the SwitchBotBLE API
    */
-  async BLEparseStatus(serviceData: ceilingLightServiceData | ceilingLightProServiceData): Promise<void> {
+  async BLEparseStatus(): Promise<void> {
     await this.debugLog('BLEparseStatus');
+    await this.debugLog(`(power, brightness, colorTemperature) = BLE:(${this.serviceData.state}, ${this.serviceData.brightness}, `
+      + `${this.serviceData.color_temperature}), current:(${this.LightBulb.On}, ${this.LightBulb.Brightness}, ${this.LightBulb.ColorTemperature})`);
+
     // On
-    this.LightBulb.On = serviceData.state;
+    this.LightBulb.On = this.serviceData.state;
     await this.debugLog(`On: ${this.LightBulb.On}`);
+
+    // ColorTemperature
+    const miredColorTemperature = Math.round(1000000 / this.serviceData.color_temperature);
+    this.LightBulb.ColorTemperature = Math.max(Math.min(miredColorTemperature, 500), 140);
+    await this.debugLog(`ColorTemperature: ${this.LightBulb.ColorTemperature}`);
   }
 
   /**
    * Parse the device status from the SwitchBot OpenAPI
    */
-  async openAPIparseStatus(deviceStatus: ceilingLightStatus | ceilingLightProStatus): Promise<void> {
+  async openAPIparseStatus(): Promise<void> {
     await this.debugLog('openAPIparseStatus');
+    await this.debugLog(`(power, brightness, colorTemperature) = OpenAPI:(${this.deviceStatus.power}, ${this.deviceStatus.brightness}, `
+      + `${this.deviceStatus.colorTemperature}), current:(${this.LightBulb.On}, ${this.LightBulb.Brightness}, ${this.LightBulb.ColorTemperature})`);
+
     // On
-    this.LightBulb.On = deviceStatus.power;
+    this.LightBulb.On = this.deviceStatus.power;
     await this.debugLog(`On: ${this.LightBulb.On}`);
 
     // Brightness
-    this.LightBulb.Brightness = deviceStatus.brightness;
+    this.LightBulb.Brightness = this.deviceStatus.brightness;
     await this.debugLog(`Brightness: ${this.LightBulb.Brightness}`);
 
     // ColorTemperature
-    if (!Number.isNaN(deviceStatus.colorTemperature)) {
-      await this.debugLog(`OpenAPI ColorTemperature: ${deviceStatus.colorTemperature}`);
-      const mired = Math.round(1000000 / deviceStatus.colorTemperature);
-
-      this.LightBulb.ColorTemperature = Number(mired);
-
-      this.LightBulb.ColorTemperature = Math.max(Math.min(this.LightBulb.ColorTemperature, 500), 140);
-      await this.debugLog(`ColorTemperature: ${this.LightBulb.ColorTemperature}`);
-    }
+    const miredColorTemperature = Math.round(1000000 / this.deviceStatus.colorTemperature);
+    this.LightBulb.ColorTemperature = Math.max(Math.min(miredColorTemperature, 500), 140);
+    await this.debugLog(`ColorTemperature: ${this.LightBulb.ColorTemperature}`);
 
     // Firmware Version
-    const version = deviceStatus.version.toString();
-    await this.debugLog(`Firmware Version: ${version.replace(/^V|-.*$/g, '')}`);
-    if (deviceStatus.version) {
+    if (this.deviceStatus.version) {
+      const version = this.deviceStatus.version.toString();
+      await this.debugLog(`Firmware Version: ${version.replace(/^V|-.*$/g, '')}`);
       const deviceVersion = version.replace(/^V|-.*$/g, '') ?? '0.0.0';
       this.accessory
         .getService(this.hap.Service.AccessoryInformation)!
@@ -227,23 +246,27 @@ export class CeilingLight extends deviceBase {
         .setCharacteristic(this.hap.Characteristic.FirmwareRevision, deviceVersion)
         .getCharacteristic(this.hap.Characteristic.FirmwareRevision)
         .updateValue(deviceVersion);
-      this.accessory.context.deviceVersion = deviceVersion;
-      await this.debugSuccessLog(`deviceVersion: ${this.accessory.context.deviceVersion}`);
+      this.accessory.context.version = deviceVersion;
+      await this.debugSuccessLog(`version: ${this.accessory.context.version}`);
     }
   }
 
-  async parseStatusWebhook(context: ceilingLightWebhookContext | ceilingLightProWebhookContext): Promise<void> {
+  async parseStatusWebhook(): Promise<void> {
     await this.debugLog('parseStatusWebhook');
-    await this.debugLog(`(powerState, brightness, colorTemperature) = Webhook:(${context.powerState}, ${context.brightness},`
-      + ` ${context.colorTemperature}), current:(${this.LightBulb.On}, ${this.LightBulb.Brightness}, ${this.LightBulb.ColorTemperature})`);
+    await this.debugLog(`(powerState, brightness, colorTemperature) = Webhook:(${this.webhookContext.powerState}, ${this.webhookContext.brightness}, `
+      + `${this.webhookContext.colorTemperature}), current:(${this.LightBulb.On}, ${this.LightBulb.Brightness}, ${this.LightBulb.ColorTemperature})`);
+
     // On
-    this.LightBulb.On = context.powerState === 'ON' ? true : false;
+    this.LightBulb.On = this.webhookContext.powerState === 'ON' ? true : false;
     await this.debugLog(`On: ${this.LightBulb.On}`);
+
     // Brightness
-    this.LightBulb.Brightness = context.brightness;
+    this.LightBulb.Brightness = this.webhookContext.brightness;
     await this.debugLog(`Brightness: ${this.LightBulb.Brightness}`);
+
     // ColorTemperature
-    this.LightBulb.ColorTemperature = context.colorTemperature;
+    const miredColorTemperature = Math.round(1000000 / this.webhookContext.colorTemperature);
+    this.LightBulb.ColorTemperature = Math.max(Math.min(miredColorTemperature, 500), 140);
     await this.debugLog(`ColorTemperature: ${this.LightBulb.ColorTemperature}`);
   }
 
@@ -276,7 +299,8 @@ export class CeilingLight extends deviceBase {
         // Update HomeKit
         if ((serviceData.model === SwitchBotBLEModel.CeilingLight || SwitchBotBLEModel.CeilingLightPro)
           && serviceData.modelName === SwitchBotBLEModelName.CeilingLight || SwitchBotBLEModelName.CeilingLightPro) {
-          await this.BLEparseStatus(serviceData);
+          this.serviceData = serviceData;
+          await this.BLEparseStatus();
           await this.updateHomeKitCharacteristics();
         } else {
           await this.errorLog(`failed to get serviceData, serviceData: ${serviceData}`);
@@ -294,7 +318,8 @@ export class CeilingLight extends deviceBase {
       await this.debugLog(`statusCode: ${statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`);;
       if (await this.successfulStatusCodes(statusCode, deviceStatus)) {
         await this.debugSuccessLog(`statusCode: ${statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`);
-        await this.openAPIparseStatus(deviceStatus.body);
+        this.deviceStatus = deviceStatus.body;
+        await this.openAPIparseStatus();
         await this.updateHomeKitCharacteristics();
       } else {
         await this.debugWarnLog(`statusCode: ${statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`);
@@ -312,7 +337,8 @@ export class CeilingLight extends deviceBase {
       this.platform.webhookEventHandler[this.device.deviceId] = async (context: ceilingLightWebhookContext | ceilingLightProWebhookContext) => {
         try {
           await this.debugLog(`received Webhook: ${JSON.stringify(context)}`);
-          await this.parseStatusWebhook(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}`);
@@ -476,7 +502,7 @@ export class CeilingLight extends deviceBase {
   async pushColorTemperatureChanges(): Promise<void> {
     await this.debugLog('pushColorTemperatureChanges');
     if (this.LightBulb.ColorTemperature !== this.accessory.context.ColorTemperature) {
-      const kelvin = Math.round(1000000 / Number(this.LightBulb.ColorTemperature));
+      const kelvin = Math.round(1000000 * Number(this.LightBulb.ColorTemperature));
       this.accessory.context.kelvin = kelvin;
       const bodyChange = JSON.stringify({
         command: 'setColorTemperature',