@switchbot/homebridge-switchbot 3.7.1-beta.3 → 3.7.1-beta.5

package/src/device/lock.ts

@@ -3,6 +3,10 @@
  * lock.ts: @switchbot/homebridge-switchbot.
  */
 import { deviceBase } from './device.js';
+/*
+* For Testing Locally:
+* import { SwitchBotBLEModel, SwitchBotBLEModelName } from '/Users/Shared/GitHub/OpenWonderLabs/node-switchbot/dist/index.js';
+*/
 import { SwitchBotBLEModel, SwitchBotBLEModelName } from 'node-switchbot';
 import { Subject, debounceTime, interval, skipWhile, take, tap } from 'rxjs';
 
@@ -165,16 +169,28 @@ export class Lock extends deviceBase {
     }
 
     // Retrieve initial values and updateHomekit
-    this.debugLog('Retrieve initial values and update Homekit');
-    this.refreshStatus();
+    try {
+      this.debugLog('Retrieve initial values and update Homekit');
+      this.refreshStatus();
+    } catch (e: any) {
+      this.errorLog(`failed to retrieve initial values and update Homekit, Error: ${e}`);
+    }
 
     //regisiter webhook event handler if enabled
-    this.debugLog('Registering Webhook Event Handler');
-    this.registerWebhook();
+    try {
+      this.debugLog('Registering Webhook Event Handler');
+      this.registerWebhook();
+    } catch (e: any) {
+      this.errorLog(`failed to registerWebhook, Error: ${e}`);
+    }
 
     //regisiter platform BLE event handler if enabled
-    this.debugLog('Registering Platform BLE Event Handler');
-    this.registerPlatformBLE();
+    try {
+      this.debugLog('Registering Platform BLE Event Handler');
+      this.registerPlatformBLE();
+    } catch (e: any) {
+      this.errorLog(`failed to registerPlatformBLE, Error: ${e}`);
+    }
 
     // Start an update interval
     interval(this.deviceRefreshRate * 1000)

package/src/device/meter.ts

@@ -6,6 +6,10 @@ import { Units } from 'homebridge';
 import { deviceBase } from './device.js';
 import { Subject, interval, skipWhile } from 'rxjs';
 import { convertUnits, validHumidity } from '../utils.js';
+/*
+* For Testing Locally:
+* import { SwitchBotBLEModel, SwitchBotBLEModelName } from '/Users/Shared/GitHub/OpenWonderLabs/node-switchbot/dist/index.js';
+*/
 import { SwitchBotBLEModel, SwitchBotBLEModelName } from 'node-switchbot';
 
 import type { devicesConfig } from '../settings.js';
@@ -148,16 +152,28 @@ export class Meter extends deviceBase {
     }
 
     // Retrieve initial values and updateHomekit
-    this.debugLog('Retrieve initial values and update Homekit');
-    this.refreshStatus();
+    try {
+      this.debugLog('Retrieve initial values and update Homekit');
+      this.refreshStatus();
+    } catch (e: any) {
+      this.errorLog(`failed to retrieve initial values and update Homekit, Error: ${e}`);
+    }
 
     //regisiter webhook event handler if enabled
-    this.debugLog('Registering Webhook Event Handler');
-    this.registerWebhook();
+    try {
+      this.debugLog('Registering Webhook Event Handler');
+      this.registerWebhook();
+    } catch (e: any) {
+      this.errorLog(`failed to registerWebhook, Error: ${e}`);
+    }
 
     //regisiter platform BLE event handler if enabled
-    this.debugLog('Registering Platform BLE Event Handler');
-    this.registerPlatformBLE();
+    try {
+      this.debugLog('Registering Platform BLE Event Handler');
+      this.registerPlatformBLE();
+    } catch (e: any) {
+      this.errorLog(`failed to registerPlatformBLE, Error: ${e}`);
+    }
 
     // Start an update interval
     interval(this.deviceRefreshRate * 1000)

