@switchbot/homebridge-switchbot 3.6.1-beta.8 → 3.7.0

package/src/platform.ts

@@ -104,8 +104,8 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
     };
 
     // Plugin Configuration
-    this.getPlatformConfigSettings();
     this.getPlatformLogSettings();
+    this.getPlatformConfigSettings();
     this.getVersion();
 
     // Finish initializing the platform
@@ -336,6 +336,15 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
             }
           };
         })();
+
+        this.api.on('shutdown', async () => {
+          try {
+            switchbot.stopScan();
+            this.infoLog('Stopped BLE scanning to close listening.');
+          } catch (e: any) {
+            this.errorLog(`Failed to stop Platform BLE scanning. Error:${e.message}`);
+          }
+        });
       }
     } else {
       await this.debugLog('Platform BLE is not enabled');
@@ -871,7 +880,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = device.deviceType;
         existingAccessory.context.model = SwitchBotModel.Humidifier;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         existingAccessory.context.connectionType = await this.connectionType(device);
         existingAccessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
         await this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
@@ -885,7 +896,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (await this.registerDevice(device)) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -893,7 +906,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = device.deviceType;
       accessory.context.model = SwitchBotModel.Humidifier;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
       accessory.context.connectionType = await this.connectionType(device);
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -926,7 +941,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = device.deviceType;
         existingAccessory.context.model = SwitchBotModel.Bot;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         existingAccessory.context.connectionType = await this.connectionType(device);
         existingAccessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
         this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
@@ -940,7 +957,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (await this.registerDevice(device)) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -948,7 +967,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = device.deviceType;
       accessory.context.model = SwitchBotModel.Bot;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = await this.connectionType(device);
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -982,7 +1004,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.model = SwitchBotModel.Meter;
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = device.deviceType;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         existingAccessory.context.connectionType = await this.connectionType(device);
         existingAccessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
         this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
@@ -996,7 +1020,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (await this.registerDevice(device)) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -1004,7 +1030,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.model = SwitchBotModel.Meter;
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = device.deviceType;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = await this.connectionType(device);
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -1038,7 +1067,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.model = SwitchBotModel.MeterPlusUS ?? SwitchBotModel.MeterPlusJP;
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = device.deviceType;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         existingAccessory.context.connectionType = await this.connectionType(device);
         existingAccessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
         this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
@@ -1052,7 +1083,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (await this.registerDevice(device)) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -1060,7 +1093,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.model = SwitchBotModel.MeterPlusUS ?? SwitchBotModel.MeterPlusJP;
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = device.deviceType;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = await this.connectionType(device);
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -1094,7 +1130,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.model = SwitchBotModel.Hub2;
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = device.deviceType;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         existingAccessory.context.connectionType = await this.connectionType(device);
         existingAccessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
         this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
@@ -1108,7 +1146,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (await this.registerDevice(device)) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -1116,7 +1156,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.model = SwitchBotModel.Hub2;
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = device.deviceType;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = await this.connectionType(device);
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -1149,7 +1192,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.model = SwitchBotModel.OutdoorMeter;
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = device.deviceType;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         existingAccessory.context.connectionType = await this.connectionType(device);
         existingAccessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
         await this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
@@ -1163,7 +1208,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (await this.registerDevice(device)) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -1171,7 +1218,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.model = SwitchBotModel.OutdoorMeter;
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = device.deviceType;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = await this.connectionType(device);
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -1204,7 +1254,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = device.deviceType;
         existingAccessory.context.model = SwitchBotModel.WaterDetector;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         existingAccessory.context.connectionType = await this.connectionType(device);
         existingAccessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
         this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
@@ -1218,7 +1270,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (await this.registerDevice(device)) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -1226,7 +1280,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = device.deviceType;
       accessory.context.model = SwitchBotModel.WaterDetector;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       accessory.context.connectionType = await this.connectionType(device);
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -1259,7 +1316,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = device.deviceType;
         existingAccessory.context.model = SwitchBotModel.MotionSensor;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         existingAccessory.context.connectionType = await this.connectionType(device);
         existingAccessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
         this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
@@ -1273,7 +1332,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (await this.registerDevice(device)) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -1281,7 +1342,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = device.deviceType;
       accessory.context.model = SwitchBotModel.MotionSensor;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = await this.connectionType(device);
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -1314,7 +1378,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = device.deviceType;
         existingAccessory.context.model = SwitchBotModel.ContactSensor;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         existingAccessory.context.connectionType = await this.connectionType(device);
         existingAccessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
         this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
@@ -1328,7 +1394,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (await this.registerDevice(device)) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -1336,7 +1404,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = device.deviceType;
       accessory.context.model = SwitchBotModel.ContactSensor;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = await this.connectionType(device);
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -1369,7 +1440,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = device.deviceType;
         existingAccessory.context.model = SwitchBotModel.BlindTilt;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         existingAccessory.context.connectionType = await this.connectionType(device);
         existingAccessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
         this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
@@ -1397,7 +1470,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
 
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -1405,7 +1480,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = device.deviceType;
       accessory.context.model = SwitchBotModel.BlindTilt;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = await this.connectionType(device);
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -1438,7 +1516,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = device.deviceType;
         existingAccessory.context.model = device.deviceType === 'Curtain3' ? SwitchBotModel.Curtain3 : SwitchBotModel.Curtain;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         existingAccessory.context.connectionType = await this.connectionType(device);
         existingAccessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
         await this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
@@ -1466,7 +1546,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
 
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -1474,7 +1556,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = device.deviceType;
       accessory.context.model = device.deviceType === 'Curtain3' ? SwitchBotModel.Curtain3 : SwitchBotModel.Curtain;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = await this.connectionType(device);
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -1508,7 +1593,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceType = device.deviceType;
         existingAccessory.context.model = device.deviceType === 'Plug Mini (US)' ? SwitchBotModel.PlugMiniUS : device.deviceType === 'Plug Mini (JP)'
           ? SwitchBotModel.PlugMiniJP : SwitchBotModel.Plug;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         existingAccessory.context.connectionType = await this.connectionType(device);
         existingAccessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
         await this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
@@ -1522,7 +1609,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (await this.registerDevice(device)) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -1531,7 +1620,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceType = device.deviceType;
       accessory.context.model = device.deviceType === 'Plug Mini (US)' ? SwitchBotModel.PlugMiniUS : device.deviceType === 'Plug Mini (JP)'
         ? SwitchBotModel.PlugMiniJP : SwitchBotModel.Plug;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = await this.connectionType(device);
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -1564,7 +1656,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = device.deviceType;
         existingAccessory.context.model = device.deviceType === 'Smart Lock Pro' ? SwitchBotModel.LockPro : SwitchBotModel.Lock;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         existingAccessory.context.connectionType = await this.connectionType(device);
         existingAccessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
         this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
@@ -1578,7 +1672,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (await this.registerDevice(device)) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -1586,7 +1682,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = device.deviceType;
       accessory.context.model = device.deviceType === 'Smart Lock Pro' ? SwitchBotModel.LockPro : SwitchBotModel.Lock;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = await this.connectionType(device);
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -1619,7 +1718,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = device.deviceType;
         existingAccessory.context.model = SwitchBotModel.ColorBulb;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         existingAccessory.context.connectionType = await this.connectionType(device);
         existingAccessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
         await this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
@@ -1633,7 +1734,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (await this.registerDevice(device)) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -1641,7 +1744,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = device.deviceType;
       accessory.context.model = SwitchBotModel.ColorBulb;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = await this.connectionType(device);
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -1674,7 +1780,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = device.deviceType;
         existingAccessory.context.model = device.deviceType === 'Ceiling Light Pro' ? SwitchBotModel.CeilingLightPro : SwitchBotModel.CeilingLight;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         existingAccessory.context.connectionType = await this.connectionType(device);
         existingAccessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
         await this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
@@ -1688,7 +1796,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (await this.registerDevice(device)) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -1696,7 +1806,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = device.deviceType;
       accessory.context.model = device.deviceType === 'Ceiling Light Pro' ? SwitchBotModel.CeilingLightPro : SwitchBotModel.CeilingLight;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = await this.connectionType(device);
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -1729,7 +1842,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = device.deviceType;
         existingAccessory.context.model = SwitchBotModel.StripLight;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         existingAccessory.context.connectionType = await this.connectionType(device);
         existingAccessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
         await this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
@@ -1743,7 +1858,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (await this.registerDevice(device)) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -1751,7 +1868,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = device.deviceType;
       accessory.context.model = SwitchBotModel.StripLight;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = await this.connectionType(device);
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -1784,7 +1904,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = device.deviceType;
         existingAccessory.context.model = SwitchBotModel.BatteryCirculatorFan;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         existingAccessory.context.connectionType = await this.connectionType(device);
         existingAccessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
         await this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
@@ -1798,7 +1920,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (await this.registerDevice(device)) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -1806,7 +1930,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = device.deviceType;
       accessory.context.model = SwitchBotModel.BatteryCirculatorFan;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = await this.connectionType(device);
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -1843,7 +1970,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
             : device.deviceType === 'Robot Vacuum Cleaner S10' ? SwitchBotModel.RobotVacuumCleanerS10
               : device.deviceType === 'WoSweeper' ? SwitchBotModel.WoSweeper : device.deviceType === 'WoSweeperMini' ? SwitchBotModel.WoSweeperMini
                 : SwitchBotModel.Unknown;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         existingAccessory.context.connectionType = await this.connectionType(device);
         existingAccessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
         await this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
@@ -1857,7 +1986,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (await this.registerDevice(device)) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -1869,7 +2000,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
           : device.deviceType === 'Robot Vacuum Cleaner S10' ? SwitchBotModel.RobotVacuumCleanerS10
             : device.deviceType === 'WoSweeper' ? SwitchBotModel.WoSweeper : device.deviceType === 'WoSweeperMini' ? SwitchBotModel.WoSweeperMini
               : SwitchBotModel.Unknown;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = await this.connectionType(device);
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -1900,7 +2034,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       existingAccessory.context.deviceId = device.deviceId;
       existingAccessory.context.deviceType = `IR: ${device.remoteType}`;
       existingAccessory.context.model = device.remoteType;
-      existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+      existingAccessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
       await this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
       existingAccessory.context.connectionType = device.connectionType;
       this.api.updatePlatformAccessories([existingAccessory]);
@@ -1910,7 +2046,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       await this.debugLog(`${device.remoteType} uuid: ${device.deviceId}-${device.remoteType}, (${existingAccessory.UUID})`);
     } else if (!device.hide_device && device.hubDeviceId) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -1918,7 +2056,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = `IR: ${device.remoteType}`;
       accessory.context.model = device.remoteType;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = device.connectionType;
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -1950,7 +2091,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = `IR: ${device.remoteType}`;
         existingAccessory.context.model = device.remoteType;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         await this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
         existingAccessory.context.connectionType = device.connectionType;
         this.api.updatePlatformAccessories([existingAccessory]);
