@switchbot/homebridge-switchbot 3.5.0-beta.58 → 3.5.0-beta.59

package/src/device/ceilinglight.ts

@@ -21,6 +21,7 @@ import type { Service, PlatformAccessory, CharacteristicValue, ControllerConstru
 export class CeilingLight extends deviceBase {
   // Services
   private LightBulb: {
+    Name: CharacteristicValue;
     Service: Service;
     On: CharacteristicValue;
     Hue: CharacteristicValue;
@@ -52,35 +53,44 @@ export class CeilingLight extends deviceBase {
 
     // Initialize LightBulb property
     this.LightBulb = {
-      Service: accessory.getService(this.hap.Service.Lightbulb) as Service,
-      On: accessory.context.On || false,
-      Hue: accessory.context.Hue || 0,
-      Saturation: accessory.context.Saturation || 0,
-      Brightness: accessory.context.Brightness || 0,
-      ColorTemperature: accessory.context.ColorTemperature || 140,
+      Name: accessory.context.LightBulb.Name ?? accessory.displayName,
+      Service: accessory.getService(this.hap.Service.Lightbulb) ?? accessory.addService(this.hap.Service.Lightbulb) as Service,
+      On: accessory.context.On ?? false,
+      Hue: accessory.context.Hue ?? 0,
+      Saturation: accessory.context.Saturation ?? 0,
+      Brightness: accessory.context.Brightness ?? 0,
+      ColorTemperature: accessory.context.ColorTemperature ?? 140,
     };
 
-    // Retrieve initial values and updateHomekit
-    this.refreshStatus();
-
-    const LightBulbService = `${accessory.displayName} ${device.deviceType}`;
-    (this.LightBulb!.Service = accessory.getService(this.hap.Service.Lightbulb)
-      || accessory.addService(this.hap.Service.Lightbulb)), LightBulbService;
-
-
-    if (this.adaptiveLightingShift === -1 && this.accessory.context.adaptiveLighting) {
-      this.accessory.removeService(this.LightBulb!.Service);
-      this.LightBulb!.Service = this.accessory.addService(this.hap.Service.Lightbulb);
-      this.accessory.context.adaptiveLighting = false;
-      this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} adaptiveLighting: ${this.accessory.context.adaptiveLighting}`);
+    // Adaptive Lighting
+    if (this.adaptiveLightingShift === -1 && accessory.context.adaptiveLighting) {
+      accessory.removeService(this.LightBulb.Service);
+      this.LightBulb.Service = accessory.addService(this.hap.Service.Lightbulb);
+      accessory.context.adaptiveLighting = false;
+      this.debugLog(`${device.deviceType}: ${accessory.displayName} adaptiveLighting: ${accessory.context.adaptiveLighting}`);
     }
+    if (this.adaptiveLightingShift !== -1) {
+      this.AdaptiveLightingController = new platform.api.hap.AdaptiveLightingController(this.LightBulb.Service, {
+        customTemperatureAdjustment: this.adaptiveLightingShift,
+      });
+      this.accessory.configureController(this.AdaptiveLightingController);
+      this.accessory.context.adaptiveLighting = true;
+      this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} adaptiveLighting: ${this.accessory.context.adaptiveLighting},`
+      + ` adaptiveLightingShift: ${this.adaptiveLightingShift}`);
+    }
+    this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} adaptiveLightingShift: ${this.adaptiveLightingShift}`);
 
-    this.LightBulb!.Service.setCharacteristic(this.hap.Characteristic.Name, accessory.displayName);
-    // handle on / off events using the On characteristic
-    this.LightBulb!.Service.getCharacteristic(this.hap.Characteristic.On).onSet(this.OnSet.bind(this));
+    // Initialize LightBulb Characteristics
+    this.LightBulb.Service
+      .setCharacteristic(this.hap.Characteristic.Name, this.LightBulb.Name)
+      .getCharacteristic(this.hap.Characteristic.On)
+      .onGet(() => {
+        return this.LightBulb.On;
+      })
+      .onSet(this.OnSet.bind(this));
 
-    // handle Brightness events using the Brightness characteristic
-    this.LightBulb!.Service
+    // Initialize LightBulb Brightness
+    this.LightBulb.Service
       .getCharacteristic(this.hap.Characteristic.Brightness)
       .setProps({
         minStep: this.minStep(device),
@@ -93,8 +103,8 @@ export class CeilingLight extends deviceBase {
       })
       .onSet(this.BrightnessSet.bind(this));
 
-    // handle ColorTemperature events using the ColorTemperature characteristic
-    this.LightBulb!.Service
+    // Initialize LightBulb ColorTemperature
+    this.LightBulb.Service
       .getCharacteristic(this.hap.Characteristic.ColorTemperature)
       .setProps({
         minValue: 140,
@@ -106,8 +116,8 @@ export class CeilingLight extends deviceBase {
       })
       .onSet(this.ColorTemperatureSet.bind(this));
 
-    // handle Hue events using the Hue characteristic
-    this.LightBulb!.Service
+    // Initialize LightBulb Hue
+    this.LightBulb.Service
       .getCharacteristic(this.hap.Characteristic.Hue)
       .setProps({
         minValue: 0,
@@ -119,8 +129,8 @@ export class CeilingLight extends deviceBase {
       })
       .onSet(this.HueSet.bind(this));
 
-    // handle Hue events using the Hue characteristic
-    this.LightBulb!.Service
+    // Initialize LightBulb Saturation
+    this.LightBulb.Service
       .getCharacteristic(this.hap.Characteristic.Saturation)
       .setProps({
         minValue: 0,
@@ -131,19 +141,10 @@ export class CeilingLight extends deviceBase {
         return this.LightBulb.Saturation;
       })
       .onSet(this.SaturationSet.bind(this));
+    accessory.context.LightBulb.Name = this.LightBulb.Name;
 
-    this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} adaptiveLightingShift: ${this.adaptiveLightingShift}`);
-    if (this.adaptiveLightingShift !== -1) {
-      this.AdaptiveLightingController = new platform.api.hap.AdaptiveLightingController(this.LightBulb!.Service, {
-        customTemperatureAdjustment: this.adaptiveLightingShift,
-      });
-      this.accessory.configureController(this.AdaptiveLightingController);
-      this.accessory.context.adaptiveLighting = true;
-      this.debugLog(
-        `${this.device.deviceType}: ${this.accessory.displayName} adaptiveLighting: ${this.accessory.context.adaptiveLighting},` +
-        ` adaptiveLightingShift: ${this.adaptiveLightingShift}`,
-      );
-    }
+    // Retrieve initial values and updateHomekit
+    this.refreshStatus();
 
     // Update Homekit
     this.updateHomeKitCharacteristics();

