@switchbot/homebridge-switchbot 3.3.1-beta.3 → 3.3.1-beta.4

package/src/device/curtain.ts

@@ -97,7 +97,7 @@ export class Curtain {
     this.refreshRate(device);
     this.scan(device);
     this.setupMqtt(device);
-    this.context();
+    this.deviceContext();
     this.deviceConfig(device);
 
     // this is subject we use to track when we need to POST changes to the SwitchBot API
@@ -1219,7 +1219,7 @@ export class Curtain {
 
   async offlineOff(): Promise<void> {
     if (this.device.offline) {
-      await this.context();
+      await this.deviceContext();
       await this.updateHomeKitCharacteristics();
     }
   }
@@ -1236,7 +1236,7 @@ export class Curtain {
     //throw new this.platform.api.hap.HapStatusError(HAPStatus.SERVICE_COMMUNICATION_FAILURE);
   }
 
-  async context() {
+  async deviceContext() {
     if (this.accessory.context.CurrentPosition === undefined) {
       this.CurrentPosition = 0;
     } else {

package/src/device/hub.ts

@@ -66,7 +66,7 @@ export class Hub {
     // default placeholders
     this.deviceLogs(device);
     this.refreshRate(device);
-    this.context();
+    this.deviceContext();
     this.setupHistoryService(device);
     this.setupMqtt(device);
     this.deviceConfig(device);
@@ -666,7 +666,7 @@ export class Hub {
 
   async offlineOff(): Promise<void> {
     if (this.device.offline) {
-      await this.context();
+      await this.deviceContext();
       await this.updateHomeKitCharacteristics();
     }
   }
@@ -701,7 +701,7 @@ export class Hub {
     return this.set_maxLux;
   }
 
-  async context() {
+  async deviceContext() {
     if (this.CurrentRelativeHumidity === undefined) {
       this.CurrentRelativeHumidity = 0;
     } else {

package/src/device/humidifier.ts

@@ -75,7 +75,7 @@ export class Humidifier {
     this.deviceLogs(device);
     this.scan(device);
     this.refreshRate(device);
-    this.context();
+    this.deviceContext();
     this.deviceConfig(device);
 
     // this is subject we use to track when we need to POST changes to the SwitchBot API
@@ -937,7 +937,7 @@ export class Humidifier {
   async offlineOff(): Promise<void> {
     this.debugWarnLog(`${this.device.deviceType}: ${this.accessory.displayName} offline: ${this.device.offline}`);
     if (this.device.offline) {
-      await this.context();
+      await this.deviceContext();
       if (this.CurrentTemperature === undefined) {
         this.CurrentTemperature = 0;
       }
@@ -959,7 +959,7 @@ export class Humidifier {
     }
   }
 
-  async context() {
+  async deviceContext() {
     if (this.Active === undefined) {
       this.Active = this.hap.Characteristic.Active.ACTIVE;
     } else {

package/src/device/iosensor.ts

@@ -82,7 +82,7 @@ export class IOSensor {
     this.deviceLogs(device);
     this.scan(device);
     this.refreshRate(device);
-    this.context();
+    this.deviceContext();
     this.setupHistoryService(device);
     this.setupMqtt(device);
     this.deviceConfig(device);
@@ -689,7 +689,7 @@ export class IOSensor {
 
   async offlineOff(): Promise<void> {
     if (this.device.offline) {
-      await this.context();
+      await this.deviceContext();
       await this.updateHomeKitCharacteristics();
     }
   }
@@ -705,7 +705,7 @@ export class IOSensor {
     this.batteryService?.updateCharacteristic(this.hap.Characteristic.StatusLowBattery, e);
   }
 
-  async context() {
+  async deviceContext() {
     if (this.CurrentRelativeHumidity === undefined) {
       this.CurrentRelativeHumidity = 0;
     } else {

package/src/device/lightstrip.ts

@@ -82,7 +82,7 @@ export class StripLight {
     this.deviceLogs(device);
     this.scan(device);
     this.refreshRate(device);
-    this.context();
+    this.deviceContext();
     this.deviceConfig(device);
 
     // this is subject we use to track when we need to POST changes to the SwitchBot API
@@ -1108,7 +1108,7 @@ export class StripLight {
 
   async offlineOff(): Promise<void> {
     if (this.device.offline) {
-      await this.context();
+      await this.deviceContext();
       await this.updateHomeKitCharacteristics();
     }
   }
@@ -1120,7 +1120,7 @@ export class StripLight {
     this.lightBulbService.updateCharacteristic(this.hap.Characteristic.Saturation, e);
   }
 
-  async context() {
+  async deviceContext() {
     if (this.On === undefined) {
       this.On = false;
     } else {

package/src/device/lock.ts

@@ -69,7 +69,7 @@ export class Lock {
     this.deviceLogs(device);
     this.scan(device);
     this.refreshRate(device);
-    this.context();
+    this.deviceContext();
     this.deviceConfig(device);
 
     // this is subject we use to track when we need to POST changes to the SwitchBot API
@@ -808,7 +808,7 @@ export class Lock {
 
   async offlineOff(): Promise<void> {
     if (this.device.offline) {
-      await this.context();
+      await this.deviceContext();
       await this.updateHomeKitCharacteristics();
     }
   }
@@ -821,7 +821,7 @@ export class Lock {
     this.lockService.updateCharacteristic(this.hap.Characteristic.LockCurrentState, e);
   }
 
-  async context() {
+  async deviceContext() {
     if (this.LockTargetState === undefined) {
       this.LockTargetState = false;
     } else {

package/src/device/meter.ts

@@ -72,7 +72,7 @@ export class Meter {
     this.deviceLogs(device);
     this.scan(device);
     this.refreshRate(device);
-    this.context();
+    this.deviceContext();
     this.setupHistoryService(device);
     this.setupMqtt(device);
     this.deviceConfig(device);
@@ -682,7 +682,7 @@ export class Meter {
 
   async offlineOff(): Promise<void> {
     if (this.device.offline) {
-      await this.context();
+      await this.deviceContext();
       await this.updateHomeKitCharacteristics();
     }
   }
@@ -698,7 +698,7 @@ export class Meter {
     this.batteryService?.updateCharacteristic(this.hap.Characteristic.StatusLowBattery, e);
   }
 
-  async context() {
+  async deviceContext() {
     if (this.CurrentRelativeHumidity === undefined) {
       this.CurrentRelativeHumidity = 0;
     } else {

package/src/device/meterplus.ts

@@ -77,7 +77,7 @@ export class MeterPlus {
     this.deviceLogs(device);
     this.scan(device);
     this.refreshRate(device);
-    this.context();
+    this.deviceContext();
     this.setupHistoryService(device);
     this.setupMqtt(device);
     this.deviceConfig(device);
@@ -697,7 +697,7 @@ export class MeterPlus {
 
   async offlineOff(): Promise<void> {
     if (this.device.offline) {
-      await this.context();
+      await this.deviceContext();
       await this.updateHomeKitCharacteristics();
     }
   }
@@ -713,7 +713,7 @@ export class MeterPlus {
     this.batteryService?.updateCharacteristic(this.hap.Characteristic.StatusLowBattery, e);
   }
 
-  async context() {
+  async deviceContext() {
     if (this.CurrentRelativeHumidity === undefined) {
       this.CurrentRelativeHumidity = 0;
     } else {

package/src/device/motion.ts

@@ -74,7 +74,7 @@ export class Motion {
     this.deviceLogs(device);
     this.scan(device);
     this.refreshRate(device);
-    this.context();
+    this.deviceContext();
     this.deviceConfig(device);
 
     // this is subject we use to track when we need to POST changes to the SwitchBot API
@@ -629,7 +629,7 @@ export class Motion {
 
   async offlineOff(): Promise<void> {
     if (this.device.offline) {
-      await this.context();
+      await this.deviceContext();
       await this.updateHomeKitCharacteristics();
     }
   }
@@ -643,12 +643,16 @@ export class Motion {
     }
   }
 
-  async context() {
+  async deviceContext() {
     if (this.MotionDetected === undefined) {
       this.MotionDetected = false;
     } else {
       this.MotionDetected = this.accessory.context.MotionDetected;
     }
+    if (this.FirmwareRevision === undefined) {
+      this.FirmwareRevision = this.platform.version;
+      this.accessory.context.FirmwareRevision = this.FirmwareRevision;
+    }
   }
 
   async refreshRate(device: device & devicesConfig): Promise<void> {

package/src/device/plug.ts

@@ -55,7 +55,7 @@ export class Plug {
     this.deviceLogs(device);
     this.scan(device);
     this.refreshRate(device);
-    this.context();
+    this.deviceContext();
     this.deviceConfig(device);
 
     // this is subject we use to track when we need to POST changes to the SwitchBot API
@@ -656,7 +656,7 @@ export class Plug {
 
   async offlineOff(): Promise<void> {
     if (this.device.offline) {
-      await this.context();
+      await this.deviceContext();
       await this.updateHomeKitCharacteristics();
     }
   }
@@ -665,12 +665,16 @@ export class Plug {
     this.outletService.updateCharacteristic(this.hap.Characteristic.On, e);
   }
 
-  async context() {
+  async deviceContext() {
     if (this.On === undefined) {
       this.On = false;
     } else {
       this.On = this.accessory.context.On;
     }
+    if (this.FirmwareRevision === undefined) {
+      this.FirmwareRevision = this.platform.version;
+      this.accessory.context.FirmwareRevision = this.FirmwareRevision;
+    }
   }
 
   async refreshRate(device: device & devicesConfig): Promise<void> {

package/src/device/robotvacuumcleaner.ts

@@ -62,7 +62,7 @@ export class RobotVacuumCleaner {
     this.deviceLogs(device);
     this.scan(device);
     this.refreshRate(device);
-    this.context();
+    this.deviceContext();
     this.deviceConfig(device);
 
     // this is subject we use to track when we need to POST changes to the SwitchBot API
@@ -809,7 +809,7 @@ export class RobotVacuumCleaner {
 
   async offlineOff(): Promise<void> {
     if (this.device.offline) {
-      await this.context();
+      await this.deviceContext();
       await this.updateHomeKitCharacteristics();
     }
   }
@@ -818,7 +818,7 @@ export class RobotVacuumCleaner {
     this.robotVacuumCleanerService.updateCharacteristic(this.hap.Characteristic.On, e);
   }
 
-  async context() {
+  async deviceContext() {
     if (this.On === undefined) {
       this.On = false;
     } else {
@@ -829,6 +829,10 @@ export class RobotVacuumCleaner {
     } else {
       this.Brightness = this.accessory.context.Brightness;
     }
+    if (this.FirmwareRevision === undefined) {
+      this.FirmwareRevision = this.platform.version;
+      this.accessory.context.FirmwareRevision = this.FirmwareRevision;
+    }
   }
 
   async refreshRate(device: device & devicesConfig): Promise<void> {

package/src/irdevice/airconditioner.ts

@@ -63,7 +63,7 @@ export class AirConditioner {
     this.hap = this.api.hap;
     // default placeholders
     this.deviceLogs(device);
-    this.context();
+    this.deviceContext();
     this.disablePushOnChanges(device);
     this.disablePushOffChanges(device);
     this.disablePushDetailChanges(device);
@@ -209,7 +209,7 @@ export class AirConditioner {
       `${this.device.remoteType}: ${this.accessory.displayName} pushAirConditionerDetailsChanges Active: ${this.Active},` +
       ` disablePushOff: ${this.disablePushOff},  disablePushOn: ${this.disablePushOn}`,
     );
-    //await this.context();
+    //await this.deviceContext();
     if (this.CurrentMode === undefined) {
       this.CurrentMode = 1;
     }
@@ -243,7 +243,7 @@ export class AirConditioner {
 
   private async UpdateCurrentHeaterCoolerState() {
     if (this.Active === this.hap.Characteristic.Active.ACTIVE) {
-      await this.context();
+      await this.deviceContext();
       if (this.ThresholdTemperature < this.CurrentTemperature &&
         this.TargetHeaterCoolerState !== this.hap.Characteristic.TargetHeaterCoolerState.HEAT) {
         this.CurrentHeaterCoolerState = this.hap.Characteristic.CurrentHeaterCoolerState.COOLING;
@@ -439,7 +439,7 @@ export class AirConditioner {
   }
 
   async ThresholdTemperatureGet(): Promise<CharacteristicValue> {
-    await this.context();
+    await this.deviceContext();
     this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Get ThresholdTemperature: ${this.ThresholdTemperature}`);
     return this.ThresholdTemperature;
   }
@@ -665,7 +665,7 @@ export class AirConditioner {
     this.coolerService.updateCharacteristic(this.hap.Characteristic.CoolingThresholdTemperature, e);
   }
 
-  async context(): Promise<void> {
+  async deviceContext(): Promise<void> {
     if (this.Active === undefined) {
       this.Active = this.hap.Characteristic.Active.INACTIVE;
     } else if (this.Active) {

package/src/irdevice/airpurifier.ts

@@ -54,7 +54,7 @@ export class AirPurifier {
     this.hap = this.api.hap;
     // default placeholders
     this.deviceLogs(device);
-    this.context();
+    this.deviceContext();
     this.disablePushOnChanges(device);
     this.disablePushOffChanges(device);
     this.deviceConfig(device);
@@ -408,7 +408,7 @@ export class AirPurifier {
     this.airPurifierService.updateCharacteristic(this.hap.Characteristic.Active, e);
   }
 
-  private context() {
+  private deviceContext() {
     if (this.Active === undefined) {
       this.Active = this.hap.Characteristic.Active.INACTIVE;
     } else {

package/src/irdevice/camera.ts

@@ -36,7 +36,7 @@ export class Camera {
     this.hap = this.api.hap;
     // default placeholders
     this.deviceLogs(device);
-    this.context();
+    this.deviceContext();
     this.disablePushOnChanges(device);
     this.disablePushOffChanges(device);
     this.deviceConfig(device);
@@ -289,7 +289,7 @@ export class Camera {
     this.switchService.updateCharacteristic(this.hap.Characteristic.On, e);
   }
 
-  async context() {
+  async deviceContext() {
     if (this.On === undefined) {
       this.On = false;
     } else {

package/src/irdevice/fan.ts

@@ -43,7 +43,7 @@ export class Fan {
     this.hap = this.api.hap;
     // default placeholders
     this.deviceLogs(device);
-    this.context();
+    this.deviceContext();
     this.disablePushOnChanges(device);
     this.disablePushOffChanges(device);
     this.deviceConfig(device);
@@ -421,7 +421,7 @@ export class Fan {
     this.fanService.updateCharacteristic(this.hap.Characteristic.SwingMode, e);
   }
 
-  async context() {
+  async deviceContext() {
     if (this.Active === undefined) {
       this.Active = this.hap.Characteristic.Active.INACTIVE;
     } else {

package/src/irdevice/light.ts

@@ -42,7 +42,7 @@ export class Light {
     this.hap = this.api.hap;
     // default placeholders
     this.deviceLogs(device);
-    this.context();
+    this.deviceContext();
     this.disablePushOnChanges(device);
     this.disablePushOffChanges(device);
     this.deviceConfig(device);
@@ -437,7 +437,7 @@ export class Light {
     }
   }
 
-  async context() {
+  async deviceContext() {
     if (this.On === undefined) {
       this.On = false;
     } else {

package/src/irdevice/other.ts

@@ -47,7 +47,7 @@ export class Others {
     // default placeholders
     this.deviceLogs(device);
     this.deviceType(device);
-    this.context();
+    this.deviceContext();
     this.disablePushOnChanges(device);
     this.disablePushOffChanges(device);
     this.deviceConfig(device);
@@ -910,7 +910,7 @@ export class Others {
     }
   }
 
-  async context() {
+  async deviceContext() {
     if (this.On === undefined) {
       this.On = true;
     } else {

package/src/irdevice/tv.ts

@@ -39,7 +39,7 @@ export class TV {
     this.hap = this.api.hap;
     // default placeholders
     this.deviceLogs(device);
-    this.context();
+    this.deviceContext();
     this.disablePushOnChanges(device);
     this.disablePushOffChanges(device);
     this.disablePushDetailChanges(device);
@@ -555,7 +555,7 @@ export class TV {
     this.tvService.updateCharacteristic(this.hap.Characteristic.ActiveIdentifier, e);
   }
 
-  async context() {
+  async deviceContext() {
     if (this.Active === undefined) {
       this.Active = this.hap.Characteristic.Active.INACTIVE;
     } else {

package/src/irdevice/vacuumcleaner.ts

@@ -36,7 +36,7 @@ export class VacuumCleaner {
     this.hap = this.api.hap;
     // default placeholders
     this.deviceLogs(device);
-    this.context();
+    this.deviceContext();
     this.disablePushOnChanges(device);
     this.disablePushOffChanges(device);
     this.deviceConfig(device);
@@ -285,7 +285,7 @@ export class VacuumCleaner {
     this.switchService.updateCharacteristic(this.hap.Characteristic.On, e);
   }
 
-  async context() {
+  async deviceContext() {
     if (this.On === undefined) {
       this.On = false;
     } else {

package/src/irdevice/waterheater.ts

@@ -36,7 +36,7 @@ export class WaterHeater {
     this.hap = this.api.hap;
     // default placeholders
     this.deviceLogs(device);
-    this.context();
+    this.deviceContext();
     this.disablePushOnChanges(device);
     this.disablePushOffChanges(device);
     this.deviceConfig(device);
@@ -294,7 +294,7 @@ export class WaterHeater {
     this.valveService.updateCharacteristic(this.hap.Characteristic.Active, e);
   }
 
-  async context(): Promise<void> {
+  async deviceContext(): Promise<void> {
     if (this.Active === undefined) {
       this.Active = this.hap.Characteristic.Active.INACTIVE;
     } else {

package/src/platform.ts

@@ -52,11 +52,13 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
   public readonly api: API;
   public readonly log: Logging;
 
-  version = process.env.npm_package_version || '2.13.0';
+  version!: string;
   Logging?: string;
   debugMode!: boolean;
-  platformLogging?: string;
+  platformConfig!: SwitchBotPlatformConfig['options'];
+  platformLogging!: SwitchBotPlatformConfig['logging'];
   config!: SwitchBotPlatformConfig;
+
   webhookEventListener: http.Server | null = null;
   mqttClient: MqttClient | null = null;
 
@@ -84,7 +86,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       credentials: config.credentials as object,
       options: config.options as object,
     };
-    this.logType();
+    this.platformLogging = this.config.options?.logging ?? 'standard';
+    this.platformConfigOptions();
+    this.platformLogs();
+    this.getVersion();
     this.debugLog(`Finished initializing platform: ${config.name}`);
 
     // verify the config
@@ -2569,7 +2574,37 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
     return switchbot;
   }
 
-  logType() {
+  async getVersion() {
+    const json = JSON.parse(
+      readFileSync(
+        new URL('../package.json', import.meta.url),
+        'utf-8',
+      ),
+    );
+    this.debugLog(`Plugin Version: ${json.version}`);
+    this.version = json.version;
+  }
+
+  async platformConfigOptions() {
+    const platformConfig: SwitchBotPlatformConfig['options'] = {};
+    if (this.config.options) {
+      if (this.config.options.logging) {
+        platformConfig.logging = this.config.options.logging;
+      }
+      if (this.config.options.refreshRate) {
+        platformConfig.refreshRate = this.config.options.refreshRate;
+      }
+      if (this.config.options.pushRate) {
+        platformConfig.pushRate = this.config.options.pushRate;
+      }
+      if (Object.entries(platformConfig).length !== 0) {
+        this.debugLog(`Platform Config: ${JSON.stringify(platformConfig)}`);
+      }
+      this.platformConfig = platformConfig;
+    }
+  }
+
+  async platformLogs() {
     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;