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

package/src/irdevice/irdevice.ts

@@ -43,13 +43,20 @@ export abstract class irdeviceBase {
       .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, accessory.context.model ?? 'Unknown')
       .setCharacteristic(this.hap.Characteristic.ProductData, accessory.context.deviceId)
       .setCharacteristic(this.hap.Characteristic.SerialNumber, accessory.context.deviceId);
   }
 
+  public validName(accessory: PlatformAccessory, device: irdevice & irDevicesConfig) {
+    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(device: irdevice & irDevicesConfig): Promise<void> {
     if (this.platform.debugMode) {
       this.deviceLogging = this.accessory.context.logging = 'debugMode';
@@ -346,6 +353,32 @@ export abstract class irdeviceBase {
     }
   }
 
+  /**
+   * 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/irdevice/light.ts

@@ -48,6 +48,10 @@ export class Light extends irdeviceBase {
     if (!device.irlight?.stateless) {
       // Initialize LightBulb Service
       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} ${device.remoteType}`,
         Service: accessory.getService(this.hap.Service.Lightbulb) ?? accessory.addService(this.hap.Service.Lightbulb) as Service,
@@ -65,6 +69,10 @@ export class Light extends irdeviceBase {
     } else {
       // Initialize ProgrammableSwitchOn Service
       accessory.context.ProgrammableSwitchOn = accessory.context.ProgrammableSwitchOn ?? {};
+      if (accessory.context.ProgrammableSwitchOn.Name) {
+        accessory.context.ProgrammableSwitchOn.Name = this.validateAndCleanString(accessory.context.ProgrammableSwitchOn.Name,
+          'ProgrammableSwitchOn Name', accessory.context.ProgrammableSwitchOn.Name);
+      }
       this.ProgrammableSwitchOn = {
         Name: accessory.context.ProgrammableSwitchOn.Name ?? `${accessory.displayName} ${device.remoteType} On`,
         Service: accessory.getService(this.hap.Service.StatefulProgrammableSwitch)
@@ -96,6 +104,10 @@ export class Light extends irdeviceBase {
 
       // Initialize ProgrammableSwitchOff Service
       accessory.context.ProgrammableSwitchOff = accessory.context.ProgrammableSwitchOff ?? {};
+      if (accessory.context.ProgrammableSwitchOff.Name) {
+        accessory.context.ProgrammableSwitchOff.Name = this.validateAndCleanString(accessory.context.ProgrammableSwitchOff.Name,
+          'ProgrammableSwitchOff Name', accessory.context.ProgrammableSwitchOff.Name);
+      }
       this.ProgrammableSwitchOff = {
         Name: accessory.context.ProgrammableSwitchOff.Name ?? `${accessory.displayName} ${device.remoteType} Off`,
         Service: accessory.getService(this.hap.Service.StatefulProgrammableSwitch)