@switchbot/homebridge-switchbot 3.6.1-beta.9 → 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
@@ -880,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}`);
@@ -894,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
@@ -902,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';
@@ -935,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}`);
@@ -949,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
@@ -957,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';
@@ -991,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}`);
@@ -1005,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
@@ -1013,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';
@@ -1047,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}`);
@@ -1061,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
@@ -1069,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';
@@ -1103,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}`);
@@ -1117,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
@@ -1125,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';
@@ -1158,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}`);
@@ -1172,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
@@ -1180,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';
@@ -1213,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}`);
@@ -1227,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
@@ -1235,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';
@@ -1268,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}`);
@@ -1282,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
@@ -1290,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';
@@ -1323,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}`);
@@ -1337,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
@@ -1345,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';
@@ -1378,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}`);
@@ -1406,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
@@ -1414,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';
@@ -1447,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}`);
@@ -1475,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
@@ -1483,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';
@@ -1517,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}`);
@@ -1531,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
@@ -1540,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';
@@ -1573,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}`);
@@ -1587,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
@@ -1595,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';
@@ -1628,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}`);
@@ -1642,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
@@ -1650,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';
@@ -1683,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}`);
@@ -1697,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
@@ -1705,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';
@@ -1738,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}`);
@@ -1752,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
@@ -1760,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';
@@ -1793,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}`);
@@ -1807,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
@@ -1815,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';
@@ -1852,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}`);
@@ -1866,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
@@ -1878,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';
@@ -1909,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]);
@@ -1919,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
@@ -1927,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';
@@ -1959,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]);
@@ -1972,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
@@ -1980,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';
@@ -2013,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]);
@@ -2026,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
@@ -2034,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';
@@ -2067,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]);
@@ -2080,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
@@ -2088,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';
@@ -2121,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]);
@@ -2134,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
@@ -2142,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';
@@ -2175,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]);
@@ -2188,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
@@ -2196,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';
@@ -2229,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]);
@@ -2242,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
@@ -2250,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';
@@ -2283,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]);
@@ -2296,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
@@ -2304,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';
@@ -2337,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]);
@@ -2350,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
@@ -2358,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';
@@ -2719,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}`);
@@ -2732,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
@@ -2750,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));
       }
     }
@@ -2764,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));
       }
     }
@@ -2778,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));
       }
     }
@@ -2786,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';
   }
 }