@switchbot/homebridge-switchbot 3.6.1-beta.0 → 3.6.1-beta.10

package/src/device/ceilinglight.ts

@@ -42,8 +42,9 @@ export class CeilingLight extends deviceBase {
   serviceData!: ceilingLightServiceData | ceilingLightProServiceData;
 
   // Adaptive Lighting
+  adaptiveLighting!: boolean;
+  adaptiveLightingShift!: number;
   AdaptiveLightingController?: ControllerConstructor | Controller<ControllerServiceMap>;
-  adaptiveLightingShift?: number;
 
   // Updates
   ceilingLightUpdateInProgress!: boolean;
@@ -59,7 +60,7 @@ export class CeilingLight extends deviceBase {
     accessory.category = this.hap.Categories.LIGHTBULB;
 
     // default placeholders
-    this.adaptiveLighting(device);
+    this.getAdaptiveLightingSettings(accessory, device);
 
     // this is subject we use to track when we need to POST changes to the SwitchBot API
     this.doCeilingLightUpdate = new Subject();
@@ -78,23 +79,24 @@ export class CeilingLight extends deviceBase {
     };
     accessory.context.LightBulb = this.LightBulb as object;
 
-    // Adaptive Lighting
-    if (this.adaptiveLightingShift === -1 && accessory.context.adaptiveLighting) {
+    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: ${accessory.context.adaptiveLighting}`);
-    }
-    if (this.adaptiveLightingShift !== -1) {
+      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,
       });
-      this.accessory.configureController(this.AdaptiveLightingController);
-      this.accessory.context.adaptiveLighting = true;
-      this.debugLog(`adaptiveLighting: ${this.accessory.context.adaptiveLighting},`
-        + ` adaptiveLightingShift: ${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}`);
     }
-    this.debugLog(`adaptiveLightingShift: ${this.adaptiveLightingShift}`);
 
     // Initialize LightBulb Characteristics
     this.LightBulb.Service
@@ -166,9 +168,6 @@ export class CeilingLight extends deviceBase {
     this.debugLog('Registering Webhook Event Handler');
     this.registerWebhook();
 
-    //regisiter webhook event handler
-    this.registerWebhook();
-
     // Start an update interval
     interval(this.deviceRefreshRate * 1000)
       .pipe(skipWhile(() => this.ceilingLightUpdateInProgress))
@@ -276,7 +275,7 @@ export class CeilingLight extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();
@@ -288,25 +287,41 @@ export class CeilingLight extends deviceBase {
 
   async BLERefreshStatus(): Promise<void> {
     await this.debugLog('BLERefreshStatus');
-    const switchbot = await this.switchbotBLE();
-
-    if (switchbot === undefined) {
-      await this.BLERefreshConnection(switchbot);
-    } else {
-      (async () => {
-      // Start to monitor advertisement packets
-        const serviceData = await this.monitorAdvertisementPackets(switchbot) as unknown as ceilingLightServiceData;
-        // Update HomeKit
-        if ((serviceData.model === SwitchBotBLEModel.CeilingLight || SwitchBotBLEModel.CeilingLightPro)
-          && serviceData.modelName === SwitchBotBLEModelName.CeilingLight || SwitchBotBLEModelName.CeilingLightPro) {
-          this.serviceData = serviceData;
+    if (this.config.options?.BLE) {
+      await this.debugLog('is listening to Platform BLE.');
+      this.device.bleMac = this.device.deviceId!.match(/.{1,2}/g)!.join(':').toLowerCase();
+      await this.debugLog(`bleMac: ${this.device.bleMac}`);
+      this.platform.bleEventHandler[this.device.bleMac] = async (context: ceilingLightServiceData) => {
+        try {
+          await this.debugLog(`received BLE: ${JSON.stringify(context)}`);
+          this.serviceData = context;
           await this.BLEparseStatus();
           await this.updateHomeKitCharacteristics();
-        } else {
-          await this.errorLog(`failed to get serviceData, serviceData: ${serviceData}`);
-          await this.BLERefreshConnection(switchbot);
+        } catch (e: any) {
+          await this.errorLog(`failed to handle BLE. Received: ${JSON.stringify(context)} Error: ${e}`);
         }
-      })();
+      };
+    } else {
+      await this.debugLog('is using Device BLE Scanning.');
+      const switchbot = await this.switchbotBLE();
+      if (switchbot === undefined) {
+        await this.BLERefreshConnection(switchbot);
+      } else {
+        (async () => {
+          // Start to monitor advertisement packets
+          const serviceData = await this.monitorAdvertisementPackets(switchbot) as unknown as ceilingLightServiceData;
+          // Update HomeKit
+          if ((serviceData.model === SwitchBotBLEModel.CeilingLight || SwitchBotBLEModel.CeilingLightPro)
+          && serviceData.modelName === SwitchBotBLEModelName.CeilingLight || SwitchBotBLEModelName.CeilingLightPro) {
+            this.serviceData = serviceData;
+            await this.BLEparseStatus();
+            await this.updateHomeKitCharacteristics();
+          } else {
+            await this.errorLog(`failed to get serviceData, serviceData: ${serviceData}`);
+            await this.BLERefreshConnection(switchbot);
+          }
+        })();
+      }
     }
   }
 
@@ -687,13 +702,18 @@ export class CeilingLight extends deviceBase {
       this.LightBulb.Saturation, 'Saturation');
   }
 
-  async adaptiveLighting(device: device & devicesConfig): Promise<void> {
+  async getAdaptiveLightingSettings(accessory: PlatformAccessory, device: device & devicesConfig): Promise<void> {
+    // Adaptive Lighting
+    this.adaptiveLighting = accessory.context.adaptiveLighting ?? true;
+    await this.debugLog(`adaptiveLighting: ${this.adaptiveLighting}`);
+    // Adaptive Lighting Shift
     if (device.ceilinglight?.adaptiveLightingShift) {
       this.adaptiveLightingShift = device.ceilinglight.adaptiveLightingShift;
+      this.debugLog(`adaptiveLightingShift: ${this.adaptiveLightingShift}`);
     } else {
       this.adaptiveLightingShift = 0;
+      this.debugLog(`adaptiveLightingShift: ${this.adaptiveLightingShift}`);
     }
-    await this.debugLog(`adaptiveLightingShift: ${this.adaptiveLightingShift}`);
   }
 
   async BLEPushConnection() {

package/src/device/colorbulb.ts

@@ -42,8 +42,9 @@ export class ColorBulb extends deviceBase {
   serviceData!: colorBulbServiceData;
 
   // Adaptive Lighting
+  adaptiveLighting!: boolean;
+  adaptiveLightingShift!: number;
   AdaptiveLightingController?: ControllerConstructor | Controller<ControllerServiceMap>;
-  adaptiveLightingShift?: number;
 
   // Updates
   colorBulbUpdateInProgress!: boolean;
@@ -59,7 +60,7 @@ export class ColorBulb extends deviceBase {
     accessory.category = this.hap.Categories.LIGHTBULB;
 
     // default placeholders
-    this.adaptiveLighting(device);
+    this.getAdaptiveLightingSettings(accessory, device);
 
     // this is subject we use to track when we need to POST changes to the SwitchBot API
     this.doColorBulbUpdate = new Subject();
@@ -67,6 +68,10 @@ export class ColorBulb extends deviceBase {
 
     // Initialize LightBulb property
     accessory.context.LightBulb = accessory.context.LightBulb ?? {};
+    if (accessory.context.LightBulb.Name) {
+      accessory.context.LightBulb.Name = this.validateAndCleanString(accessory.context.LightBulb.Name,
+        'LightBulb Name', accessory.context.LightBulb.Name);
+    }
     this.LightBulb = {
       Name: accessory.context.LightBulb.Name ?? accessory.displayName,
       Service: accessory.getService(this.hap.Service.Lightbulb) ?? accessory.addService(this.hap.Service.Lightbulb) as Service,
@@ -78,23 +83,24 @@ export class ColorBulb extends deviceBase {
     };
     accessory.context.LightBulb = this.LightBulb as object;
 
-    // Adaptive Lighting
-    if (this.adaptiveLightingShift === -1 && accessory.context.adaptiveLighting) {
+    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: ${accessory.context.adaptiveLighting}`);
-    }
-    if (this.adaptiveLightingShift !== -1) {
+      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: ${accessory.context.adaptiveLighting},`
-        + ` adaptiveLightingShift: ${this.adaptiveLightingShift}`);
+      this.debugLog(`adaptiveLighting: ${this.adaptiveLighting}, adaptiveLightingShift: ${this.adaptiveLightingShift}`,
+      );
+    } else {
+      accessory.context.adaptiveLighting = false;
+      this.debugLog(`adaptiveLighting: ${accessory.context.adaptiveLighting}`);
     }
-    this.debugLog(`adaptiveLightingShift: ${this.adaptiveLightingShift}`);
 
     // Initialize LightBulb Characteristics
     this.LightBulb.Service
@@ -162,9 +168,6 @@ export class ColorBulb extends deviceBase {
     this.debugLog('Registering Webhook Event Handler');
     this.registerWebhook();
 
-    //regisiter webhook event handler
-    this.registerWebhook();
-
     // Start an update interval
     interval(this.deviceRefreshRate * 1000)
       .pipe(skipWhile(() => this.colorBulbUpdateInProgress))
@@ -297,7 +300,7 @@ export class ColorBulb extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();
@@ -309,25 +312,41 @@ export class ColorBulb extends deviceBase {
 
   async BLERefreshStatus(): Promise<void> {
     await this.debugLog('BLERefreshStatus');
-    const switchbot = await this.switchbotBLE();
-
-    if (switchbot === undefined) {
-      await this.BLERefreshConnection(switchbot);
-    } else {
-    // Start to monitor advertisement packets
-      (async () => {
-      // Start to monitor advertisement packets
-        const serviceData = await this.monitorAdvertisementPackets(switchbot) as colorBulbServiceData;
-        // Update HomeKit
-        if (serviceData.model === SwitchBotBLEModel.ColorBulb && serviceData.modelName === SwitchBotBLEModelName.ColorBulb) {
-          this.serviceData = serviceData;
+    if (this.config.options?.BLE) {
+      await this.debugLog('is listening to Platform BLE.');
+      this.device.bleMac = this.device.deviceId!.match(/.{1,2}/g)!.join(':').toLowerCase();
+      await this.debugLog(`bleMac: ${this.device.bleMac}`);
+      this.platform.bleEventHandler[this.device.bleMac] = async (context: colorBulbServiceData) => {
+        try {
+          await this.debugLog(`received BLE: ${JSON.stringify(context)}`);
+          this.serviceData = context;
           await this.BLEparseStatus();
           await this.updateHomeKitCharacteristics();
-        } else {
-          await this.errorLog(`failed to get serviceData, serviceData: ${serviceData}`);
-          await this.BLERefreshConnection(switchbot);
+        } catch (e: any) {
+          await this.errorLog(`failed to handle BLE. Received: ${JSON.stringify(context)} Error: ${e}`);
         }
-      })();
+      };
+    } else {
+      await this.debugLog('is using Device BLE Scanning.');
+      const switchbot = await this.switchbotBLE();
+      if (switchbot === undefined) {
+        await this.BLERefreshConnection(switchbot);
+      } else {
+        // Start to monitor advertisement packets
+        (async () => {
+          // Start to monitor advertisement packets
+          const serviceData = await this.monitorAdvertisementPackets(switchbot) as colorBulbServiceData;
+          // Update HomeKit
+          if (serviceData.model === SwitchBotBLEModel.ColorBulb && serviceData.modelName === SwitchBotBLEModelName.ColorBulb) {
+            this.serviceData = serviceData;
+            await this.BLEparseStatus();
+            await this.updateHomeKitCharacteristics();
+          } else {
+            await this.errorLog(`failed to get serviceData, serviceData: ${serviceData}`);
+            await this.BLERefreshConnection(switchbot);
+          }
+        })();
+      }
     }
   }
 
@@ -820,13 +839,18 @@ export class ColorBulb extends deviceBase {
       this.LightBulb.Saturation, 'Saturation');
   }
 
-  async adaptiveLighting(device: device & devicesConfig): Promise<void> {
+  async getAdaptiveLightingSettings(accessory: PlatformAccessory, device: device & devicesConfig): Promise<void> {
+    // Adaptive Lighting
+    this.adaptiveLighting = accessory.context.adaptiveLighting ?? true;
+    await this.debugLog(`adaptiveLighting: ${this.adaptiveLighting}`);
+    // Adaptive Lighting Shift
     if (device.colorbulb?.adaptiveLightingShift) {
       this.adaptiveLightingShift = device.colorbulb.adaptiveLightingShift;
+      this.debugLog(`adaptiveLightingShift: ${this.adaptiveLightingShift}`);
     } else {
       this.adaptiveLightingShift = 0;
+      this.debugLog(`adaptiveLightingShift: ${this.adaptiveLightingShift}`);
     }
-    await this.debugLog(`adaptiveLightingShift: ${this.adaptiveLightingShift}`);
   }
 
   async BLEPushConnection() {

package/src/device/contact.ts

@@ -176,9 +176,6 @@ export class Contact extends deviceBase {
     this.debugLog('Registering Webhook Event Handler');
     this.registerWebhook();
 
-    //regisiter webhook event handler
-    this.registerWebhook();
-
     // Start an update interval
     interval(this.deviceRefreshRate * 1000)
       .pipe(skipWhile(() => this.contactUpdateInProgress))
@@ -287,7 +284,7 @@ export class Contact extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();
@@ -299,25 +296,41 @@ export class Contact extends deviceBase {
 
   async BLERefreshStatus(): Promise<void> {
     await this.debugLog('BLERefreshStatus');
-    const switchbot = await this.switchbotBLE();
-
-    if (switchbot === undefined) {
-      await this.BLERefreshConnection(switchbot);
-    } else {
-    // Start to monitor advertisement packets
-      (async () => {
-      // Start to monitor advertisement packets
-        const serviceData = await this.monitorAdvertisementPackets(switchbot) as contactSensorServiceData;
-        // Update HomeKit
-        if (serviceData.model === SwitchBotBLEModel.ContactSensor && serviceData.modelName === SwitchBotBLEModelName.ContactSensor) {
-          this.serviceData = serviceData;
+    if (this.config.options?.BLE) {
+      await this.debugLog('is listening to Platform BLE.');
+      this.device.bleMac = this.device.deviceId!.match(/.{1,2}/g)!.join(':').toLowerCase();
+      await this.debugLog(`bleMac: ${this.device.bleMac}`);
+      this.platform.bleEventHandler[this.device.bleMac] = async (context: contactSensorServiceData) => {
+        try {
+          await this.debugLog(`received BLE: ${JSON.stringify(context)}`);
+          this.serviceData = context;
           await this.BLEparseStatus();
           await this.updateHomeKitCharacteristics();
-        } else {
-          await this.errorLog(`failed to get serviceData, serviceData: ${serviceData}`);
-          await this.BLERefreshConnection(switchbot);
+        } catch (e: any) {
+          await this.errorLog(`failed to handle BLE. Received: ${JSON.stringify(context)} Error: ${e}`);
         }
-      })();
+      };
+    } else {
+      await this.debugLog('is using Device BLE Scanning.');
+      const switchbot = await this.switchbotBLE();
+      if (switchbot === undefined) {
+        await this.BLERefreshConnection(switchbot);
+      } else {
+        // Start to monitor advertisement packets
+        (async () => {
+          // Start to monitor advertisement packets
+          const serviceData = await this.monitorAdvertisementPackets(switchbot) as contactSensorServiceData;
+          // Update HomeKit
+          if (serviceData.model === SwitchBotBLEModel.ContactSensor && serviceData.modelName === SwitchBotBLEModelName.ContactSensor) {
+            this.serviceData = serviceData;
+            await this.BLEparseStatus();
+            await this.updateHomeKitCharacteristics();
+          } else {
+            await this.errorLog(`failed to get serviceData, serviceData: ${serviceData}`);
+            await this.BLERefreshConnection(switchbot);
+          }
+        })();
+      }
     }
   }
 

package/src/device/curtain.ts

@@ -425,7 +425,7 @@ export class Curtain extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();
@@ -437,26 +437,42 @@ export class Curtain extends deviceBase {
 
   async BLERefreshStatus(): Promise<void> {
     await this.debugLog('BLERefreshStatus');
-    const switchbot = await this.switchbotBLE();
-
-    if (switchbot === undefined) {
-      await this.BLERefreshConnection(switchbot);
-    } else {
-    // Start to monitor advertisement packets
-      (async () => {
-      // Start to monitor advertisement packets
-        const serviceData = await this.monitorAdvertisementPackets(switchbot) as curtainServiceData | curtain3ServiceData;
-        // Update HomeKit
-        if ((serviceData.model === SwitchBotBLEModel.Curtain || SwitchBotBLEModel.Curtain3)
-          && (serviceData.modelName === SwitchBotBLEModelName.Curtain || SwitchBotBLEModelName.Curtain3)) {
-          this.serviceData = serviceData;
+    if (this.config.options?.BLE) {
+      await this.debugLog('is listening to Platform BLE.');
+      this.device.bleMac = this.device.deviceId!.match(/.{1,2}/g)!.join(':').toLowerCase();
+      await this.debugLog(`bleMac: ${this.device.bleMac}`);
+      this.platform.bleEventHandler[this.device.bleMac] = async (context: curtainServiceData | curtain3ServiceData) => {
+        try {
+          await this.debugLog(`received BLE: ${JSON.stringify(context)}`);
+          this.serviceData = context;
           await this.BLEparseStatus();
           await this.updateHomeKitCharacteristics();
-        } else {
-          await this.errorLog(`failed to get serviceData, serviceData: ${serviceData}`);
-          await this.BLERefreshConnection(switchbot);
+        } catch (e: any) {
+          await this.errorLog(`failed to handle BLE. Received: ${JSON.stringify(context)} Error: ${e}`);
         }
-      })();
+      };
+    } else {
+      await this.debugLog('is using Device BLE Scanning.');
+      const switchbot = await this.switchbotBLE();
+      if (switchbot === undefined) {
+        await this.BLERefreshConnection(switchbot);
+      } else {
+        // Start to monitor advertisement packets
+        (async () => {
+          // Start to monitor advertisement packets
+          const serviceData = await this.monitorAdvertisementPackets(switchbot) as curtainServiceData | curtain3ServiceData;
+          // Update HomeKit
+          if ((serviceData.model === SwitchBotBLEModel.Curtain || SwitchBotBLEModel.Curtain3)
+          && (serviceData.modelName === SwitchBotBLEModelName.Curtain || SwitchBotBLEModelName.Curtain3)) {
+            this.serviceData = serviceData;
+            await this.BLEparseStatus();
+            await this.updateHomeKitCharacteristics();
+          } else {
+            await this.errorLog(`failed to get serviceData, serviceData: ${serviceData}`);
+            await this.BLERefreshConnection(switchbot);
+          }
+        })();
+      }
     }
   }
 

package/src/device/device.ts

@@ -79,13 +79,20 @@ export abstract class deviceBase {
       .getService(this.hap.Service.AccessoryInformation)!
       .setCharacteristic(this.hap.Characteristic.Manufacturer, 'SwitchBot')
       .setCharacteristic(this.hap.Characteristic.AppMatchingIdentifier, 'id1087374760')
-      .setCharacteristic(this.hap.Characteristic.Name, device.configDeviceName ?? device.deviceName ?? accessory.displayName)
-      .setCharacteristic(this.hap.Characteristic.ConfiguredName, device.configDeviceName ?? device.deviceName ?? accessory.displayName)
+      .setCharacteristic(this.hap.Characteristic.Name, this.validName(accessory, device))
+      .setCharacteristic(this.hap.Characteristic.ConfiguredName, this.validName(accessory, device))
       .setCharacteristic(this.hap.Characteristic.Model, device.model ?? accessory.context.model)
       .setCharacteristic(this.hap.Characteristic.ProductData, device.deviceId ?? accessory.context.deviceId)
       .setCharacteristic(this.hap.Characteristic.SerialNumber, device.deviceId);
   }
 
+  public validName(accessory: PlatformAccessory, device: device & devicesConfig) {
+    const Name = device.configDeviceName ?? device.deviceName ?? accessory.displayName;
+    const NameOfName = device.configDeviceName ? 'configDeviceName' : device.deviceName ? 'deviceName' : 'displayName';
+    const validName = this.validateAndCleanString(Name, NameOfName, Name);
+    return validName;
+  }
+
   async getDeviceLogSettings(accessory: PlatformAccessory, device: device & devicesConfig): Promise<void> {
     this.deviceLogging = this.platform.debugMode ? 'debugMode' : device.logging ?? this.config.logging ?? 'standard';
     const logging = this.platform.debugMode ? 'Debug Mode' : device.logging ? 'Device Config' : this.config.logging ? 'Platform Config' : 'Default';
@@ -355,11 +362,11 @@ export abstract class deviceBase {
       .deviceId!.match(/.{1,2}/g)!
       .join(':')
       .toLowerCase();
-    this.debugLog(`BLE Address: ${this.device.bleMac}`);
+    await this.debugLog(`BLE Address: ${this.device.bleMac}`);
   }
 
   async monitorAdvertisementPackets(switchbot: any) {
-    this.debugLog(`Scanning for ${this.device.bleModelName} devices...`);
+    await this.debugLog(`Scanning for ${this.device.bleModelName} devices...`);
     await switchbot.startScan({ model: this.device.bleModel, id: this.device.bleMac });
     // Set an event handler
     let serviceData = { model: this.device.bleModel, modelName: this.device.bleModelName } as ad['serviceData'];
@@ -374,7 +381,7 @@ export abstract class deviceBase {
         this.debugLog(`serviceData: ${JSON.stringify(ad.serviceData)}`);
       }
     };
-    // Wait 10 seconds
+    // Wait
     await switchbot.wait(this.scanDuration * 1000);
     // Stop to monitor
     await switchbot.stopScan();
@@ -765,6 +772,32 @@ export abstract class deviceBase {
     }
   }
 
+  /**
+   * Validate and clean a string value for a Name Characteristic.
+ * @param displayName
+ * @param name
+ * @param value
+ * @returns string value
+ */
+  validateAndCleanString(displayName: string, name: string, value: string): string {
+    const validPattern = /^[a-zA-Z0-9][a-zA-Z0-9 ']*[a-zA-Z0-9]$/;
+    const invalidCharsPattern = /[^a-zA-Z0-9 ']/g;
+
+    if (!validPattern.test(value)) {
+      this.warnLog(`WARNING: The accessory '${displayName}' has an invalid '${name}' characteristic ('${value}'). Please use only alphanumeric,`
+              + ' space, and apostrophe characters. Ensure it starts and ends with an alphabetic or numeric character, and avoid emojis. This may'
+              + ' prevent the accessory from being added in the Home App or cause unresponsiveness.');
+
+      // Remove invalid characters
+      value = value.replace(invalidCharsPattern, '');
+
+      // Ensure it starts and ends with an alphanumeric character
+      value = value.replace(/^[^a-zA-Z0-9]+|[^a-zA-Z0-9]+$/g, '');
+    }
+
+    return value;
+  }
+
   /**
    * Logging for Device
    */

package/src/device/fan.ts

@@ -168,9 +168,6 @@ export class Fan extends deviceBase {
     this.debugLog('Registering Webhook Event Handler');
     this.registerWebhook();
 
-    //regisiter webhook event handler
-    this.registerWebhook();
-
     // Start an update interval
     interval(this.deviceRefreshRate * 1000)
       .pipe(skipWhile(() => this.fanUpdateInProgress))
@@ -314,7 +311,7 @@ export class Fan extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();
@@ -326,25 +323,41 @@ export class Fan extends deviceBase {
 
   async BLERefreshStatus(): Promise<void> {
     await this.debugLog('BLERefreshStatus');
-    const switchbot = await this.switchbotBLE();
-
-    if (switchbot === undefined) {
-      await this.BLERefreshConnection(switchbot);
-    } else {
-      // Start to monitor advertisement packets
-      (async () => {
-        // Start to monitor advertisement packets
-        const serviceData = await this.monitorAdvertisementPackets(switchbot) as batteryCirculatorFanServiceData;
-        // Update HomeKit
-        if (serviceData.model === SwitchBotBLEModel.Unknown && SwitchBotBLEModelName.Unknown) {
-          this.serviceData = serviceData;
+    if (this.config.options?.BLE) {
+      await this.debugLog('is listening to Platform BLE.');
+      this.device.bleMac = this.device.deviceId!.match(/.{1,2}/g)!.join(':').toLowerCase();
+      await this.debugLog(`bleMac: ${this.device.bleMac}`);
+      this.platform.bleEventHandler[this.device.bleMac] = async (context: batteryCirculatorFanServiceData) => {
+        try {
+          await this.debugLog(`received BLE: ${JSON.stringify(context)}`);
+          this.serviceData = context;
           await this.BLEparseStatus();
           await this.updateHomeKitCharacteristics();
-        } else {
-          await this.errorLog(`failed to get serviceData, serviceData: ${serviceData}`);
-          await this.BLERefreshConnection(switchbot);
+        } catch (e: any) {
+          await this.errorLog(`failed to handle BLE. Received: ${JSON.stringify(context)} Error: ${e}`);
         }
-      })();
+      };
+    } else {
+      await this.debugLog('is using Device BLE Scanning.');
+      const switchbot = await this.switchbotBLE();
+      if (switchbot === undefined) {
+        await this.BLERefreshConnection(switchbot);
+      } else {
+      // Start to monitor advertisement packets
+        (async () => {
+        // Start to monitor advertisement packets
+          const serviceData = await this.monitorAdvertisementPackets(switchbot) as batteryCirculatorFanServiceData;
+          // Update HomeKit
+          if (serviceData.model === SwitchBotBLEModel.Unknown && SwitchBotBLEModelName.Unknown) {
+            this.serviceData = serviceData;
+            await this.BLEparseStatus();
+            await this.updateHomeKitCharacteristics();
+          } else {
+            await this.errorLog(`failed to get serviceData, serviceData: ${serviceData}`);
+            await this.BLERefreshConnection(switchbot);
+          }
+        })();
+      }
     }
   }