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

package/dist/platform.js

@@ -81,8 +81,8 @@ export class SwitchBotPlatform {
             options: config.options,
         };
         // Plugin Configuration
-        this.getPlatformConfigSettings();
         this.getPlatformLogSettings();
+        this.getPlatformConfigSettings();
         this.getVersion();
         // Finish initializing the platform
         this.debugLog(`Finished initializing platform: ${config.name}`);
@@ -316,6 +316,15 @@ export class SwitchBotPlatform {
                         }
                     };
                 })();
+                this.api.on('shutdown', async () => {
+                    try {
+                        switchbot.stopScan();
+                        this.infoLog('Stopped BLE scanning to close listening.');
+                    }
+                    catch (e) {
+                        this.errorLog(`Failed to stop Platform BLE scanning. Error:${e.message}`);
+                    }
+                });
             }
         }
         else {
@@ -825,7 +834,9 @@ export class SwitchBotPlatform {
                 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}`);
@@ -841,14 +852,18 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -878,7 +893,9 @@ export class SwitchBotPlatform {
                 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}`);
@@ -894,14 +911,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -932,7 +954,9 @@ export class SwitchBotPlatform {
                 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}`);
@@ -948,14 +972,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -986,7 +1015,9 @@ export class SwitchBotPlatform {
                 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}`);
@@ -1002,14 +1033,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -1040,7 +1076,9 @@ export class SwitchBotPlatform {
                 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}`);
@@ -1056,14 +1094,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -1093,7 +1136,9 @@ export class SwitchBotPlatform {
                 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}`);
@@ -1109,14 +1154,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -1146,7 +1196,9 @@ export class SwitchBotPlatform {
                 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}`);
@@ -1162,14 +1214,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -1199,7 +1256,9 @@ export class SwitchBotPlatform {
                 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}`);
@@ -1215,14 +1274,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -1252,7 +1316,9 @@ export class SwitchBotPlatform {
                 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}`);
@@ -1268,14 +1334,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -1305,7 +1376,9 @@ export class SwitchBotPlatform {
                 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}`);
@@ -1335,7 +1408,9 @@ export class SwitchBotPlatform {
                 }
             }
             // 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
             accessory.context.device = device;
@@ -1343,7 +1418,10 @@ export class SwitchBotPlatform {
             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';
@@ -1373,7 +1451,9 @@ export class SwitchBotPlatform {
                 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}`);
@@ -1403,14 +1483,19 @@ export class SwitchBotPlatform {
                 }
             }
             // 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
             accessory.context.device = device;
             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';
@@ -1441,7 +1526,9 @@ export class SwitchBotPlatform {
                 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}`);
@@ -1457,7 +1544,9 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
@@ -1465,7 +1554,10 @@ export class SwitchBotPlatform {
             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';
@@ -1495,7 +1587,9 @@ export class SwitchBotPlatform {
                 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}`);
@@ -1511,14 +1605,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -1548,7 +1647,9 @@ export class SwitchBotPlatform {
                 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}`);
@@ -1564,14 +1665,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -1601,7 +1707,9 @@ export class SwitchBotPlatform {
                 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}`);
@@ -1617,14 +1725,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -1654,7 +1767,9 @@ export class SwitchBotPlatform {
                 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}`);
@@ -1670,14 +1785,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -1707,7 +1827,9 @@ export class SwitchBotPlatform {
                 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}`);
@@ -1723,14 +1845,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -1764,7 +1891,9 @@ export class SwitchBotPlatform {
                         : 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}`);
@@ -1780,7 +1909,9 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
@@ -1791,7 +1922,10 @@ export class SwitchBotPlatform {
                     : 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';
@@ -1819,7 +1953,9 @@ export class SwitchBotPlatform {
             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]);
@@ -1830,14 +1966,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -1866,7 +2007,9 @@ export class SwitchBotPlatform {
                 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]);
@@ -1881,14 +2024,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -1918,7 +2066,9 @@ export class SwitchBotPlatform {
                 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]);
@@ -1933,14 +2083,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -1970,7 +2125,9 @@ export class SwitchBotPlatform {
                 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]);
@@ -1985,14 +2142,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -2022,7 +2184,9 @@ export class SwitchBotPlatform {
                 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]);
@@ -2037,14 +2201,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -2074,7 +2243,9 @@ export class SwitchBotPlatform {
                 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]);
@@ -2089,14 +2260,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -2126,7 +2302,9 @@ export class SwitchBotPlatform {
                 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]);
@@ -2141,14 +2319,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -2178,7 +2361,9 @@ export class SwitchBotPlatform {
                 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]);
@@ -2193,14 +2378,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -2230,7 +2420,9 @@ export class SwitchBotPlatform {
                 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]);
@@ -2245,14 +2437,19 @@ export class SwitchBotPlatform {
         }
         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
             accessory.context.device = device;
             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';
@@ -2615,7 +2812,7 @@ export class SwitchBotPlatform {
         }
     }
     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}`);
@@ -2629,6 +2826,34 @@ export class SwitchBotPlatform {
             await this.debugWarnLog(`Using ${this.platformLogging} Logging`);
         }
     }
+    /**
+     * Validate and clean a string value for a Name Characteristic.
+   * @param displayName
+   * @param name
+   * @param value
+   * @returns string value
+   */
+    async validateAndCleanDisplayName(displayName, name, value) {
+        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
@@ -2645,7 +2870,7 @@ export class SwitchBotPlatform {
     }
     async debugSuccessLog(...log) {
         if (await this.enablingPlatformLogging()) {
-            if (this.platformLogging?.includes('debug')) {
+            if (await this.loggingIsDebug()) {
                 this.log.success('[DEBUG]', String(...log));
             }
         }
@@ -2657,7 +2882,7 @@ export class SwitchBotPlatform {
     }
     async debugWarnLog(...log) {
         if (await this.enablingPlatformLogging()) {
-            if (this.platformLogging?.includes('debug')) {
+            if (await this.loggingIsDebug()) {
                 this.log.warn('[DEBUG]', String(...log));
             }
         }
@@ -2669,23 +2894,26 @@ export class SwitchBotPlatform {
     }
     async debugErrorLog(...log) {
         if (await this.enablingPlatformLogging()) {
-            if (this.platformLogging?.includes('debug')) {
+            if (await this.loggingIsDebug()) {
                 this.log.error('[DEBUG]', String(...log));
             }
         }
     }
     async debugLog(...log) {
         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() {
+        return this.platformLogging === 'debugMode' || this.platformLogging === 'debug';
+    }
     async enablingPlatformLogging() {
-        return this.platformLogging?.includes('debug') || this.platformLogging === 'standard';
+        return this.platformLogging === 'debugMode' || this.platformLogging === 'debug' || this.platformLogging === 'standard';
     }
 }
 //# sourceMappingURL=platform.js.map