package/src/device/meterplus.ts

@@ -6,6 +6,10 @@ import { Units } from 'homebridge';
 import { deviceBase } from './device.js';
 import { Subject, interval, skipWhile } from 'rxjs';
 import { convertUnits, validHumidity } from '../utils.js';
+/*
+* For Testing Locally:
+* import { SwitchBotBLEModel, SwitchBotBLEModelName } from '/Users/Shared/GitHub/OpenWonderLabs/node-switchbot/dist/index.js';
+*/
 import { SwitchBotBLEModel, SwitchBotBLEModelName } from 'node-switchbot';
 
 import type { devicesConfig } from '../settings.js';
@@ -153,16 +157,28 @@ export class MeterPlus extends deviceBase {
     }
 
     // Retrieve initial values and updateHomekit
-    this.debugLog('Retrieve initial values and update Homekit');
-    this.refreshStatus();
+    try {
+      this.debugLog('Retrieve initial values and update Homekit');
+      this.refreshStatus();
+    } catch (e: any) {
+      this.errorLog(`failed to retrieve initial values and update Homekit, Error: ${e}`);
+    }
 
     //regisiter webhook event handler if enabled
-    this.debugLog('Registering Webhook Event Handler');
-    this.registerWebhook();
+    try {
+      this.debugLog('Registering Webhook Event Handler');
+      this.registerWebhook();
+    } catch (e: any) {
+      this.errorLog(`failed to registerWebhook, Error: ${e}`);
+    }
 
     //regisiter platform BLE event handler if enabled
-    this.debugLog('Registering Platform BLE Event Handler');
-    this.registerPlatformBLE();
+    try {
+      this.debugLog('Registering Platform BLE Event Handler');
+      this.registerPlatformBLE();
+    } catch (e: any) {
+      this.errorLog(`failed to registerPlatformBLE, Error: ${e}`);
+    }
 
     // Start an update interval
     interval(this.deviceRefreshRate * 1000)

package/src/device/motion.ts

@@ -5,6 +5,10 @@
  */
 import { deviceBase } from './device.js';
 import { Subject, interval, skipWhile } from 'rxjs';
+/*
+* For Testing Locally:
+* import { SwitchBotBLEModel, SwitchBotBLEModelName } from '/Users/Shared/GitHub/OpenWonderLabs/node-switchbot/dist/index.js';
+*/
 import { SwitchBotBLEModel, SwitchBotBLEModelName } from 'node-switchbot';
 
 import type { devicesConfig } from '../settings.js';
@@ -138,16 +142,28 @@ export class Motion extends deviceBase {
     };
 
     // Retrieve initial values and updateHomekit
-    this.debugLog('Retrieve initial values and update Homekit');
-    this.refreshStatus();
+    try {
+      this.debugLog('Retrieve initial values and update Homekit');
+      this.refreshStatus();
+    } catch (e: any) {
+      this.errorLog(`failed to retrieve initial values and update Homekit, Error: ${e}`);
+    }
 
     //regisiter webhook event handler if enabled
-    this.debugLog('Registering Webhook Event Handler');
-    this.registerWebhook();
+    try {
+      this.debugLog('Registering Webhook Event Handler');
+      this.registerWebhook();
+    } catch (e: any) {
+      this.errorLog(`failed to registerWebhook, Error: ${e}`);
+    }
 
     //regisiter platform BLE event handler if enabled
-    this.debugLog('Registering Platform BLE Event Handler');
-    this.registerPlatformBLE();
+    try {
+      this.debugLog('Registering Platform BLE Event Handler');
+      this.registerPlatformBLE();
+    } catch (e: any) {
+      this.errorLog(`failed to registerPlatformBLE, Error: ${e}`);
+    }
 
     // Start an update interval
     interval(this.deviceRefreshRate * 1000)

package/src/device/plug.ts

@@ -3,6 +3,10 @@
  * plug.ts: @switchbot/homebridge-switchbot.
  */
 import { deviceBase } from './device.js';
