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

package/src/device/robotvacuumcleaner.ts

@@ -63,6 +63,10 @@ export class RobotVacuumCleaner extends deviceBase {
 
     // 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,
       Service: accessory.getService(this.hap.Service.Lightbulb) ?? accessory.addService(this.hap.Service.Lightbulb) as Service,
@@ -73,7 +77,7 @@ export class RobotVacuumCleaner extends deviceBase {
 
     // Initialize LightBulb Characteristics
     this.LightBulb.Service
-      .setCharacteristic(this.hap.Characteristic.Name, accessory.displayName)
+      .setCharacteristic(this.hap.Characteristic.Name, this.LightBulb.Name)
       .getCharacteristic(this.hap.Characteristic.On)
       .onGet(() => {
         return this.LightBulb.On;
@@ -97,6 +101,10 @@ export class RobotVacuumCleaner extends deviceBase {
 
     // Initialize Battery Service
     accessory.context.Battery = accessory.context.Battery ?? {};
+    if (accessory.context.Battery.Name) {
+      accessory.context.Battery.Name = this.validateAndCleanString(accessory.context.Battery.Name,
+        'Battery Name', accessory.context.Battery.Name);
+    }
     this.Battery = {
       Name: accessory.context.Battery.Name ?? `${accessory.displayName} Battery`,
       Service: accessory.getService(this.hap.Service.Battery) ?? accessory.addService(this.hap.Service.Battery) as Service,

package/src/device/waterdetector.ts

@@ -64,6 +64,10 @@ export class WaterDetector extends deviceBase {
 
     // Initialize Battery Service
     accessory.context.Battery = accessory.context.Battery ?? {};
+    if (accessory.context.Battery.Name) {
+      accessory.context.Battery.Name = this.validateAndCleanString(accessory.context.Battery.Name,
+        'Battery Name', accessory.context.Battery.Name);
+    }
     this.Battery = {
       Name: accessory.context.Battery.Name ?? `${accessory.displayName} Battery`,
       Service: accessory.getService(this.hap.Service.Battery) ?? accessory.addService(this.hap.Service.Battery) as Service,
@@ -99,6 +103,10 @@ export class WaterDetector extends deviceBase {
       }
     } else {
       accessory.context.LeakSensor = accessory.context.LeakSensor ?? {};
+      if (accessory.context.LeakSensor.Name) {
+        accessory.context.LeakSensor.Name = this.validateAndCleanString(accessory.context.LeakSensor.Name,
+          'LeakSensor Name', accessory.context.LeakSensor.Name);
+      }
       this.LeakSensor = {
         Name: accessory.context.LeakSensor.Name ?? `${accessory.displayName} Leak Sensor`,
         Service: accessory.getService(this.hap.Service.LeakSensor) ?? this.accessory.addService(this.hap.Service.LeakSensor) as Service,

package/src/irdevice/airconditioner.ts

@@ -66,6 +66,10 @@ export class AirConditioner extends irdeviceBase {
 
     // Initialize HeaterCooler Service
     accessory.context.HeaterCooler = accessory.context.HeaterCooler ?? {};
+    if (accessory.context.HeaterCooler.Name) {
+      accessory.context.HeaterCooler.Name = this.validateAndCleanString(accessory.context.HeaterCooler.Name,
+        'HeaterCooler Name', accessory.context.HeaterCooler.Name);
+    }
     this.HeaterCooler = {
       Name: accessory.context.HeaterCooler.Name ?? `${accessory.displayName} ${device.remoteType}`,
       Service: accessory.getService(this.hap.Service.HeaterCooler) ?? accessory.addService(this.hap.Service.HeaterCooler) as Service,
@@ -151,6 +155,10 @@ export class AirConditioner extends irdeviceBase {
       const meterUuid = this.platform.api.hap.uuid.generate(`${this.device.irair.meterId}-${this.device.irair.meterType}`);
       this.meter = this.platform.accessories.find((accessory) => accessory.UUID === meterUuid);
       accessory.context.HumiditySensor = accessory.context.HumiditySensor ?? {};
+      if (accessory.context.HumiditySensor.Name) {
+        accessory.context.HumiditySensor.Name = this.validateAndCleanString(accessory.context.HumiditySensor.Name,
+          'HumiditySensor Name', accessory.context.HumiditySensor.Name);
+      }
       this.HumiditySensor = {
         Name: accessory.context.HumiditySensor ?? this.meter!.displayName,
         Service: this.meter!.getService(this.hap.Service.HumiditySensor) ?? this.meter!.addService(this.hap.Service.HumiditySensor) as Service,
@@ -164,8 +172,9 @@ export class AirConditioner extends irdeviceBase {
       this.meter = this.platform.accessories.find((accessory) => accessory.UUID === meterUuid);
     }
 
-    if (this.meter) {
-      this.HumiditySensor!.Service
+    if (this.meter && this.HumiditySensor) {
+      this.HumiditySensor.Service
+        .setCharacteristic(this.hap.Characteristic.Name, this.HumiditySensor.Name)
         .getCharacteristic(this.hap.Characteristic.CurrentRelativeHumidity)
         .onGet(async () => {
           return await this.CurrentRelativeHumidityGet();

package/src/irdevice/airpurifier.ts

@@ -59,6 +59,10 @@ export class AirPurifier extends irdeviceBase {
 
     // Initialize AirPurifier Service
     accessory.context.AirPurifier = accessory.context.AirPurifier ?? {};
+    if (accessory.context.AirPurifier.Name) {
+      accessory.context.AirPurifier.Name = this.validateAndCleanString(accessory.context.AirPurifier.Name,
+        'AirPurifier Name', accessory.context.AirPurifier.Name);
+    }
     this.AirPurifier = {
       Name: accessory.context.AirPurifier.Name ?? `${accessory.displayName} Air Purifier`,
       Service: accessory.getService(this.hap.Service.AirPurifier) ?? accessory.addService(this.hap.Service.AirPurifier) as Service,
@@ -93,6 +97,10 @@ export class AirPurifier extends irdeviceBase {
 
     // Initialize TemperatureSensor Service
     accessory.context.TemperatureSensor = accessory.context.TemperatureSensor ?? {};
+    if (accessory.context.TemperatureSensor.Name) {
+      accessory.context.TemperatureSensor.Name = this.validateAndCleanString(accessory.context.TemperatureSensor.Name,
+        'TemperatureSensor Name', accessory.context.TemperatureSensor.Name);
+    }
     this.TemperatureSensor = {
       Name: accessory.context.TemperatureSensor.Name ?? `${accessory.displayName} Temperature Sensor`,
       Service: accessory.getService(this.hap.Service.TemperatureSensor) ?? accessory.addService(this.hap.Service.TemperatureSensor) as Service,

package/src/irdevice/camera.ts

@@ -33,6 +33,10 @@ export class Camera extends irdeviceBase {
 
     // Initialize Switch Service
     accessory.context.Switch = accessory.context.Switch ?? {};
+    if (accessory.context.Switch.Name) {
+      accessory.context.Switch.Name = this.validateAndCleanString(accessory.context.Switch.Name,
+        'Switch Name', accessory.context.Switch.Name);
+    }
     this.Switch = {
       Name: accessory.context.Switch.Name ?? `${accessory.displayName} Camera`,
       Service: accessory.getService(this.hap.Service.Switch) ?? accessory.addService(this.hap.Service.Switch) as Service,

package/src/irdevice/fan.ts

@@ -36,6 +36,10 @@ export class IRFan extends irdeviceBase {
 
     // Initialize Switch Service
     accessory.context.Fan = accessory.context.Fan ?? {};
+    if (accessory.context.Fan.Name) {
+      accessory.context.Fan.Name = this.validateAndCleanString(accessory.context.Fan.Name,
+        'Fan Name', accessory.context.Fan.Name);
+    }
     this.Fan = {
       Name: accessory.context.Fan.Name ?? `${accessory.displayName} Fan`,
       Service: accessory.getService(this.hap.Service.Fanv2) ?? accessory.addService(this.hap.Service.Fanv2) as Service,

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)

package/src/irdevice/other.ts

@@ -87,6 +87,10 @@ export class Others extends irdeviceBase {
       accessory.category = this.hap.Categories.SWITCH;
       // Initialize Switch Service
       accessory.context.Switch = accessory.context.Switch ?? {};
+      if (accessory.context.Switch.Name) {
+        accessory.context.Switch.Name = this.validateAndCleanString(accessory.context.Switch.Name,
+          'Switch Name', accessory.context.Switch.Name);
+      }
       this.Switch = {
         Name: accessory.context.Switch.Name ?? accessory.displayName,
         Service: accessory.getService(this.hap.Service.Switch) ?? accessory.addService(this.hap.Service.Switch) as Service,
@@ -113,6 +117,10 @@ export class Others extends irdeviceBase {
       accessory.category = this.hap.Categories.GARAGE_DOOR_OPENER;
       // Initialize GarageDoor Service
       accessory.context.GarageDoor = accessory.context.GarageDoor ?? {};
+      if (accessory.context.GarageDoor.Name) {
+        accessory.context.GarageDoor.Name = this.validateAndCleanString(accessory.context.GarageDoor.Name,
+          'GarageDoor Name', accessory.context.GarageDoor.Name);
+      }
       this.GarageDoor = {
         Name: accessory.context.GarageDoor.Name ?? accessory.displayName,
         Service: accessory.getService(this.hap.Service.GarageDoorOpener) ?? accessory.addService(this.hap.Service.GarageDoorOpener) as Service,
@@ -146,6 +154,10 @@ export class Others extends irdeviceBase {
       accessory.category = this.hap.Categories.DOOR;
       // Initialize Door Service
       accessory.context.Door = accessory.context.Door ?? {};
+      if (accessory.context.Door.Name) {
+        accessory.context.Door.Name = this.validateAndCleanString(accessory.context.Door.Name,
+          'Door Name', accessory.context.Door.Name);
+      }
       this.Door = {
         Name: accessory.context.Door.Name ?? accessory.displayName,
         Service: accessory.getService(this.hap.Service.Door) ?? accessory.addService(this.hap.Service.Door) as Service,
@@ -178,6 +190,10 @@ export class Others extends irdeviceBase {
       accessory.category = this.hap.Categories.WINDOW;
       // Initialize Window Service
       accessory.context.Window = accessory.context.Window ?? {};
+      if (accessory.context.Window.Name) {
+        accessory.context.Window.Name = this.validateAndCleanString(accessory.context.Window.Name,
+          'Window Name', accessory.context.Window.Name);
+      }
       this.Window = {
         Name: accessory.context.Window.Name ?? accessory.displayName,
         Service: accessory.getService(this.hap.Service.Window) ?? accessory.addService(this.hap.Service.Window) as Service,
@@ -210,6 +226,10 @@ export class Others extends irdeviceBase {
       accessory.category = this.hap.Categories.WINDOW_COVERING;
       // Initialize WindowCovering Service
       accessory.context.WindowCovering = accessory.context.WindowCovering ?? {};
+      if (accessory.context.WindowCovering.Name) {
+        accessory.context.WindowCovering.Name = this.validateAndCleanString(accessory.context.WindowCovering.Name,
+          'WindowCovering Name', accessory.context.WindowCovering.Name);
+      }
       this.WindowCovering = {
         Name: accessory.context.WindowCovering.Name ?? accessory.displayName,
         Service: accessory.getService(this.hap.Service.WindowCovering) ?? accessory.addService(this.hap.Service.WindowCovering) as Service,
@@ -243,6 +263,10 @@ export class Others extends irdeviceBase {
       accessory.category = this.hap.Categories.DOOR_LOCK;
       // Initialize Lock Service
       accessory.context.LockMechanism = accessory.context.LockMechanism ?? {};
+      if (accessory.context.LockMechanism.Name) {
+        accessory.context.LockMechanism.Name = this.validateAndCleanString(accessory.context.LockMechanism.Name,
+          'LockMechanism Name', accessory.context.LockMechanism.Name);
+      }
       this.LockMechanism = {
         Name: accessory.context.LockMechanism.Name ?? accessory.displayName,
         Service: accessory.getService(this.hap.Service.LockMechanism) ?? accessory.addService(this.hap.Service.LockMechanism) as Service,
@@ -270,6 +294,10 @@ export class Others extends irdeviceBase {
       accessory.category = this.hap.Categories.FAUCET;
       // Initialize Faucet Service
       accessory.context.Faucet = accessory.context.Faucet ?? {};
+      if (accessory.context.Faucet.Name) {
+        accessory.context.Faucet.Name = this.validateAndCleanString(accessory.context.Faucet.Name,
+          'Faucet Name', accessory.context.Faucet.Name);
+      }
       this.Faucet = {
         Name: accessory.context.Faucet.Name ?? accessory.displayName,
         Service: accessory.getService(this.hap.Service.Faucet) ?? accessory.addService(this.hap.Service.Faucet) as Service,
@@ -296,6 +324,10 @@ export class Others extends irdeviceBase {
       accessory.category = this.hap.Categories.FAN;
       // Initialize Fan Service
       accessory.context.Fan = accessory.context.Fan ?? {};
+      if (accessory.context.Fan.Name) {
+        accessory.context.Fan.Name = this.validateAndCleanString(accessory.context.Fan.Name,
+          'Fan Name', accessory.context.Fan.Name);
+      }
       this.Fan = {
         Name: accessory.context.Fan.Name ?? accessory.displayName,
         Service: accessory.getService(this.hap.Service.Fanv2) ?? accessory.addService(this.hap.Service.Fanv2) as Service,
@@ -322,6 +354,10 @@ export class Others extends irdeviceBase {
       accessory.category = this.hap.Categories.PROGRAMMABLE_SWITCH;
       // Initialize StatefulProgrammableSwitch Service
       accessory.context.StatefulProgrammableSwitch = accessory.context.StatefulProgrammableSwitch ?? {};
+      if (accessory.context.StatefulProgrammableSwitch.Name) {
+        accessory.context.StatefulProgrammableSwitch.Name = this.validateAndCleanString(accessory.context.StatefulProgrammableSwitch.Name,
+          'StatefulProgrammableSwitch Name', accessory.context.StatefulProgrammableSwitch.Name);
+      }
       this.StatefulProgrammableSwitch = {
         Name: accessory.context.StatefulProgrammableSwitch.Name ?? accessory.displayName,
         Service: accessory.getService(this.hap.Service.StatefulProgrammableSwitch)
@@ -349,6 +385,10 @@ export class Others extends irdeviceBase {
       accessory.category = this.hap.Categories.OUTLET;
       // Initialize Switch property
       accessory.context.Outlet = accessory.context.Outlet ?? {};
+      if (accessory.context.Outlet.Name) {
+        accessory.context.Outlet.Name = this.validateAndCleanString(accessory.context.Outlet.Name,
+          'Outlet Name', accessory.context.Outlet.Name);
+      }
       this.Outlet = {
         Name: accessory.context.Outlet.Name ?? accessory.displayName,
         Service: accessory.getService(this.hap.Service.Outlet) ?? accessory.addService(this.hap.Service.Outlet) as Service,

package/src/irdevice/tv.ts

@@ -45,6 +45,14 @@ export class TV extends irdeviceBase {
 
     // Initialize Television Service
     accessory.context.Television = accessory.context.Television ?? {};
+    if (accessory.context.Television.Name) {
+      accessory.context.Television.Name = this.validateAndCleanString(accessory.context.Television.Name,
+        'Television Name', accessory.context.Television.Name);
+    }
+    if (accessory.context.Television.ConfiguredName) {
+      accessory.context.Television.ConfiguredName = this.validateAndCleanString(accessory.context.Television.ConfiguredName,
+        'Television ConfiguredName', accessory.context.Television.ConfiguredName);
+    }
     this.Television = {
       Name: accessory.context.Television.Name ?? `${accessory.displayName} ${device.remoteType}`,
       ConfiguredName: accessory.context.Television.ConfiguredName ?? `${accessory.displayName} ${device.remoteType}`,
@@ -104,6 +112,10 @@ export class TV extends irdeviceBase {
 
     // Initialize TelevisionSpeaker Service
     accessory.context.TelevisionSpeaker = accessory.context.TelevisionSpeaker ?? {};
+    if (accessory.context.TelevisionSpeaker.Name) {
+      accessory.context.TelevisionSpeaker.Name = this.validateAndCleanString(accessory.context.TelevisionSpeaker.Name,
+        'TelevisionSpeaker Name', accessory.context.TelevisionSpeaker.Name);
+    }
     this.TelevisionSpeaker = {
       Name: accessory.context.TelevisionSpeaker.Name ?? `${accessory.displayName} ${device.remoteType} Speaker`,
       Service: accessory.getService(this.hap.Service.TelevisionSpeaker) ?? accessory.addService(this.hap.Service.TelevisionSpeaker) as Service,

package/src/irdevice/vacuumcleaner.ts

@@ -33,6 +33,10 @@ export class VacuumCleaner extends irdeviceBase {
 
     // Initialize Switch Service
     accessory.context.Switch = accessory.context.Switch ?? {};
+    if (accessory.context.Switch.Name) {
+      accessory.context.Switch.Name = this.validateAndCleanString(accessory.context.Switch.Name,
+        'Switch Name', accessory.context.Switch.Name);
+    }
     this.Switch = {
       Name: accessory.context.Switch.Name ?? `${accessory.displayName} ${device.remoteType}`,
       Service: accessory.getService(this.hap.Service.Switch) ?? accessory.addService(this.hap.Service.Switch) as Service,

package/src/irdevice/waterheater.ts

@@ -41,7 +41,7 @@ export class WaterHeater extends irdeviceBase {
     accessory.context.Valve = this.Valve as object;
 
     this.Valve.Service
-      .setCharacteristic(this.hap.Characteristic.Name, accessory.displayName)
+      .setCharacteristic(this.hap.Characteristic.Name, this.Valve.Name)
       .setCharacteristic(this.hap.Characteristic.ValveType, this.hap.Characteristic.ValveType.GENERIC_VALVE)
       .getCharacteristic(this.hap.Characteristic.Active)
       .onGet(() => {