@@ -1963,7 +2106,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (!device.hide_device && device.hubDeviceId) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -1971,7 +2116,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = `IR: ${device.remoteType}`;
       accessory.context.model = device.remoteType;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = device.connectionType;
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -2004,7 +2152,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = `IR: ${device.remoteType}`;
         existingAccessory.context.model = device.remoteType;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         await this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
         existingAccessory.context.connectionType = device.connectionType;
         this.api.updatePlatformAccessories([existingAccessory]);
@@ -2017,7 +2167,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (!device.hide_device && device.hubDeviceId) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -2025,7 +2177,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = `IR: ${device.remoteType}`;
       accessory.context.model = device.remoteType;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = device.connectionType;
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -2058,7 +2213,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = `IR: ${device.remoteType}`;
         existingAccessory.context.model = device.remoteType;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         await this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
         existingAccessory.context.connectionType = device.connectionType;
         this.api.updatePlatformAccessories([existingAccessory]);
@@ -2071,7 +2228,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (!device.hide_device && device.hubDeviceId) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -2079,7 +2238,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = `IR: ${device.remoteType}`;
       accessory.context.model = device.remoteType;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = device.connectionType;
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -2112,7 +2274,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = `IR: ${device.remoteType}`;
         existingAccessory.context.model = device.remoteType;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         await this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
         existingAccessory.context.connectionType = device.connectionType;
         this.api.updatePlatformAccessories([existingAccessory]);