+/*
+* For Testing Locally:
+* import { SwitchBotBLEModel, SwitchBotBLEModelName } from '/Users/Shared/GitHub/OpenWonderLabs/node-switchbot/dist/index.js';
+*/
 import { SwitchBotBLEModel, SwitchBotBLEModelName } from 'node-switchbot';
 import { Subject, debounceTime, interval, skipWhile, take, tap } from 'rxjs';
 
@@ -66,16 +70,28 @@ export class Plug extends deviceBase {
       .onSet(this.OnSet.bind(this));
 
     // Retrieve initial values and updateHomekit
-    this.debugLog('Retrieve initial values and update Homekit');
-    this.refreshStatus();
+    try {
+      this.debugLog('Retrieve initial values and update Homekit');
+      this.refreshStatus();
+    } catch (e: any) {
+      this.errorLog(`failed to retrieve initial values and update Homekit, Error: ${e}`);
+    }
 
     //regisiter webhook event handler if enabled
-    this.debugLog('Registering Webhook Event Handler');
-    this.registerWebhook();
+    try {
+      this.debugLog('Registering Webhook Event Handler');
+      this.registerWebhook();
+    } catch (e: any) {
+      this.errorLog(`failed to registerWebhook, Error: ${e}`);
+    }
 
     //regisiter platform BLE event handler if enabled
-    this.debugLog('Registering Platform BLE Event Handler');
-    this.registerPlatformBLE();
+    try {
+      this.debugLog('Registering Platform BLE Event Handler');
+      this.registerPlatformBLE();
+    } catch (e: any) {
+      this.errorLog(`failed to registerPlatformBLE, Error: ${e}`);
+    }
 
     // Start an update interval
     interval(this.deviceRefreshRate * 1000)

package/src/device/robotvacuumcleaner.ts

@@ -3,6 +3,10 @@
  * robotvacuumcleaner.ts: @switchbot/homebridge-switchbot.
  */
 import { deviceBase } from './device.js';
+/*
+* For Testing Locally:
+* import { SwitchBotBLEModel, SwitchBotBLEModelName } from '/Users/Shared/GitHub/OpenWonderLabs/node-switchbot/dist/index.js';
+*/
 import { SwitchBotBLEModel, SwitchBotBLEModelName } from 'node-switchbot';
 import { Subject, debounceTime, interval, skipWhile, take, tap } from 'rxjs';
 
@@ -127,16 +131,28 @@ export class RobotVacuumCleaner extends deviceBase {
       });
 
     // Retrieve initial values and updateHomekit
-    this.debugLog('Retrieve initial values and update Homekit');
-    this.refreshStatus();
+    try {
+      this.debugLog('Retrieve initial values and update Homekit');
+      this.refreshStatus();
+    } catch (e: any) {
+      this.errorLog(`failed to retrieve initial values and update Homekit, Error: ${e}`);
+    }
 
     //regisiter webhook event handler if enabled
-    this.debugLog('Registering Webhook Event Handler');
-    this.registerWebhook();
+    try {
+      this.debugLog('Registering Webhook Event Handler');
+      this.registerWebhook();
+    } catch (e: any) {
+      this.errorLog(`failed to registerWebhook, Error: ${e}`);
+    }
 
     //regisiter platform BLE event handler if enabled
-    this.debugLog('Registering Platform BLE Event Handler');
-    this.registerPlatformBLE();
+    try {
+      this.debugLog('Registering Platform BLE Event Handler');
+      this.registerPlatformBLE();
+    } catch (e: any) {
+      this.errorLog(`failed to registerPlatformBLE, Error: ${e}`);
+    }
 
     // Start an update interval
     interval(this.deviceRefreshRate * 1000)

package/src/device/waterdetector.ts

@@ -4,6 +4,10 @@
  */
 import { deviceBase } from './device.js';
 import { Subject, interval, skipWhile } from 'rxjs';
