UNPKG

@switchbot/homebridge-switchbot

Version:

The SwitchBot plugin allows you to access your SwitchBot device(s) from HomeKit.

458 lines 26.1 kB
/* * For Testing Locally: * import { SwitchBotBLEModel, SwitchBotBLEModelName } from '/Users/Shared/GitHub/OpenWonderLabs/node-switchbot/dist/index.js'; */ import { SwitchBotBLEModel, SwitchBotBLEModelName } from 'node-switchbot'; import { interval, skipWhile, Subject } from 'rxjs'; import { convertUnits, formatDeviceIdAsMac, validHumidity } from '../utils.js'; import { deviceBase } from './device.js'; /** * Platform Accessory * An instance of this class is created for each accessory your platform registers * Each accessory may expose multiple services of different service types. */ export class MeterPro extends deviceBase { platform; // Services Battery; HumiditySensor; TemperatureSensor; CarbonDioxideSensor; // OpenAPI deviceStatus; // Webhook webhookContext; // BLE serviceData; // Updates meterUpdateInProgress; doMeterUpdate; constructor(platform, accessory, device) { super(platform, accessory, device); this.platform = platform; // Set category accessory.category = 10 /* this.hap.Categories.SENSOR */; // this is subject we use to track when we need to POST changes to the SwitchBot API this.doMeterUpdate = new Subject(); this.meterUpdateInProgress = false; // Initialize Battery Service accessory.context.Battery = accessory.context.Battery ?? {}; this.Battery = { Name: `${accessory.displayName} Battery`, Service: accessory.getService(this.hap.Service.Battery) ?? accessory.addService(this.hap.Service.Battery), BatteryLevel: accessory.context.BatteryLevel ?? 100, StatusLowBattery: accessory.context.StatusLowBattery ?? this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL, }; accessory.context.Battery = this.Battery; // Initialize Battery Characteristics this.Battery.Service.setCharacteristic(this.hap.Characteristic.Name, this.Battery.Name).setCharacteristic(this.hap.Characteristic.ChargingState, this.hap.Characteristic.ChargingState.NOT_CHARGEABLE).getCharacteristic(this.hap.Characteristic.BatteryLevel).onGet(() => { return this.Battery.BatteryLevel; }); this.Battery.Service.getCharacteristic(this.hap.Characteristic.StatusLowBattery).onGet(() => { return this.Battery.StatusLowBattery; }); // Initialize Temperature Sensor Service if (device.hide_temperature) { if (this.TemperatureSensor) { this.debugLog('Removing Temperature Sensor Service'); this.TemperatureSensor.Service = this.accessory.getService(this.hap.Service.TemperatureSensor); accessory.removeService(this.TemperatureSensor.Service); } } else { accessory.context.TemperatureSensor = accessory.context.TemperatureSensor ?? {}; this.TemperatureSensor = { Name: `${accessory.displayName} Temperature Sensor`, Service: accessory.getService(this.hap.Service.TemperatureSensor) ?? this.accessory.addService(this.hap.Service.TemperatureSensor), CurrentTemperature: accessory.context.CurrentTemperature ?? 30, }; accessory.context.TemperatureSensor = this.TemperatureSensor; // Initialize Temperature Sensor Characteristics this.TemperatureSensor.Service.setCharacteristic(this.hap.Characteristic.Name, this.TemperatureSensor.Name).getCharacteristic(this.hap.Characteristic.CurrentTemperature).setProps({ unit: "celsius" /* Units.CELSIUS */, validValueRanges: [-273.15, 100], minValue: -273.15, maxValue: 100, minStep: 0.1, }).onGet(() => { return this.TemperatureSensor.CurrentTemperature; }); } // Initialize Humidity Sensor Service if (device.hide_humidity) { if (this.HumiditySensor) { this.debugLog('Removing Humidity Sensor Service'); this.HumiditySensor.Service = this.accessory.getService(this.hap.Service.HumiditySensor); accessory.removeService(this.HumiditySensor.Service); } } else { accessory.context.HumiditySensor = accessory.context.HumiditySensor ?? {}; this.HumiditySensor = { Name: `${accessory.displayName} Humidity Sensor`, Service: accessory.getService(this.hap.Service.HumiditySensor) ?? this.accessory.addService(this.hap.Service.HumiditySensor), CurrentRelativeHumidity: accessory.context.CurrentRelativeHumidity ?? 50, }; accessory.context.HumiditySensor = this.HumiditySensor; // Initialize Humidity Sensor Characteristics this.HumiditySensor.Service.setCharacteristic(this.hap.Characteristic.Name, this.HumiditySensor.Name).getCharacteristic(this.hap.Characteristic.CurrentRelativeHumidity).setProps({ minStep: 0.1, }).onGet(() => { return this.HumiditySensor.CurrentRelativeHumidity; }); } // Initialize Carbon Dioxide Sensor Service if (device.hide_co2) { if (this.CarbonDioxideSensor) { this.debugLog('Removing Carbon Dioxide Sensor Service'); this.CarbonDioxideSensor.Service = this.accessory.getService(this.hap.Service.CarbonDioxideSensor); accessory.removeService(this.CarbonDioxideSensor.Service); } } else if (this.device.deviceType === 'MeterPro(CO2)') { accessory.context.CarbonDioxideSensor = accessory.context.CarbonDioxideSensor ?? {}; this.CarbonDioxideSensor = { Name: `${accessory.displayName} Carbon Dioxide Sensor`, Service: accessory.getService(this.hap.Service.CarbonDioxideSensor) ?? this.accessory.addService(this.hap.Service.CarbonDioxideSensor), CarbonDioxideDetected: accessory.context.CarbonDioxideDetected ?? this.hap.Characteristic.CarbonDioxideDetected.CO2_LEVELS_NORMAL, CarbonDioxideLevel: accessory.context.CarbonDioxideLevel ?? 0, }; accessory.context.CarbonDioxideSensor = this.CarbonDioxideSensor; // Initialize Carbon Dioxide Sensor Characteristics this.CarbonDioxideSensor.Service.setCharacteristic(this.hap.Characteristic.Name, this.CarbonDioxideSensor.Name).getCharacteristic(this.hap.Characteristic.CarbonDioxideDetected).onGet(() => { return this.CarbonDioxideSensor.CarbonDioxideDetected; }); this.CarbonDioxideSensor.Service.getCharacteristic(this.hap.Characteristic.CarbonDioxideLevel).setProps({ minStep: 1, }).onGet(() => { return this.CarbonDioxideSensor.CarbonDioxideLevel; }); } else { if (this.CarbonDioxideSensor) { this.debugLog('Removing Carbon Dioxide Sensor Service'); this.CarbonDioxideSensor.Service = this.accessory.getService(this.hap.Service.CarbonDioxideSensor); accessory.removeService(this.CarbonDioxideSensor.Service); } } // Retrieve initial values and updateHomekit try { this.debugLog('Retrieve initial values and update Homekit'); this.refreshStatus(); } catch (e) { this.errorLog(`failed to retrieve initial values and update Homekit, Error: ${e.message ?? e}`); } // regisiter webhook event handler if enabled try { this.debugLog('Registering Webhook Event Handler'); this.registerWebhook(); } catch (e) { this.errorLog(`failed to registerWebhook, Error: ${e.message ?? e}`); } // regisiter platform BLE event handler if enabled try { this.debugLog('Registering Platform BLE Event Handler'); this.registerPlatformBLE(); } catch (e) { this.errorLog(`failed to registerPlatformBLE, Error: ${e.message ?? e}`); } // Start an update interval interval(this.deviceRefreshRate * 1000) .pipe(skipWhile(() => this.meterUpdateInProgress)) .subscribe(async () => { await this.refreshStatus(); }); } async BLEparseStatus() { this.debugLog('BLEparseStatus'); this.debugLog(`(temperature, humidity${this.device.deviceType === 'MeterPro(CO2)' ? ', co2' : ''}) = BLE:(${this.serviceData.celsius}, ${this.serviceData.humidity}${this.device.deviceType === 'MeterPro(CO2)' ? `, ${this.serviceData.co2}` : ''}) current:(${this.TemperatureSensor?.CurrentTemperature}, ${this.HumiditySensor?.CurrentRelativeHumidity}${this.device.deviceType === 'MeterPro(CO2)' ? `, ${this.CarbonDioxideSensor?.CarbonDioxideLevel}` : ''})`); // CurrentRelativeHumidity if (!this.device.hide_humidity && this.HumiditySensor?.Service) { this.HumiditySensor.CurrentRelativeHumidity = validHumidity(this.serviceData.humidity, 0, 100); this.debugLog(`CurrentRelativeHumidity: ${this.HumiditySensor.CurrentRelativeHumidity}%`); } // Current Temperature if (!this.device.hide_temperature && this.TemperatureSensor?.Service) { const CELSIUS = this.serviceData.celsius < 0 ? 0 : this.serviceData.celsius > 100 ? 100 : this.serviceData.celsius; this.TemperatureSensor.CurrentTemperature = CELSIUS; this.debugLog(`CurrentTemperature: ${this.TemperatureSensor.CurrentTemperature}°c`); } // Carbon Dioxide Sensor if (!this.device.hide_co2 && this.CarbonDioxideSensor?.Service && this.device.deviceType === 'MeterPro(CO2)') { this.CarbonDioxideSensor.CarbonDioxideLevel = this.serviceData.co2; this.debugLog(`CarbonDioxideLevel: ${this.CarbonDioxideSensor.CarbonDioxideLevel}ppm`); this.CarbonDioxideSensor.CarbonDioxideDetected = this.CarbonDioxideSensor.CarbonDioxideLevel > 0 ? this.hap.Characteristic.CarbonDioxideDetected.CO2_LEVELS_ABNORMAL : this.hap.Characteristic.CarbonDioxideDetected.CO2_LEVELS_NORMAL; this.debugLog(`CarbonDioxideDetected: ${this.CarbonDioxideSensor.CarbonDioxideDetected}`); this.warnLog('Carbon Dioxide Sensor is not supported yet.'); } // Battery Info if ('battery' in this.serviceData) { // BatteryLevel this.Battery.BatteryLevel = this.serviceData.battery; this.debugLog(`BatteryLevel: ${this.Battery.BatteryLevel}`); // StatusLowBattery this.Battery.StatusLowBattery = this.Battery.BatteryLevel < 10 ? this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW : this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL; this.debugLog(`StatusLowBattery: ${this.Battery.StatusLowBattery}`); } } async openAPIparseStatus() { this.debugLog('openAPIparseStatus'); this.debugLog(`(temperature, humidity${this.device.deviceType === 'MeterPro(CO2)' ? ', co2' : ''}) = OpenAPI:(${this.deviceStatus.temperature}, ${this.deviceStatus.humidity}${this.device.deviceType === 'MeterPro(CO2)' ? `, ${this.deviceStatus.CO2}` : ''}) current:(${this.TemperatureSensor?.CurrentTemperature}, ${this.HumiditySensor?.CurrentRelativeHumidity}${this.device.deviceType === 'MeterPro(CO2)' ? `, ${this.CarbonDioxideSensor?.CarbonDioxideLevel}` : ''})`); // CurrentRelativeHumidity if (!this.device.hide_humidity && this.HumiditySensor?.Service) { this.HumiditySensor.CurrentRelativeHumidity = this.deviceStatus.humidity; this.debugLog(`CurrentRelativeHumidity: ${this.HumiditySensor.CurrentRelativeHumidity}%`); } // CurrentTemperature if (!this.device.hide_temperature && this.TemperatureSensor?.Service) { this.TemperatureSensor.CurrentTemperature = this.deviceStatus.temperature; this.debugLog(`CurrentTemperature: ${this.TemperatureSensor.CurrentTemperature}°c`); } // Carbon Dioxide Sensor this.warnLog(`(before, after) CarbonDioxideLevel: (${this.CarbonDioxideSensor?.CarbonDioxideLevel},${this.webhookContext.CO2})`); if (!this.device.hide_co2 && this.CarbonDioxideSensor?.Service && this.device.deviceType === 'MeterPro(CO2)') { this.CarbonDioxideSensor.CarbonDioxideLevel = this.deviceStatus.CO2; this.debugLog(`CarbonDioxideLevel: ${this.CarbonDioxideSensor.CarbonDioxideLevel}ppm`); this.CarbonDioxideSensor.CarbonDioxideDetected = this.CarbonDioxideSensor.CarbonDioxideLevel > 0 ? this.hap.Characteristic.CarbonDioxideDetected.CO2_LEVELS_ABNORMAL : this.hap.Characteristic.CarbonDioxideDetected.CO2_LEVELS_NORMAL; this.debugLog(`CarbonDioxideDetected: ${this.CarbonDioxideSensor.CarbonDioxideDetected}`); this.warnLog('Carbon Dioxide Sensor is not supported yet.'); } // Battery Info if ('battery' in this.deviceStatus) { // BatteryLevel this.Battery.BatteryLevel = this.deviceStatus.battery; this.debugLog(`BatteryLevel: ${this.Battery.BatteryLevel}`); // StatusLowBattery this.Battery.StatusLowBattery = this.Battery.BatteryLevel < 10 ? this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW : this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL; this.debugLog(`StatusLowBattery: ${this.Battery.StatusLowBattery}`); } // FirmwareVersion if (this.deviceStatus.version) { const version = this.deviceStatus.version; this.debugLog(`Firmware Version: ${version.replace(/^V|-.*$/g, '')}`); const deviceVersion = version.replace(/^V|-.*$/g, '') ?? '0.0.0'; this.accessory .getService(this.hap.Service.AccessoryInformation) .setCharacteristic(this.hap.Characteristic.HardwareRevision, deviceVersion) .setCharacteristic(this.hap.Characteristic.FirmwareRevision, deviceVersion) .getCharacteristic(this.hap.Characteristic.FirmwareRevision) .updateValue(deviceVersion); this.accessory.context.version = deviceVersion; this.debugSuccessLog(`v: ${this.accessory.context.version}`); } } async parseStatusWebhook() { this.debugLog('parseStatusWebhook'); this.debugLog(`(scale, temperature, humidity${this.device.deviceType === 'MeterPro(CO2)' ? ', co2' : ''}) = Webhook:(${this.webhookContext.scale}, ${convertUnits(this.webhookContext.temperature, this.webhookContext.scale, this.device.convertUnitTo)}, ${this.webhookContext.humidity}${this.device.deviceType === 'MeterPro(CO2)' ? `, ${this.webhookContext.CO2}` : ''}) current:(${this.TemperatureSensor?.CurrentTemperature}, ${this.HumiditySensor?.CurrentRelativeHumidity}${this.device.deviceType === 'MeterPro(CO2)' ? `, ${this.CarbonDioxideSensor?.CarbonDioxideLevel}` : ''})`); // Check if the scale is not CELSIUS if (this.webhookContext.scale !== 'CELSIUS' && this.device.convertUnitTo === undefined) { this.warnLog(`received a non-CELSIUS Webhook scale: ${this.webhookContext.scale}, Use the *convertUnitsTo* config under Hub settings, if displaying incorrectly in HomeKit.`); } // CurrentRelativeHumidity if (!this.device.hide_humidity && this.HumiditySensor?.Service) { this.HumiditySensor.CurrentRelativeHumidity = this.webhookContext.humidity; this.debugLog(`CurrentRelativeHumidity: ${this.HumiditySensor.CurrentRelativeHumidity}`); } // CurrentTemperature if (!this.device.hide_temperature && this.TemperatureSensor?.Service) { this.TemperatureSensor.CurrentTemperature = convertUnits(this.webhookContext.temperature, this.webhookContext.scale, this.device.convertUnitTo); this.debugLog(`CurrentTemperature: ${this.TemperatureSensor.CurrentTemperature}`); } // Carbon Dioxide Sensor this.warnLog(`(before, after) CarbonDioxideLevel: (${this.CarbonDioxideSensor?.CarbonDioxideLevel},${this.webhookContext.CO2})`); if (!this.device.hide_co2 && this.CarbonDioxideSensor?.Service && this.device.deviceType === 'MeterPro(CO2)') { this.CarbonDioxideSensor.CarbonDioxideLevel = this.webhookContext.CO2; this.debugLog(`CarbonDioxideLevel: ${this.CarbonDioxideSensor.CarbonDioxideLevel}ppm`); this.CarbonDioxideSensor.CarbonDioxideDetected = this.CarbonDioxideSensor.CarbonDioxideLevel > 0 ? this.hap.Characteristic.CarbonDioxideDetected.CO2_LEVELS_ABNORMAL : this.hap.Characteristic.CarbonDioxideDetected.CO2_LEVELS_NORMAL; this.debugLog(`CarbonDioxideDetected: ${this.CarbonDioxideSensor.CarbonDioxideDetected}`); this.warnLog('Carbon Dioxide Sensor is not supported yet.'); } } /** * Asks the SwitchBot API for the latest device information */ async refreshStatus() { if (!this.device.enableCloudService && this.OpenAPI) { this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`); } else if (this.BLE) { await this.BLERefreshStatus(); } else if (this.OpenAPI && this.platform.config.credentials?.token) { await this.openAPIRefreshStatus(); } else { await this.offlineOff(); this.debugWarnLog(`Connection Type: ${this.device.connectionType}, refreshStatus will not happen.`); } } async BLERefreshStatus() { this.debugLog('BLERefreshStatus'); const switchBotBLE = await this.switchbotBLE(); if (switchBotBLE === undefined) { await this.BLERefreshConnection(switchBotBLE); } else { // Start to monitor advertisement packets (async () => { // Start to monitor advertisement packets const serviceData = await this.monitorAdvertisementPackets(switchBotBLE); // Update HomeKit if (serviceData.model === SwitchBotBLEModel.MeterPro && serviceData.modelName === SwitchBotBLEModelName.MeterPro) { this.serviceData = serviceData; if (serviceData !== undefined || serviceData !== null) { await this.BLEparseStatus(); await this.updateHomeKitCharacteristics(); } else { this.errorLog(`serviceData is either undefined or null, serviceData: ${JSON.stringify(serviceData)}`); await this.BLERefreshConnection(switchBotBLE); } } else { this.errorLog(`failed to get serviceData, serviceData: ${JSON.stringify(serviceData)}`); await this.BLERefreshConnection(switchBotBLE); } })(); } } async registerPlatformBLE() { this.debugLog('registerPlatformBLE'); if (this.config.options?.BLE && !this.device.disablePlatformBLE) { this.debugLog('is listening to Platform BLE.'); try { const formattedDeviceId = formatDeviceIdAsMac(this.device.deviceId); this.device.bleMac = formattedDeviceId; this.debugLog(`bleMac: ${this.device.bleMac}`); this.platform.bleEventHandler[this.device.bleMac] = async (context) => { try { this.serviceData = context; if (context !== undefined || context !== null) { this.debugLog(`received BLE: ${JSON.stringify(context)}`); await this.BLEparseStatus(); await this.updateHomeKitCharacteristics(); } else { this.errorLog(`context is either undefined or null, context: ${JSON.stringify(context)}`); await this.BLERefreshConnection(context); } } catch (e) { this.errorLog(`failed to handle BLE. Received: ${JSON.stringify(context)} Error: ${e.message ?? e}`); } }; } catch (error) { this.errorLog(`failed to format device ID as MAC, Error: ${error}`); } } else { this.debugLog('is not listening to Platform BLE'); } } async openAPIRefreshStatus() { this.debugLog('openAPIRefreshStatus'); try { const response = await this.deviceRefreshStatus(); const deviceStatus = response.body; this.debugLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`); if (await this.successfulStatusCodes(deviceStatus)) { this.debugSuccessLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`); this.deviceStatus = deviceStatus.body; await this.openAPIparseStatus(); await this.updateHomeKitCharacteristics(); } else { this.debugWarnLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`); } } catch (e) { await this.apiError(e); this.errorLog(`failed openAPIRefreshStatus with ${this.device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`); } } async registerWebhook() { if (this.device.webhook) { this.debugLog('is listening webhook.'); this.platform.webhookEventHandler[this.device.deviceId] = async (context) => { try { this.webhookContext = context; if (context !== undefined || context !== null) { this.debugLog(`received Webhook: ${JSON.stringify(context)}`); await this.parseStatusWebhook(); await this.updateHomeKitCharacteristics(); } else { this.errorLog(`context is either undefined or null, context: ${JSON.stringify(context)}`); } } catch (e) { this.errorLog(`failed to handle webhook. Received: ${JSON.stringify(context)} Error: ${e.message ?? e}`); } }; } else { this.debugLog('is not listening webhook.'); } } /** * Updates the status for each of the HomeKit Characteristics */ async updateHomeKitCharacteristics() { // CurrentRelativeHumidity if (!this.device.hide_humidity && this.HumiditySensor?.Service) { await this.updateCharacteristic(this.HumiditySensor.Service, this.hap.Characteristic.CurrentRelativeHumidity, this.HumiditySensor.CurrentRelativeHumidity, 'CurrentRelativeHumidity'); } // CurrentTemperature if (!this.device.hide_temperature && this.TemperatureSensor?.Service) { await this.updateCharacteristic(this.TemperatureSensor.Service, this.hap.Characteristic.CurrentTemperature, this.TemperatureSensor.CurrentTemperature, 'CurrentTemperature'); } // BatteryLevel await this.updateCharacteristic(this.Battery.Service, this.hap.Characteristic.BatteryLevel, this.Battery.BatteryLevel, 'BatteryLevel'); // StatusLowBattery await this.updateCharacteristic(this.Battery.Service, this.hap.Characteristic.StatusLowBattery, this.Battery.StatusLowBattery, 'StatusLowBattery'); } async BLERefreshConnection(switchbot) { this.errorLog(`wasn't able to establish BLE Connection, node-switchbot: ${switchbot}`); if (this.platform.config.credentials?.token && this.device.connectionType === 'BLE/OpenAPI') { this.warnLog('Using OpenAPI Connection to Refresh Status'); await this.openAPIRefreshStatus(); } } async offlineOff() { if (this.device.offline) { if (!this.device.hide_humidity && this.HumiditySensor?.Service) { this.HumiditySensor.Service.updateCharacteristic(this.hap.Characteristic.CurrentRelativeHumidity, 50); } if (!this.device.hide_temperature && this.TemperatureSensor?.Service) { this.TemperatureSensor.Service.updateCharacteristic(this.hap.Characteristic.CurrentTemperature, 30); } this.Battery.Service.updateCharacteristic(this.hap.Characteristic.BatteryLevel, 100); this.Battery.Service.updateCharacteristic(this.hap.Characteristic.StatusLowBattery, this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL); } } async apiError(e) { if (!this.device.hide_humidity && this.HumiditySensor?.Service) { this.HumiditySensor.Service.updateCharacteristic(this.hap.Characteristic.CurrentRelativeHumidity, e); } if (!this.device.hide_temperature && this.TemperatureSensor?.Service) { this.TemperatureSensor.Service.updateCharacteristic(this.hap.Characteristic.CurrentTemperature, e); } this.Battery.Service.updateCharacteristic(this.hap.Characteristic.BatteryLevel, e); this.Battery.Service.updateCharacteristic(this.hap.Characteristic.StatusLowBattery, e); } } //# sourceMappingURL=meterpro.js.map