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

package/src/device/ceilinglight.ts

@@ -42,8 +42,9 @@ export class CeilingLight extends deviceBase {
   serviceData!: ceilingLightServiceData | ceilingLightProServiceData;
 
   // Adaptive Lighting
+  adaptiveLighting!: boolean;
+  adaptiveLightingShift!: number;
   AdaptiveLightingController?: ControllerConstructor | Controller<ControllerServiceMap>;
-  adaptiveLightingShift?: number;
 
   // Updates
   ceilingLightUpdateInProgress!: boolean;
@@ -59,7 +60,7 @@ export class CeilingLight extends deviceBase {
     accessory.category = this.hap.Categories.LIGHTBULB;
 
     // default placeholders
-    this.adaptiveLighting(device);
+    this.getAdaptiveLightingSettings(accessory, device);
 
     // this is subject we use to track when we need to POST changes to the SwitchBot API
     this.doCeilingLightUpdate = new Subject();
@@ -78,23 +79,24 @@ export class CeilingLight extends deviceBase {
     };
     accessory.context.LightBulb = this.LightBulb as object;
 
-    // Adaptive Lighting
-    if (this.adaptiveLightingShift === -1 && accessory.context.adaptiveLighting) {
+    if (this.adaptiveLighting && this.adaptiveLightingShift === -1 && this.LightBulb) {
       accessory.removeService(this.LightBulb.Service);
       this.LightBulb.Service = accessory.addService(this.hap.Service.Lightbulb);
       accessory.context.adaptiveLighting = false;
-      this.debugLog(`adaptiveLighting: ${accessory.context.adaptiveLighting}`);
-    }
-    if (this.adaptiveLightingShift !== -1) {
+      this.debugLog(`adaptiveLighting: ${this.adaptiveLighting}`);
+    } else if (this.adaptiveLighting && this.adaptiveLightingShift >= 0 && this.LightBulb) {
       this.AdaptiveLightingController = new platform.api.hap.AdaptiveLightingController(this.LightBulb.Service, {
+        controllerMode: this.hap.AdaptiveLightingControllerMode.AUTOMATIC,
         customTemperatureAdjustment: this.adaptiveLightingShift,
       });
-      this.accessory.configureController(this.AdaptiveLightingController);
-      this.accessory.context.adaptiveLighting = true;
-      this.debugLog(`adaptiveLighting: ${this.accessory.context.adaptiveLighting},`
-        + ` adaptiveLightingShift: ${this.adaptiveLightingShift}`);
+      accessory.configureController(this.AdaptiveLightingController);
+      accessory.context.adaptiveLighting = true;
+      this.debugLog(`adaptiveLighting: ${this.adaptiveLighting}, adaptiveLightingShift: ${this.adaptiveLightingShift}`,
+      );
+    } else {
+      accessory.context.adaptiveLighting = false;
+      this.debugLog(`adaptiveLighting: ${accessory.context.adaptiveLighting}`);
     }
-    this.debugLog(`adaptiveLightingShift: ${this.adaptiveLightingShift}`);
 
     // Initialize LightBulb Characteristics
     this.LightBulb.Service
@@ -700,13 +702,18 @@ export class CeilingLight extends deviceBase {
       this.LightBulb.Saturation, 'Saturation');
   }
 
-  async adaptiveLighting(device: device & devicesConfig): Promise<void> {
+  async getAdaptiveLightingSettings(accessory: PlatformAccessory, device: device & devicesConfig): Promise<void> {
+    // Adaptive Lighting
+    this.adaptiveLighting = accessory.context.adaptiveLighting ?? true;
+    await this.debugLog(`adaptiveLighting: ${this.adaptiveLighting}`);
+    // Adaptive Lighting Shift
     if (device.ceilinglight?.adaptiveLightingShift) {
       this.adaptiveLightingShift = device.ceilinglight.adaptiveLightingShift;
+      this.debugLog(`adaptiveLightingShift: ${this.adaptiveLightingShift}`);
     } else {
       this.adaptiveLightingShift = 0;
+      this.debugLog(`adaptiveLightingShift: ${this.adaptiveLightingShift}`);
     }
-    await this.debugLog(`adaptiveLightingShift: ${this.adaptiveLightingShift}`);
   }
 
   async BLEPushConnection() {

package/src/device/colorbulb.ts

@@ -3,7 +3,7 @@
  * blindtilt.ts: @switchbot/homebridge-switchbot.
  */
 import { deviceBase } from './device.js';
-import { hs2rgb, rgb2hs, m2hs, checkName } from '../utils.js';
+import { hs2rgb, rgb2hs, m2hs } from '../utils.js';
 import { SwitchBotBLEModel, SwitchBotBLEModelName } from 'node-switchbot';
 import { Subject, debounceTime, interval, skipWhile, take, tap } from 'rxjs';
 
@@ -42,8 +42,9 @@ export class ColorBulb extends deviceBase {
   serviceData!: colorBulbServiceData;
 
   // Adaptive Lighting
+  adaptiveLighting!: boolean;
+  adaptiveLightingShift!: number;
   AdaptiveLightingController?: ControllerConstructor | Controller<ControllerServiceMap>;
-  adaptiveLightingShift?: number;
 
   // Updates
   colorBulbUpdateInProgress!: boolean;
@@ -59,13 +60,12 @@ export class ColorBulb extends deviceBase {
     accessory.category = this.hap.Categories.LIGHTBULB;
 
     // default placeholders
-    this.adaptiveLighting(device);
+    this.getAdaptiveLightingSettings(accessory, device);
 
     // this is subject we use to track when we need to POST changes to the SwitchBot API
     this.doColorBulbUpdate = new Subject();
     this.colorBulbUpdateInProgress = false;
 
-
     // Initialize LightBulb property
     accessory.context.LightBulb = accessory.context.LightBulb ?? {};
     this.LightBulb = {
@@ -79,30 +79,24 @@ export class ColorBulb extends deviceBase {
     };
     accessory.context.LightBulb = this.LightBulb as object;
 
-    const check = checkName(accessory.context.LightBulb.Name, 'Name', accessory.context.LightBulb.Name);
-    if (check !== 'false') {
-      accessory.context.LightBulb.Name = device.deviceName ?? accessory.displayName;
-    } else {
-      this.warnLog(check);
-    }
-
-    // Adaptive Lighting
-    if (this.adaptiveLightingShift === -1 && accessory.context.adaptiveLighting) {
+    if (this.adaptiveLighting && this.adaptiveLightingShift === -1 && this.LightBulb) {
       accessory.removeService(this.LightBulb.Service);
       this.LightBulb.Service = accessory.addService(this.hap.Service.Lightbulb);
       accessory.context.adaptiveLighting = false;
-      this.debugLog(`adaptiveLighting: ${accessory.context.adaptiveLighting}`);
-    }
-    if (this.adaptiveLightingShift !== -1) {
+      this.debugLog(`adaptiveLighting: ${this.adaptiveLighting}`);
+    } else if (this.adaptiveLighting && this.adaptiveLightingShift >= 0 && this.LightBulb) {
       this.AdaptiveLightingController = new platform.api.hap.AdaptiveLightingController(this.LightBulb.Service, {
+        controllerMode: this.hap.AdaptiveLightingControllerMode.AUTOMATIC,
         customTemperatureAdjustment: this.adaptiveLightingShift,
       });
       accessory.configureController(this.AdaptiveLightingController);
       accessory.context.adaptiveLighting = true;
-      this.debugLog(`adaptiveLighting: ${accessory.context.adaptiveLighting},`
-        + ` adaptiveLightingShift: ${this.adaptiveLightingShift}`);
+      this.debugLog(`adaptiveLighting: ${this.adaptiveLighting}, adaptiveLightingShift: ${this.adaptiveLightingShift}`,
+      );
+    } else {
+      accessory.context.adaptiveLighting = false;
+      this.debugLog(`adaptiveLighting: ${accessory.context.adaptiveLighting}`);
     }
-    this.debugLog(`adaptiveLightingShift: ${this.adaptiveLightingShift}`);
 
     // Initialize LightBulb Characteristics
     this.LightBulb.Service
@@ -841,13 +835,18 @@ export class ColorBulb extends deviceBase {
       this.LightBulb.Saturation, 'Saturation');
   }
 
-  async adaptiveLighting(device: device & devicesConfig): Promise<void> {
+  async getAdaptiveLightingSettings(accessory: PlatformAccessory, device: device & devicesConfig): Promise<void> {
+    // Adaptive Lighting
+    this.adaptiveLighting = accessory.context.adaptiveLighting ?? true;
+    await this.debugLog(`adaptiveLighting: ${this.adaptiveLighting}`);
+    // Adaptive Lighting Shift
     if (device.colorbulb?.adaptiveLightingShift) {
       this.adaptiveLightingShift = device.colorbulb.adaptiveLightingShift;
+      this.debugLog(`adaptiveLightingShift: ${this.adaptiveLightingShift}`);
     } else {
       this.adaptiveLightingShift = 0;
+      this.debugLog(`adaptiveLightingShift: ${this.adaptiveLightingShift}`);
     }
-    await this.debugLog(`adaptiveLightingShift: ${this.adaptiveLightingShift}`);
   }
 
   async BLEPushConnection() {

package/src/device/device.ts

@@ -79,13 +79,20 @@ export abstract class deviceBase {
       .getService(this.hap.Service.AccessoryInformation)!
       .setCharacteristic(this.hap.Characteristic.Manufacturer, 'SwitchBot')
       .setCharacteristic(this.hap.Characteristic.AppMatchingIdentifier, 'id1087374760')
-      .setCharacteristic(this.hap.Characteristic.Name, device.configDeviceName ?? device.deviceName ?? accessory.displayName)
-      .setCharacteristic(this.hap.Characteristic.ConfiguredName, device.configDeviceName ?? device.deviceName ?? accessory.displayName)
+      .setCharacteristic(this.hap.Characteristic.Name, this.validName(accessory, device))
+      .setCharacteristic(this.hap.Characteristic.ConfiguredName, this.validName(accessory, device))
       .setCharacteristic(this.hap.Characteristic.Model, device.model ?? accessory.context.model)
       .setCharacteristic(this.hap.Characteristic.ProductData, device.deviceId ?? accessory.context.deviceId)
       .setCharacteristic(this.hap.Characteristic.SerialNumber, device.deviceId);
   }
 
+  public validName(accessory: PlatformAccessory, device: device & devicesConfig) {
+    const Name = device.configDeviceName ?? device.deviceName ?? accessory.displayName;
+    const NameOfName = device.configDeviceName ? 'configDeviceName' : device.deviceName ? 'deviceName' : 'displayName';
+    const validName = this.validateAndCleanString(Name, NameOfName, Name);
+    return validName;
+  }
+
   async getDeviceLogSettings(accessory: PlatformAccessory, device: device & devicesConfig): Promise<void> {
     this.deviceLogging = this.platform.debugMode ? 'debugMode' : device.logging ?? this.config.logging ?? 'standard';
     const logging = this.platform.debugMode ? 'Debug Mode' : device.logging ? 'Device Config' : this.config.logging ? 'Platform Config' : 'Default';
@@ -765,6 +772,32 @@ export abstract class deviceBase {
     }
   }
 
+  /**
+   * Validate and clean a string value for a Name Characteristic.
+ * @param displayName
+ * @param name
+ * @param value
+ * @returns string value
+ */
+  validateAndCleanString(displayName: string, name: string, value: string): string {
+    const validPattern = /^[a-zA-Z0-9][a-zA-Z0-9 ']*[a-zA-Z0-9]$/;
+    const invalidCharsPattern = /[^a-zA-Z0-9 ']/g;
+
+    if (!validPattern.test(value)) {
+      this.warnLog(`WARNING: The accessory '${displayName}' has an invalid '${name}' characteristic ('${value}'). Please use only alphanumeric,`
+              + ' space, and apostrophe characters. Ensure it starts and ends with an alphabetic or numeric character, and avoid emojis. This may'
+              + ' prevent the accessory from being added in the Home App or cause unresponsiveness.');
+
+      // Remove invalid characters
+      value = value.replace(invalidCharsPattern, '');
+
+      // Ensure it starts and ends with an alphanumeric character
+      value = value.replace(/^[^a-zA-Z0-9]+|[^a-zA-Z0-9]+$/g, '');
+    }
+
+    return value;
+  }
+
   /**
    * Logging for Device
    */

package/src/device/hub.ts

@@ -4,8 +4,8 @@
  */
 import { Units } from 'homebridge';
 import { deviceBase } from './device.js';
-import { convertUnits } from '../utils.js';
 import { Subject, interval, skipWhile} from 'rxjs';
+import { validHumidity, convertUnits } from '../utils.js';
 import { SwitchBotBLEModel, SwitchBotBLEModelName } from 'node-switchbot';
 
 import type { devicesConfig } from '../settings.js';
@@ -181,7 +181,7 @@ export class Hub extends deviceBase {
 
     // CurrentRelativeHumidity
     if (!this.device.hub?.hide_humidity && this.HumiditySensor?.Service) {
-      this.HumiditySensor!.CurrentRelativeHumidity = this.serviceData.humidity;
+      this.HumiditySensor!.CurrentRelativeHumidity = validHumidity(this.serviceData.humidity, 0, 100);
       await this.debugLog(`CurrentRelativeHumidity: ${this.HumiditySensor.CurrentRelativeHumidity}%`);
     }
 

package/src/device/iosensor.ts

@@ -4,8 +4,8 @@
  */
 import { Units } from 'homebridge';
 import { deviceBase } from './device.js';
-import { convertUnits } from '../utils.js';
 import { Subject, interval, skipWhile } from 'rxjs';
+import { convertUnits, validHumidity } from '../utils.js';
 import { SwitchBotBLEModel, SwitchBotBLEModelName } from 'node-switchbot';
 
 import type { devicesConfig } from '../settings.js';
@@ -187,7 +187,7 @@ export class IOSensor extends deviceBase {
 
     // CurrentRelativeHumidity
     if (!this.device.iosensor?.hide_humidity && this.HumiditySensor?.Service) {
-      this.HumiditySensor.CurrentRelativeHumidity = this.serviceData.humidity;
+      this.HumiditySensor.CurrentRelativeHumidity = validHumidity(this.serviceData.humidity, 0, 100);
       await this.debugLog(`CurrentRelativeHumidity: ${this.HumiditySensor.CurrentRelativeHumidity}%`);
     }
 

package/src/device/lightstrip.ts

@@ -10,8 +10,8 @@ import { Subject, debounceTime, interval, skipWhile, take, tap } from 'rxjs';
 import type { devicesConfig } from '../settings.js';
 import type { device } from '../types/devicelist.js';
 import type { SwitchBotPlatform } from '../platform.js';
-import type { stripLightServiceData } from '../types/bledevicestatus.js';
 import type { stripLightStatus } from '../types/devicestatus.js';
+import type { stripLightServiceData } from '../types/bledevicestatus.js';
 import type { stripLightWebhookContext } from '../types/devicewebhookstatus.js';
 import type { Service, PlatformAccessory, CharacteristicValue, ControllerConstructor, Controller, ControllerServiceMap } from 'homebridge';
 
@@ -42,8 +42,9 @@ export class StripLight extends deviceBase {
   serviceData!: stripLightServiceData;
 
   // Adaptive Lighting
+  adaptiveLighting!: boolean;
+  adaptiveLightingShift!: number;
   AdaptiveLightingController?: ControllerConstructor | Controller<ControllerServiceMap>;
-  adaptiveLightingShift?: number;
 
   // Updates
   stripLightUpdateInProgress!: boolean;
@@ -59,7 +60,8 @@ export class StripLight extends deviceBase {
     accessory.category = this.hap.Categories.LIGHTBULB;
 
     // Adaptive Lighting
-    this.adaptiveLighting(device);
+    this.getAdaptiveLightingSettings(accessory, device);
+
     // this is subject we use to track when we need to POST changes to the SwitchBot API
     this.doStripLightUpdate = new Subject();
     this.stripLightUpdateInProgress = false;
@@ -77,23 +79,24 @@ export class StripLight extends deviceBase {
     };
     accessory.context.LightBulb = this.LightBulb as object;
 
-    // Adaptive Lighting
-    if (this.adaptiveLightingShift === -1 && this.accessory.context.adaptiveLighting) {
-      this.accessory.removeService(this.LightBulb.Service);
-      this.LightBulb.Service = this.accessory.addService(this.hap.Service.Lightbulb);
-      this.accessory.context.adaptiveLighting = false;
-      this.debugLog(`adaptiveLighting: ${this.accessory.context.adaptiveLighting}`);
-    }
-    if (this.adaptiveLightingShift !== -1) {
+    if (this.adaptiveLighting && this.adaptiveLightingShift === -1 && this.LightBulb) {
+      accessory.removeService(this.LightBulb.Service);
+      this.LightBulb.Service = accessory.addService(this.hap.Service.Lightbulb);
+      accessory.context.adaptiveLighting = false;
+      this.debugLog(`adaptiveLighting: ${this.adaptiveLighting}`);
+    } else if (this.adaptiveLighting && this.adaptiveLightingShift >= 0 && this.LightBulb) {
       this.AdaptiveLightingController = new platform.api.hap.AdaptiveLightingController(this.LightBulb.Service, {
+        controllerMode: this.hap.AdaptiveLightingControllerMode.AUTOMATIC,
         customTemperatureAdjustment: this.adaptiveLightingShift,
       });
-      this.accessory.configureController(this.AdaptiveLightingController);
-      this.accessory.context.adaptiveLighting = true;
-      this.debugLog(`adaptiveLighting: ${this.accessory.context.adaptiveLighting},`
-        + ` adaptiveLightingShift: ${this.adaptiveLightingShift}`);
+      accessory.configureController(this.AdaptiveLightingController);
+      accessory.context.adaptiveLighting = true;
+      this.debugLog(`adaptiveLighting: ${this.adaptiveLighting}, adaptiveLightingShift: ${this.adaptiveLightingShift}`,
+      );
+    } else {
+      accessory.context.adaptiveLighting = false;
+      this.debugLog(`adaptiveLighting: ${accessory.context.adaptiveLighting}`);
     }
-    this.debugLog(`adaptiveLightingShift: ${this.adaptiveLightingShift}`);
 
     // Initialize LightBulb Characteristics
     this.LightBulb.Service
@@ -773,7 +776,11 @@ export class StripLight extends deviceBase {
       this.LightBulb.Saturation, 'Saturation');
   }
 
-  async adaptiveLighting(device: device & devicesConfig): Promise<void> {
+  async getAdaptiveLightingSettings(accessory: PlatformAccessory, device: device & devicesConfig): Promise<void> {
+    // Adaptive Lighting
+    this.adaptiveLighting = accessory.context.adaptiveLighting ?? true;
+    await this.debugLog(`adaptiveLighting: ${this.adaptiveLighting}`);
+    // Adaptive Lighting Shift
     if (device.striplight?.adaptiveLightingShift) {
       this.adaptiveLightingShift = device.striplight.adaptiveLightingShift;
       this.debugLog(`adaptiveLightingShift: ${this.adaptiveLightingShift}`);

package/src/device/meter.ts

@@ -4,8 +4,8 @@
  */
 import { Units } from 'homebridge';
 import { deviceBase } from './device.js';
-import { convertUnits } from '../utils.js';
 import { Subject, interval, skipWhile } from 'rxjs';
+import { convertUnits, validHumidity } from '../utils.js';
 import { SwitchBotBLEModel, SwitchBotBLEModelName } from 'node-switchbot';
 
 import type { devicesConfig } from '../settings.js';
@@ -170,7 +170,7 @@ export class Meter extends deviceBase {
 
     // CurrentRelativeHumidity
     if (!this.device.iosensor?.hide_humidity && this.HumiditySensor?.Service) {
-      this.HumiditySensor.CurrentRelativeHumidity = this.serviceData.humidity;
+      this.HumiditySensor.CurrentRelativeHumidity = validHumidity(this.serviceData.humidity, 0, 100);
       await this.debugLog(`CurrentRelativeHumidity: ${this.HumiditySensor.CurrentRelativeHumidity}%`);
     }
 

package/src/device/meterplus.ts

@@ -5,9 +5,9 @@
 import { Units } from 'homebridge';
 import { deviceBase } from './device.js';
 import { Subject, interval, skipWhile } from 'rxjs';
+import { convertUnits, validHumidity } from '../utils.js';
 import { SwitchBotBLEModel, SwitchBotBLEModelName } from 'node-switchbot';
 
-import { convertUnits } from '../utils.js';
 import type { devicesConfig } from '../settings.js';
 import type { device } from '../types/devicelist.js';
 import type { SwitchBotPlatform } from '../platform.js';
@@ -175,7 +175,7 @@ export class MeterPlus extends deviceBase {
 
     // CurrentRelativeHumidity
     if (!this.device.iosensor?.hide_humidity && this.HumiditySensor?.Service) {
-      this.HumiditySensor.CurrentRelativeHumidity = this.serviceData.humidity;
+      this.HumiditySensor.CurrentRelativeHumidity = validHumidity(this.serviceData.humidity, 0, 100);
       await this.debugLog(`CurrentRelativeHumidity: ${this.HumiditySensor.CurrentRelativeHumidity}%`);
     }
     // Current Temperature

package/src/utils.ts

@@ -115,7 +115,6 @@ export enum BlindTiltMappingMode {
   UseTiltForDirection = 'use_tilt_for_direction',
 }
 
-import type { Nullable, CharacteristicValue } from 'homebridge';
 import type { devicesConfig } from './settings.js';
 import type { blindTilt, curtain, curtain3, device } from './types/devicelist.js';
 
@@ -130,15 +129,20 @@ export function isBlindTiltDevice(device: device & devicesConfig): device is bli
 export function sleep(ms: number): Promise<void> {
   return new Promise((resolve) => setTimeout(resolve, ms));
 }
-
-export function checkName(displayName: string, name: string, value: Nullable<CharacteristicValue>): string {
-  if (typeof value === 'string' && !(new RegExp(/^[\p{L}\p{N}][\p{L}\p{N} ']*[\p{L}\p{N}]$/u)).test(value)) {
-    return `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.';
-  } else {
-    return 'false';
+/**
+ * Check if the humidity is within the min and max range
+ * @param humidity - The humidity value
+ * @param min - The minimum humidity value
+ * @param max - The maximum humidity value
+ * @returns The humidity value
+**/
+export function validHumidity(humidity: number, min?: number, max?: number): number {
+  if (humidity < (min || 0)) {
+    return min ?? 0;
+  } else if (humidity > (max || 100)) {
+    return max ?? 100;
   }
+  return humidity;
 }
 
 /**