+/*
+* For Testing Locally:
+* import { SwitchBotBLEModel, SwitchBotBLEModelName } from '/Users/Shared/GitHub/OpenWonderLabs/node-switchbot/dist/index.js';
+*/
 import { SwitchBotBLEModel, SwitchBotBLEModelName } from 'node-switchbot';
 
 import type { devicesConfig } from '../settings.js';
@@ -118,16 +122,28 @@ export class WaterDetector extends deviceBase {
     }
 
     // Retrieve initial values and updateHomekit
-    this.debugLog('Retrieve initial values and update Homekit');
-    this.refreshStatus();
+    try {
+      this.debugLog('Retrieve initial values and update Homekit');
+      this.refreshStatus();
+    } catch (e: any) {
+      this.errorLog(`failed to retrieve initial values and update Homekit, Error: ${e}`);
+    }
 
     //regisiter webhook event handler if enabled
-    this.debugLog('Registering Webhook Event Handler');
-    this.registerWebhook();
+    try {
+      this.debugLog('Registering Webhook Event Handler');
+      this.registerWebhook();
+    } catch (e: any) {
+      this.errorLog(`failed to registerWebhook, Error: ${e}`);
+    }
 
     //regisiter platform BLE event handler if enabled
-    this.debugLog('Registering Platform BLE Event Handler');
-    this.registerPlatformBLE();
+    try {
+      this.debugLog('Registering Platform BLE Event Handler');
+      this.registerPlatformBLE();
+    } catch (e: any) {
+      this.errorLog(`failed to registerPlatformBLE, Error: ${e}`);
+    }
 
     // Start an update interval
     interval(this.deviceRefreshRate * 1000)

package/src/platform.ts

@@ -51,6 +51,10 @@ import type { blindTilt, curtain, curtain3, device } from './types/devicelist.js
 import type { API, DynamicPlatformPlugin, Logging, PlatformAccessory } from 'homebridge';
 import type { SwitchBotPlatformConfig, devicesConfig, irDevicesConfig } from './settings.js';
 import type { IncomingMessage, Server, ServerResponse } from 'http';
+/*
+* For Testing Locally:
+* import { SwitchBotModel } from '/Users/Shared/GitHub/OpenWonderLabs/node-switchbot/dist/index.js';
+*/
 import { SwitchBotModel } from 'node-switchbot';
 
 /**
@@ -147,9 +151,21 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       }
     });
 
-    this.setupMqtt();
-    this.setupwebhook();
-    this.setupBlE();
+    try {
+      this.setupMqtt();
+    } catch (e: any) {
+      this.errorLog(`Setup MQTT, Error Message: ${e.message}, Submit Bugs Here: ` + 'https://tinyurl.com/SwitchBotBug');
+    }
+    try {
+      this.setupwebhook();
+    } catch (e: any) {
+      this.errorLog(`Setup Webhook, Error Message: ${e.message}, Submit Bugs Here: ` + 'https://tinyurl.com/SwitchBotBug');
+    }
+    try {
+      this.setupBlE();
+    } catch (e: any) {
+      this.errorLog(`Setup Platform BLE, Error Message: ${e.message}, Submit Bugs Here: ` + 'https://tinyurl.com/SwitchBotBug');
+    }
   }
 
   async setupMqtt(): Promise<void> {
@@ -2928,29 +2944,33 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
  * @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 (this.config.options?.allowInvalidCharacter) {
+      return value;
+    } else {
+      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,`
+      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, '');
-      }
+        // 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, '');
+        // 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;
+      return value;
+    }
   }
 
   /**

package/src/settings.ts

@@ -58,6 +58,7 @@ interface credentials {
 interface options {
   devices?: devicesConfig[];
   irdevices?: irDevicesConfig[];
+  allowInvalidCharacter?: boolean;
   mqttURL?: string;
   mqttOptions?: IClientOptions;
   mqttPubOptions?: IClientOptions;