@@ -2125,7 +2289,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (!device.hide_device && device.hubDeviceId) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -2133,7 +2299,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = `IR: ${device.remoteType}`;
       accessory.context.model = device.remoteType;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = device.connectionType;
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -2166,7 +2335,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = `IR: ${device.remoteType}`;
         existingAccessory.context.model = device.remoteType;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         await this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
         existingAccessory.context.connectionType = device.connectionType;
         this.api.updatePlatformAccessories([existingAccessory]);
@@ -2179,7 +2350,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (!device.hide_device && device.hubDeviceId) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -2187,7 +2360,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = `IR: ${device.remoteType}`;
       accessory.context.model = device.remoteType;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = device.connectionType;
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -2220,7 +2396,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = `IR: ${device.remoteType}`;
         existingAccessory.context.model = device.remoteType;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         await this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
         existingAccessory.context.connectionType = device.connectionType;
         this.api.updatePlatformAccessories([existingAccessory]);
@@ -2233,7 +2411,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (!device.hide_device && device.hubDeviceId) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -2241,7 +2421,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = `IR: ${device.remoteType}`;
       accessory.context.model = device.remoteType;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = device.connectionType;
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -2274,7 +2457,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = `IR: ${device.remoteType}`;
         existingAccessory.context.model = device.remoteType;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         await this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
         existingAccessory.context.connectionType = device.connectionType;
         this.api.updatePlatformAccessories([existingAccessory]);