package/src/device/colorbulb.ts

@@ -21,6 +21,7 @@ import type { Service, PlatformAccessory, CharacteristicValue, ControllerConstru
 export class ColorBulb extends deviceBase {
   // Services
   private LightBulb: {
+    Name: CharacteristicValue;
     Service: Service;
     On: CharacteristicValue;
     Hue: CharacteristicValue;
@@ -53,36 +54,42 @@ export class ColorBulb extends deviceBase {
 
     // Initialize LightBulb property
     this.LightBulb = {
-      Service: accessory.getService(this.hap.Service.Lightbulb) as Service,
-      On: accessory.context.On || false,
-      Hue: accessory.context.Hue || 0,
-      Saturation: accessory.context.Saturation || 0,
-      Brightness: accessory.context.Brightness || 0,
-      ColorTemperature: accessory.context.ColorTemperature || 140,
+      Name: accessory.context.LightBulb.Name ?? accessory.displayName,
+      Service: accessory.getService(this.hap.Service.Lightbulb) ?? accessory.addService(this.hap.Service.Lightbulb) as Service,
+      On: accessory.context.On ?? false,
+      Hue: accessory.context.Hue ?? 0,
+      Saturation: accessory.context.Saturation ?? 0,
+      Brightness: accessory.context.Brightness ?? 0,
+      ColorTemperature: accessory.context.ColorTemperature ?? 140,
     };
 
-    // Retrieve initial values and updateHomekit
-    this.refreshStatus();
-
-    // get the Lightbulb service if it exists, otherwise create a new Lightbulb service
-    // you can create multiple services for each accessory
-    const lightBulbService = `${accessory.displayName} ${device.deviceType}`;
-    (this.LightBulb.Service = accessory.getService(this.hap.Service.Lightbulb)
-      || accessory.addService(this.hap.Service.Lightbulb)), lightBulbService;
-
-    if (this.adaptiveLightingShift === -1 && this.accessory.context.adaptiveLighting) {
-      this.accessory.removeService(this.LightBulb.Service);
-      this.LightBulb.Service = this.accessory.addService(this.hap.Service.Lightbulb);
-      this.accessory.context.adaptiveLighting = false;
-      this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} adaptiveLighting: ${this.accessory.context.adaptiveLighting}`);
+    // Adaptive Lighting
+    if (this.adaptiveLightingShift === -1 && accessory.context.adaptiveLighting) {
+      accessory.removeService(this.LightBulb.Service);
+      this.LightBulb.Service = accessory.addService(this.hap.Service.Lightbulb);
+      accessory.context.adaptiveLighting = false;
+      this.debugLog(`${device.deviceType}: ${accessory.displayName} adaptiveLighting: ${accessory.context.adaptiveLighting}`);
     }
+    if (this.adaptiveLightingShift !== -1) {
+      this.AdaptiveLightingController = new platform.api.hap.AdaptiveLightingController(this.LightBulb.Service, {
+        customTemperatureAdjustment: this.adaptiveLightingShift,
+      });
+      accessory.configureController(this.AdaptiveLightingController);
+      accessory.context.adaptiveLighting = true;
+      this.debugLog(`${device.deviceType}: ${this.accessory.displayName} adaptiveLighting: ${accessory.context.adaptiveLighting},`
+      + ` adaptiveLightingShift: ${this.adaptiveLightingShift}`);
+    }
+    this.debugLog(`${device.deviceType}: ${this.accessory.displayName} adaptiveLightingShift: ${this.adaptiveLightingShift}`);
 
-    this.LightBulb.Service.setCharacteristic(this.hap.Characteristic.Name, accessory.displayName);
-
-    // handle on / off events using the On characteristic
-    this.LightBulb.Service.getCharacteristic(this.hap.Characteristic.On).onSet(this.OnSet.bind(this));
+    // Initialize LightBulb Characteristics
+    this.LightBulb.Service
+      .setCharacteristic(this.hap.Characteristic.Name, this.LightBulb.Name)
+      .getCharacteristic(this.hap.Characteristic.On)
+      .onGet(() => {
+        return this.LightBulb.On;
+      })
+      .onSet(this.OnSet.bind(this));
 
-    // handle Brightness events using the Brightness characteristic
     this.LightBulb.Service
       .getCharacteristic(this.hap.Characteristic.Brightness)
       .setProps({
@@ -96,7 +103,6 @@ export class ColorBulb extends deviceBase {
       })
       .onSet(this.BrightnessSet.bind(this));
 
-    // handle ColorTemperature events using the ColorTemperature characteristic
     this.LightBulb.Service
       .getCharacteristic(this.hap.Characteristic.ColorTemperature)
       .setProps({
@@ -109,7 +115,6 @@ export class ColorBulb extends deviceBase {
       })
       .onSet(this.ColorTemperatureSet.bind(this));
 
-    // handle Hue events using the Hue characteristic
     this.LightBulb.Service
       .getCharacteristic(this.hap.Characteristic.Hue)
       .setProps({
@@ -122,7 +127,6 @@ export class ColorBulb extends deviceBase {
       })
       .onSet(this.HueSet.bind(this));
 
-    // handle Hue events using the Hue characteristic
     this.LightBulb.Service
       .getCharacteristic(this.hap.Characteristic.Saturation)
       .setProps({
@@ -134,19 +138,10 @@ export class ColorBulb extends deviceBase {
         return this.LightBulb.Saturation;
       })
       .onSet(this.SaturationSet.bind(this));
+    accessory.context.LightBulb.Name = this.LightBulb.Name;
 
-    this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} adaptiveLightingShift: ${this.adaptiveLightingShift}`);
-    if (this.adaptiveLightingShift !== -1) {
-      this.AdaptiveLightingController = new platform.api.hap.AdaptiveLightingController(this.LightBulb.Service, {
-        customTemperatureAdjustment: this.adaptiveLightingShift,
-      });
-      this.accessory.configureController(this.AdaptiveLightingController);
-      this.accessory.context.adaptiveLighting = true;
-      this.debugLog(
-        `${this.device.deviceType}: ${this.accessory.displayName} adaptiveLighting: ${this.accessory.context.adaptiveLighting},` +
-        ` adaptiveLightingShift: ${this.adaptiveLightingShift}`,
-      );
-    }
+    // Retrieve initial values and updateHomekit
+    this.refreshStatus();
 
     // Update Homekit
     this.updateHomeKitCharacteristics();

package/src/device/contact.ts

@@ -9,7 +9,7 @@ import { skipWhile } from 'rxjs/operators';
 
 import type { SwitchBotPlatform } from '../platform.js';
 import type { Service, PlatformAccessory, CharacteristicValue } from 'homebridge';
-import type { device, devicesConfig, serviceData, deviceStatus} from '../settings.js';
+import type { device, devicesConfig, serviceData, deviceStatus } from '../settings.js';
 
 /**
  * Platform Accessory
@@ -19,22 +19,26 @@ import type { device, devicesConfig, serviceData, deviceStatus} from '../setting
 export class Contact extends deviceBase {
   // Services
   private ContactSensor: {
+    Name: CharacteristicValue;
     Service: Service;
     ContactSensorState: CharacteristicValue;
   };
 
   private Battery: {
+    Name: CharacteristicValue;
     Service: Service;
     BatteryLevel: CharacteristicValue;
     StatusLowBattery: CharacteristicValue;
   };
 
   private MotionSensor?: {
+    Name: CharacteristicValue;
     Service: Service;
     MotionDetected: CharacteristicValue;
   };
 
   private LightSensor?: {
+    Name: CharacteristicValue;
     Service: Service;
     CurrentAmbientLightLevel: CharacteristicValue;
   };
@@ -55,84 +59,94 @@ export class Contact extends deviceBase {
 
     // Initialize Contact Sensor property
     this.ContactSensor = {
-      Service: accessory.getService(this.hap.Service.ContactSensor) as Service,
-      ContactSensorState: this.hap.Characteristic.ContactSensorState.CONTACT_DETECTED,
+      Name: accessory.context.ContactSensor.Name ?? accessory.displayName,
+      Service: accessory.getService(this.hap.Service.ContactSensor) ?? accessory.addService(this.hap.Service.ContactSensor) as Service,
+      ContactSensorState: accessory.context.ContactSensorState ?? this.hap.Characteristic.ContactSensorState.CONTACT_DETECTED,
     };
 
+    // Initialize ContactSensor Characteristics
+    this.ContactSensor.Service
+      .setCharacteristic(this.hap.Characteristic.Name, this.ContactSensor.Name)
+      .setCharacteristic(this.hap.Characteristic.StatusActive, true)
+      .getCharacteristic(this.hap.Characteristic.ContactSensorState)
+      .onGet(() => {
+        return this.ContactSensor.ContactSensorState;
+      });
+    accessory.context.ContactSensor.Name = this.ContactSensor.Name;
+
     // Initialize Battery property
     this.Battery = {
-      Service: accessory.getService(this.hap.Service.Battery) as Service,
-      BatteryLevel: 100,
-      StatusLowBattery: this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL,
+      Name: accessory.context.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,
     };
 
-    // Initialize Motion Sensor property
-    if (!this.device.contact?.hide_motionsensor) {
-      this.MotionSensor = {
-        Service: accessory.getService(this.hap.Service.MotionSensor) as Service,
-        MotionDetected: false,
-      };
-    }
-
-    // Initialize Light Sensor property
-    if (!this.device.contact?.hide_lightsensor) {
-      this.LightSensor = {
-        Service: accessory.getService(this.hap.Service.LightSensor) as Service,
-        CurrentAmbientLightLevel: 0,
-      };
-    }
-
-    // Retrieve initial values and updateHomekit
-    this.refreshStatus();
-
-    // get the Contact service if it exists, otherwise create a new Contact service
-    // you can create multiple services for each accessory
-    const ContactSensorService = `${accessory.displayName} Contact Sensor`;
-    (this.ContactSensor.Service = accessory.getService(this.hap.Service.ContactSensor)
-      || accessory.addService(this.hap.Service.ContactSensor)), ContactSensorService;
+    // 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.ContactSensor.Service.setCharacteristic(this.hap.Characteristic.Name, accessory.displayName);
+    this.Battery.Service
+      .setCharacteristic(this.hap.Characteristic.StatusLowBattery, this.Battery.StatusLowBattery)
+      .getCharacteristic(this.hap.Characteristic.StatusLowBattery)
+      .onGet(() => {
+        return this.Battery.StatusLowBattery;
+      });
+    accessory.context.Battery.Name = this.Battery.Name;
 
-    // Motion Sensor Service
-    if (device.contact?.hide_motionsensor) {
+    // Initialize Motion Sensor Service
+    if (this.device.contact?.hide_motionsensor) {
       this.debugLog(`${device.deviceType}: ${accessory.displayName} Removing Motion Sensor Service`);
       this.MotionSensor!.Service = accessory.getService(this.hap.Service.MotionSensor) as Service;
       accessory.removeService(this.MotionSensor!.Service);
-    } else if (!this.MotionSensor?.Service && !device.contact?.hide_motionsensor) {
-      this.debugLog(`${device.deviceType}: ${accessory.displayName} Add Motion Sensor Service`);
-      const MotionService = `${accessory.displayName} Motion Sensor`;
-      (this.MotionSensor!.Service = accessory.getService(this.hap.Service.MotionSensor)
-        || accessory.addService(this.hap.Service.MotionSensor)), MotionService;
-
-      this.MotionSensor!.Service.setCharacteristic(this.hap.Characteristic.Name, MotionService);
     } else {
-      this.debugLog(`${device.deviceType}: ${accessory.displayName} Motion Sensor Service Not Added`);
+      this.MotionSensor = {
+        Name: accessory.context.MotionSensor.Name ?? `${accessory.displayName} Motion Sensor`,
+        Service: accessory.getService(this.hap.Service.MotionSensor) ?? accessory.addService(this.hap.Service.MotionSensor) as Service,
+        MotionDetected: accessory.context.MotionDetected ?? false,
+      };
+
+      // Motion Sensor Characteristics
+      this.MotionSensor.Service
+        .setCharacteristic(this.hap.Characteristic.Name, this.MotionSensor.Name)
+        .setCharacteristic(this.hap.Characteristic.StatusActive, true)
+        .getCharacteristic(this.hap.Characteristic.MotionDetected)
+        .onGet(() => {
+          return this.MotionSensor!.MotionDetected;
+        });
+      accessory.context.MotionSensor.Name = this.MotionSensor.Name;
     }
 
-    // Light Sensor Service
+    // Initialize Light Sensor Service
     if (device.contact?.hide_lightsensor) {
       this.debugLog(`${this.device.deviceType}: ${accessory.displayName} Removing Light Sensor Service`);
       this.LightSensor!.Service = accessory.getService(this.hap.Service.LightSensor) as Service;
       accessory.removeService(this.LightSensor!.Service);
-    } else if (!this.LightSensor?.Service && !device.contact?.hide_lightsensor) {
-      this.debugLog(`${this.device.deviceType}: ${accessory.displayName} Add Light Sensor Service`);
-
-      const LightSensorService = `${accessory.displayName} Light Sensor`;
-      (this.LightSensor!.Service = this.accessory.getService(this.hap.Service.LightSensor)
-        || this.accessory.addService(this.hap.Service.LightSensor)), LightSensorService;
-
-      this.LightSensor!.Service.setCharacteristic(this.hap.Characteristic.Name, LightSensorService);
     } else {
-      this.debugLog(`${this.device.deviceType}: ${accessory.displayName} Light Sensor Service Not Added`);
-    }
+      this.LightSensor = {
+        Name: accessory.context.LightSensor.Name ?? `${accessory.displayName} Light Sensor`,
+        Service: accessory.getService(this.hap.Service.LightSensor) ?? accessory.addService(this.hap.Service.LightSensor) as Service,
+        CurrentAmbientLightLevel: accessory.context.CurrentAmbientLightLevel ?? 0.0001,
+      };
 
-    // Battery Service
-    const BatteryService = `${accessory.displayName} Battery`;
-    (this.Battery.Service = this.accessory.getService(this.hap.Service.Battery)
-      || accessory.addService(this.hap.Service.Battery)), BatteryService;
+      // Light Sensor Characteristics
+      this.LightSensor.Service
+        .setCharacteristic(this.hap.Characteristic.Name, this.LightSensor.Name)
+        .setCharacteristic(this.hap.Characteristic.StatusActive, true)
+        .getCharacteristic(this.hap.Characteristic.CurrentAmbientLightLevel)
+        .onGet(() => {
+          return this.LightSensor!.CurrentAmbientLightLevel;
+        });
+      accessory.context.LightSensor.Name = this.LightSensor.Name;
+    }
 
-    this.Battery.Service.setCharacteristic(this.hap.Characteristic.Name, BatteryService);
-    this.Battery.Service.setCharacteristic(this.hap.Characteristic.ChargingState, this.hap.Characteristic.ChargingState.NOT_CHARGEABLE);
+    // Retrieve initial values and updateHomekit
+    this.refreshStatus();
 
     // Retrieve initial values and updateHomekit
     this.updateHomeKitCharacteristics();
@@ -152,8 +166,8 @@ export class Contact extends deviceBase {
           this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} received Webhook: ${JSON.stringify(context)}`);
           const { detectionState, brightness, openState } = context;
           const { ContactSensorState } = this.ContactSensor;
-          const { CurrentAmbientLightLevel } = this.LightSensor || {};
-          const { MotionDetected } = this.MotionSensor || {};
+          const { CurrentAmbientLightLevel } = this.LightSensor ?? {};
+          const { MotionDetected } = this.MotionSensor ?? {};
           this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} ` +
             '(detectionState, brightness, openState) = ' +
             `Webhook:(${detectionState}, ${brightness}, ${openState}), ` +
@@ -482,11 +496,14 @@ export class Contact extends deviceBase {
 
   async apiError(e: any): Promise<void> {
     this.ContactSensor.Service.updateCharacteristic(this.hap.Characteristic.ContactSensorState, e);
+    this.ContactSensor.Service.updateCharacteristic(this.hap.Characteristic.StatusActive, e);
     if (!this.device.contact?.hide_motionsensor) {
       this.MotionSensor!.Service.updateCharacteristic(this.hap.Characteristic.MotionDetected, e);
+      this.MotionSensor!.Service.updateCharacteristic(this.hap.Characteristic.StatusActive, e);
     }
     if (!this.device.contact?.hide_lightsensor) {
       this.LightSensor!.Service.updateCharacteristic(this.hap.Characteristic.CurrentAmbientLightLevel, e);
+      this.LightSensor!.Service.updateCharacteristic(this.hap.Characteristic.StatusActive, e);
     }
     this.Battery.Service.updateCharacteristic(this.hap.Characteristic.BatteryLevel, e);
     this.Battery.Service.updateCharacteristic(this.hap.Characteristic.StatusLowBattery, e);