@switchbot/homebridge-switchbot 1.12.9-beta.28 → 1.12.9-beta.29

package/src/device/curtain.ts

@@ -5,6 +5,8 @@ import { debounceTime, skipWhile, take, tap } from 'rxjs/operators';
 import { Service, PlatformAccessory, CharacteristicValue } from 'homebridge';
 import { DeviceURL, device, devicesConfig, serviceData, switchbot, deviceStatusResponse, payload, deviceStatus, ad } from '../settings';
 import { Context } from 'vm';
+import { MqttClient } from 'mqtt';
+import { connectAsync } from 'async-mqtt';
 
 export class Curtain {
   // Services
@@ -59,12 +61,16 @@ export class Curtain {
   curtainUpdateInProgress!: boolean;
   doCurtainUpdate!: Subject<void>;
 
+  //MQTT stuff
+  mqttClient: MqttClient | null = null;
+
   constructor(private readonly platform: SwitchBotPlatform, private accessory: PlatformAccessory, public device: device & devicesConfig) {
     // default placeholders
     this.logs(device);
     this.refreshRate(device);
     this.scan(device);
     this.config(device);
+    this.setupMqtt(device);
     this.CurrentPosition = 0;
     this.TargetPosition = 0;
     this.PositionState = this.platform.Characteristic.PositionState.STOPPED;
@@ -201,6 +207,35 @@ export class Curtain {
       });
   }
 
+  /*
+   * Publish MQTT message for topics of
+   * 'homebridge-switchbot/curtain/xx:xx:xx:xx:xx:xx'
+   */
+  mqttPublish(topic: string, message: any) {
+    const mac = this.device.deviceId?.toLowerCase().match(/[\s\S]{1,2}/g)?.join(':');
+    const options = this.device.mqttPubOptions || {};
+    this.mqttClient?.publish(`homebridge-switchbot/curtain/${mac}/${topic}`, `${message}`, options);
+    this.debugLog(`Meter: ${this.accessory.displayName} MQTT message: ${topic}/${message} options:${JSON.stringify(options)}`);
+  }
+
+  /*
+   * Setup MQTT hadler if URL is specifed.
+   */
+  async setupMqtt(device: device & devicesConfig): Promise<void> {
+    if (device.mqttURL) {
+      try {
+	this.mqttClient = await connectAsync(device.mqttURL, device.mqttOptions || {});
+	this.debugLog(`Meter: ${this.accessory.displayName} MQTT connection has been established successfully.`)
+	this.mqttClient.on('error', (e: Error) => {
+	  this.errorLog(`Meter: ${this.accessory.displayName} Failed to publish MQTT messages. ${e}`)
+	});
+      } catch (e) {
+	this.mqttClient = null;
+	this.errorLog(`Meter: ${this.accessory.displayName} Failed to establish MQTT connection. ${e}`)
+      }
+    }
+  }
+
   /**
    * Parse the device status from the SwitchBot api
    */
@@ -656,18 +691,21 @@ export class Curtain {
     } else {
       this.windowCoveringService.updateCharacteristic(this.platform.Characteristic.CurrentPosition, Number(this.CurrentPosition));
       this.debugLog(`Curtain: ${this.accessory.displayName} updateCharacteristic CurrentPosition: ${this.CurrentPosition}`);
+      this.mqttPublish('CurrentPosition', this.CurrentPosition);
     }
     if (this.PositionState === undefined) {
       this.debugLog(`Curtain: ${this.accessory.displayName} PositionState: ${this.PositionState}`);
     } else {
       this.windowCoveringService.updateCharacteristic(this.platform.Characteristic.PositionState, Number(this.PositionState));
       this.debugLog(`Curtain: ${this.accessory.displayName} updateCharacteristic PositionState: ${this.PositionState}`);
+      this.mqttPublish('PositionState', this.PositionState);
     }
     if (this.TargetPosition === undefined || Number.isNaN(this.TargetPosition)) {
       this.debugLog(`Curtain: ${this.accessory.displayName} TargetPosition: ${this.TargetPosition}`);
     } else {
       this.windowCoveringService.updateCharacteristic(this.platform.Characteristic.TargetPosition, Number(this.TargetPosition));
       this.debugLog(`Curtain: ${this.accessory.displayName} updateCharacteristic TargetPosition: ${this.TargetPosition}`);
+      this.mqttPublish('TargetPosition', this.TargetPosition);
     }
     if (!this.device.curtain?.hide_lightsensor) {
       if (this.CurrentAmbientLightLevel === undefined || Number.isNaN(this.CurrentAmbientLightLevel)) {
@@ -675,6 +713,7 @@ export class Curtain {
       } else {
         this.lightSensorService?.updateCharacteristic(this.platform.Characteristic.CurrentAmbientLightLevel, this.CurrentAmbientLightLevel);
         this.debugLog(`Curtain: ${this.accessory.displayName}` + ` updateCharacteristic CurrentAmbientLightLevel: ${this.CurrentAmbientLightLevel}`);
+	this.mqttPublish('CurrentAmbientLightLevel', this.CurrentAmbientLightLevel);
       }
     }
     if (this.device.ble) {
@@ -683,12 +722,14 @@ export class Curtain {
       } else {
         this.batteryService?.updateCharacteristic(this.platform.Characteristic.BatteryLevel, this.BatteryLevel);
         this.debugLog(`Curtain: ${this.accessory.displayName} updateCharacteristic BatteryLevel: ${this.BatteryLevel}`);
+	this.mqttPublish('BatteryLevel', this.BatteryLevel);
       }
       if (this.StatusLowBattery === undefined) {
         this.debugLog(`Curtain: ${this.accessory.displayName} StatusLowBattery: ${this.StatusLowBattery}`);
       } else {
         this.batteryService?.updateCharacteristic(this.platform.Characteristic.StatusLowBattery, this.StatusLowBattery);
         this.debugLog(`Curtain: ${this.accessory.displayName} updateCharacteristic StatusLowBattery: ${this.StatusLowBattery}`);
+	this.mqttPublish('StatusLowBattery', this.StatusLowBattery);
       }
     }
   }
@@ -745,6 +786,7 @@ export class Curtain {
     this.debugLog(`Curtain: ${this.accessory.displayName} TargetPosition: ${value}`);
 
     this.TargetPosition = value;
+    this.mqttPublish('TargetPosition', this.TargetPosition);
 
     await this.setMinMax();
     if (value > this.CurrentPosition) {

package/src/device/meter.ts

@@ -4,6 +4,9 @@ import { SwitchBotPlatform } from '../platform';
 import { Service, PlatformAccessory, Units, CharacteristicValue } from 'homebridge';
 import { DeviceURL, device, devicesConfig, serviceData, ad, switchbot, deviceStatusResponse, temperature, deviceStatus } from '../settings';
 import { Context } from 'vm';
+import { MqttClient } from 'mqtt';
+import { connectAsync } from 'async-mqtt';
+import { hostname } from "os";
 
 /**
  * Platform Accessory
@@ -51,12 +54,20 @@ export class Meter {
   meterUpdateInProgress!: boolean;
   doMeterUpdate: Subject<void>;
 
+  //MQTT stuff
+  mqttClient: MqttClient | null = null;
+  
+  // EVE history service handler
+  historyService: any;
+
   constructor(private readonly platform: SwitchBotPlatform, private accessory: PlatformAccessory, public device: device & devicesConfig) {
     // default placeholders
     this.logs(device);
     this.scan(device);
+    this.setupHistoryService(device);
     this.refreshRate(device);
     this.config(device);
+    this.setupMqtt(device);
     if (this.CurrentRelativeHumidity === undefined) {
       this.CurrentRelativeHumidity = 0;
     } else {
@@ -166,6 +177,48 @@ export class Meter {
       });
   }
 
+  /*
+   * Publish MQTT message for topics of
+   * 'homebridge-switchbot/meter/xx:xx:xx:xx:xx:xx'
+   */
+  mqttPublish(message: any) {
+    const mac = this.device.deviceId?.toLowerCase().match(/[\s\S]{1,2}/g)?.join(':');
+    const options = this.device.mqttPubOptions || {};
+    this.mqttClient?.publish(`homebridge-switchbot/meter/${mac}`, `${message}`, options);
+    this.debugLog(`Meter: ${this.accessory.displayName} MQTT message: ${message} options:${JSON.stringify(options)}`);
+  }
+
+  /*
+   * Setup MQTT hadler if URL is specifed.
+   */
+  async setupMqtt(device: device & devicesConfig): Promise<void> {
+    if (device.mqttURL) {
+      try {
+	this.mqttClient = await connectAsync(device.mqttURL, device.mqttOptions || {});
+	this.debugLog(`Meter: ${this.accessory.displayName} MQTT connection has been established successfully.`)
+	this.mqttClient.on('error', (e: Error) => {
+	  this.errorLog(`Meter: ${this.accessory.displayName} Failed to publish MQTT messages. ${e}`)
+	});
+      } catch (e) {
+	this.mqttClient = null;
+	this.errorLog(`Meter: ${this.accessory.displayName} Failed to establish MQTT connection. ${e}`)
+      }
+    }
+  }
+
+  /*
+   * Setup EVE history graph feature if enabled.
+   */
+  async setupHistoryService(device: device & devicesConfig): Promise<void> {
+    const mac = this.device.deviceId!.match(/.{1,2}/g)!.join(':').toLowerCase();
+    this.historyService = device.history ?
+	  new this.platform.fakegatoAPI('room', this.accessory,
+	    {log: this.platform.log, storage: 'fs',
+	     filename: `${hostname().split(".")[0]}_${mac}_persist.json`
+	    }) :
+	  null;
+  }
+    
   /**
    * Parse the device status from the SwitchBot api
    */
@@ -187,7 +240,7 @@ export class Meter {
     } else {
       this.StatusLowBattery = this.platform.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL;
     }
-    this.debugLog(`${this.accessory.displayName} BatteryLevel: ${this.BatteryLevel}, StatusLowBattery: ${this.StatusLowBattery}`);
+      this.debugLog(`Meter: ${this.accessory.displayName} BatteryLevel: ${this.BatteryLevel}, StatusLowBattery: ${this.StatusLowBattery}`);
 
     // Humidity
     if (!this.device.meter?.hide_humidity) {
@@ -261,10 +314,12 @@ export class Meter {
               this.infoLog(`Meter: ${this.accessory.displayName} BLE Address Found: ${this.address}`);
               this.infoLog(`Meter: ${this.accessory.displayName} Config BLE Address: ${this.device.bleMac}`);
             }
-            this.serviceData = ad.serviceData;
-            this.temperature = ad.serviceData.temperature!.c;
-            this.humidity = ad.serviceData.humidity;
-            this.battery = ad.serviceData.battery;
+	    if (ad.serviceData.humidity! > 0) {	// reject unreliable data
+              this.serviceData = ad.serviceData;
+              this.temperature = ad.serviceData.temperature!.c;
+              this.humidity = ad.serviceData.humidity;
+              this.battery = ad.serviceData.battery;
+	    }
             this.debugLog(`Meter: ${this.accessory.displayName} serviceData: ${JSON.stringify(ad.serviceData)}`);
             this.debugLog(
               `Meter: ${this.accessory.displayName} model: ${ad.serviceData.model}, modelName: ${ad.serviceData.modelName}, ` +
@@ -365,12 +420,16 @@ export class Meter {
    * Updates the status for each of the HomeKit Characteristics
    */
   async updateHomeKitCharacteristics(): Promise<void> {
+    let mqttmessage: string[] = [];
+    let entry = {time: Math.round(new Date().valueOf()/1000)};
     if (!this.device.meter?.hide_humidity) {
       if (this.CurrentRelativeHumidity === undefined) {
         this.debugLog(`Meter: ${this.accessory.displayName} CurrentRelativeHumidity: ${this.CurrentRelativeHumidity}`);
       } else {
         this.humidityservice?.updateCharacteristic(this.platform.Characteristic.CurrentRelativeHumidity, this.CurrentRelativeHumidity);
         this.debugLog(`Meter: ${this.accessory.displayName} updateCharacteristic CurrentRelativeHumidity: ${this.CurrentRelativeHumidity}`);
+	mqttmessage.push(`"humidity": ${this.CurrentRelativeHumidity}`);
+	entry["humidity"] = this.CurrentRelativeHumidity;
       }
     }
     if (!this.device.meter?.hide_temperature) {
@@ -379,6 +438,8 @@ export class Meter {
       } else {
         this.temperatureservice?.updateCharacteristic(this.platform.Characteristic.CurrentTemperature, this.CurrentTemperature);
         this.debugLog(`Meter: ${this.accessory.displayName} updateCharacteristic CurrentTemperature: ${this.CurrentTemperature}`);
+	mqttmessage.push(`"temperature": ${this.CurrentTemperature}`);
+	entry["temp"] = this.CurrentTemperature;
       }
     }
     if (this.device.ble) {
@@ -387,14 +448,20 @@ export class Meter {
       } else {
         this.batteryService?.updateCharacteristic(this.platform.Characteristic.BatteryLevel, this.BatteryLevel);
         this.debugLog(`Meter: ${this.accessory.displayName} updateCharacteristic BatteryLevel: ${this.BatteryLevel}`);
+	mqttmessage.push(`"battery": ${this.BatteryLevel}`);
       }
       if (this.StatusLowBattery === undefined) {
         this.debugLog(`Meter: ${this.accessory.displayName} StatusLowBattery: ${this.StatusLowBattery}`);
       } else {
         this.batteryService?.updateCharacteristic(this.platform.Characteristic.StatusLowBattery, this.StatusLowBattery);
         this.debugLog(`Meter: ${this.accessory.displayName} updateCharacteristic StatusLowBattery: ${this.StatusLowBattery}`);
+	mqttmessage.push(`"lowBattery": ${this.StatusLowBattery}`);
       }
     }
+    this.mqttPublish(`{${mqttmessage.join(',')}}`)
+    if (this.CurrentRelativeHumidity > 0) { // reject unreliable data
+      this.historyService?.addEntry(entry);
+    }
   }
 
   async apiError(e: any): Promise<void> {

package/src/platform.ts

@@ -21,6 +21,7 @@ import { AirConditioner } from './irdevice/airconditioner';
 import axios, { AxiosInstance, AxiosRequestConfig } from 'axios';
 import { API, DynamicPlatformPlugin, Logger, PlatformAccessory, Service, Characteristic } from 'homebridge';
 import { PLATFORM_NAME, PLUGIN_NAME, DeviceURL, irdevice, device, SwitchBotPlatformConfig, deviceResponses, devicesConfig } from './settings';
+import fakegato from 'fakegato-history';
 
 /**
  * HomebridgePlatform
@@ -44,6 +45,8 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
   debugMode!: boolean;
   platformLogging?: string;
 
+  public readonly fakegatoAPI: any;
+
   constructor(public readonly log: Logger, public readonly config: SwitchBotPlatformConfig, public readonly api: API) {
     this.logs();
     this.debugLog('Finished initializing platform:', this.config.name);
@@ -76,6 +79,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       return request;
     });
 
+    // import fakegato-history module
+    this.fakegatoAPI = fakegato(api);
+
     // When this event is fired it means Homebridge has restored all cached accessories from disk.
     // Dynamic Platform plugins should only register new accessories after this event was fired,
     // in order to ensure they weren't added to homebridge already. This event can also be used

package/src/settings.ts

@@ -1,4 +1,5 @@
 import { MacAddress, PlatformConfig } from 'homebridge';
+import { IClientOptions } from 'async-mqtt';
 /**
  * This is the name of the platform that users will use to register the plugin in the Homebridge config.json
  */
@@ -58,6 +59,10 @@ export interface devicesConfig extends device {
   scanDuration?: number;
   hide_device?: boolean;
   offline?: boolean;
+  mqttURL?: string;
+  mqttOptions?: IClientOptions;
+  mqttPubOptions?: IClientOptions;
+  history?: boolean;
 }
 
 export type meter = {