@@ -2287,7 +2472,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (!device.hide_device && device.hubDeviceId) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -2295,7 +2482,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = `IR: ${device.remoteType}`;
       accessory.context.model = device.remoteType;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = device.connectionType;
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -2328,7 +2518,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
         existingAccessory.context.deviceId = device.deviceId;
         existingAccessory.context.deviceType = `IR: ${device.remoteType}`;
         existingAccessory.context.model = device.remoteType;
-        existingAccessory.displayName = device.configDeviceName ?? device.deviceName;
+        existingAccessory.displayName = device.configDeviceName
+          ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+          : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
         await this.infoLog(`Restoring existing accessory from cache: ${existingAccessory.displayName} deviceId: ${device.deviceId}`);
         existingAccessory.context.connectionType = device.connectionType;
         this.api.updatePlatformAccessories([existingAccessory]);
@@ -2341,7 +2533,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     } else if (!device.hide_device && device.hubDeviceId) {
       // create a new accessory
-      const accessory = new this.api.platformAccessory(device.deviceName, uuid);
+      const accessory = new this.api.platformAccessory(device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName), uuid);
 
       // store a copy of the device object in the `accessory.context`
       // the `context` property can be used to store any data about the accessory you may need
@@ -2349,7 +2543,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       accessory.context.deviceId = device.deviceId;
       accessory.context.deviceType = `IR: ${device.remoteType}`;
       accessory.context.model = device.remoteType;
-      accessory.displayName = device.configDeviceName ?? device.deviceName;
+      accessory.displayName = device.configDeviceName
+        ? await this.validateAndCleanDisplayName(device.configDeviceName, 'configDeviceName', device.configDeviceName)
+        : await this.validateAndCleanDisplayName(device.deviceName, 'deviceName', device.deviceName);
+      accessory.context.connectionType = await this.connectionType(device);
       accessory.context.connectionType = device.connectionType;
       accessory.context.version = device.firmware ?? device.version ?? this.version ?? '0.0.0';
       const newOrExternal = !device.external ? 'Adding new' : 'Loading external';
@@ -2710,7 +2907,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
   }
 
   async getPlatformLogSettings() {
-    this.debugMode = process.argv.includes('-D') || process.argv.includes('--debug');
+    this.debugMode = process.argv.includes('-D') ?? process.argv.includes('--debug');
     if (this.config.options?.logging === 'debug' || this.config.options?.logging === 'standard' || this.config.options?.logging === 'none') {
       this.platformLogging = this.config.options.logging;
       await this.debugWarnLog(`Using Config Logging: ${this.platformLogging}`);
@@ -2723,6 +2920,39 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
     }
   }
 
+  /**
+   * Validate and clean a string value for a Name Characteristic.
+ * @param displayName
+ * @param name
+ * @param value
+ * @returns string value
+ */
+  async validateAndCleanDisplayName(displayName: string, name: string, value: string): Promise<string> {
+    const validPattern = /^[a-zA-Z0-9][a-zA-Z0-9 ']*[a-zA-Z0-9]$/;
+    const invalidCharsPattern = /[^a-zA-Z0-9 ']/g;
+    const invalidStartEndPattern = /^[^a-zA-Z0-9]+|[^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
+      if (invalidCharsPattern.test(value)) {
+        this.warnLog(`Removing invalid characters from '${name}' characteristic`);
+        value = value.replace(invalidCharsPattern, '');
+      }
+
+      // Ensure it starts and ends with an alphanumeric character
+      if (invalidStartEndPattern.test(value)) {
+        this.warnLog(`Removing invalid starting or ending characters from '${name}' characteristic`);
+        value = value.replace(invalidStartEndPattern, '');
+      }
+    }
+
+    return value;
+  }
+
   /**
    * If device level logging is turned on, log to log.warn
    * Otherwise send debug logs to log.debug
@@ -2741,7 +2971,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
 
   async debugSuccessLog(...log: any[]): Promise<void> {
     if (await this.enablingPlatformLogging()) {
-      if (this.platformLogging?.includes('debug')) {
+      if (await this.loggingIsDebug()) {
         this.log.success('[DEBUG]', String(...log));
       }
     }
@@ -2755,7 +2985,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
 
   async debugWarnLog(...log: any[]): Promise<void> {
     if (await this.enablingPlatformLogging()) {
-      if (this.platformLogging?.includes('debug')) {
+      if (await this.loggingIsDebug()) {
         this.log.warn('[DEBUG]', String(...log));
       }
     }
@@ -2769,7 +2999,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
 
   async debugErrorLog(...log: any[]): Promise<void> {
     if (await this.enablingPlatformLogging()) {
-      if (this.platformLogging?.includes('debug')) {
+      if (await this.loggingIsDebug()) {
         this.log.error('[DEBUG]', String(...log));
       }
     }
@@ -2777,15 +3007,19 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
 
   async debugLog(...log: any[]): Promise<void> {
     if (await this.enablingPlatformLogging()) {
-      if (this.platformLogging === 'debugMode') {
-        this.log.debug(String(...log));
-      } else if (this.platformLogging === 'debug') {
+      if (this.platformLogging === 'debug') {
         this.log.info('[DEBUG]', String(...log));
+      } else if (this.platformLogging === 'debugMode') {
+        this.log.debug(String(...log));
       }
     }
   }
 
+  async loggingIsDebug(): Promise<boolean> {
+    return this.platformLogging === 'debugMode' || this.platformLogging === 'debug';
+  }
+
   async enablingPlatformLogging(): Promise<boolean> {
-    return this.platformLogging?.includes('debug') || this.platformLogging === 'standard';
+    return this.platformLogging === 'debugMode' || this.platformLogging === 'debug' || this.platformLogging === 'standard';
   }
 }