Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 | 1x 1x 1x 1x 1x | /* Copyright(C) 2021-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
*
* humidifier.ts: @switchbot/homebridge-switchbot.
*/
import type { CharacteristicValue, PlatformAccessory, Service } from 'homebridge'
import type { bodyChange, device, humidifier2ServiceData, humidifier2Status, humidifier2WebhookContext, humidifierServiceData, humidifierStatus, humidifierWebhookContext, SwitchBotBLE, SwitchbotDevice, WoHumi } from 'node-switchbot'
import type { SwitchBotPlatform } from '../platform.js'
import type { devicesConfig, humidifierConfig } from '../settings.js'
/*
* For Testing Locally:
* import { SwitchBotBLEModel, SwitchBotBLEModelName } from '/Users/Shared/GitHub/OpenWonderLabs/node-switchbot/dist/index.js';
*/
import { SwitchBotBLEModel, SwitchBotBLEModelName } from 'node-switchbot'
import { debounceTime, interval, skipWhile, Subject, take, tap } 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 Humidifier extends deviceBase {
// Services
private HumidifierDehumidifier: {
Name: CharacteristicValue
Service: Service
Active: CharacteristicValue
WaterLevel: CharacteristicValue
CurrentRelativeHumidity: CharacteristicValue
TargetHumidifierDehumidifierState: CharacteristicValue
CurrentHumidifierDehumidifierState: CharacteristicValue
RelativeHumidityHumidifierThreshold: CharacteristicValue
}
private TemperatureSensor?: {
Name: CharacteristicValue
Service: Service
CurrentTemperature: CharacteristicValue
}
// OpenAPI
deviceStatus!: humidifierStatus | humidifier2Status
// Webhook
webhookContext!: humidifierWebhookContext | humidifier2WebhookContext
// BLE
serviceData!: humidifierServiceData | humidifier2ServiceData
// Updates
humidifierUpdateInProgress!: boolean
doHumidifierUpdate!: Subject<void>
constructor(
readonly platform: SwitchBotPlatform,
accessory: PlatformAccessory,
device: device & devicesConfig,
) {
super(platform, accessory, device)
// Set category
accessory.category = this.hap.Categories.AIR_HUMIDIFIER
// this is subject we use to track when we need to POST changes to the SwitchBot API
this.doHumidifierUpdate = new Subject()
this.humidifierUpdateInProgress = false
// Initialize the HumidifierDehumidifier Service
accessory.context.HumidifierDehumidifier = accessory.context.HumidifierDehumidifier ?? {}
this.HumidifierDehumidifier = {
Name: accessory.displayName,
Service: accessory.getService(this.hap.Service.HumidifierDehumidifier) ?? accessory.addService(this.hap.Service.HumidifierDehumidifier) as Service,
Active: accessory.context.Active ?? this.hap.Characteristic.Active.ACTIVE,
WaterLevel: accessory.context.WaterLevel ?? 100,
CurrentRelativeHumidity: accessory.context.CurrentRelativeHumidity ?? 50,
TargetHumidifierDehumidifierState: accessory.context.TargetHumidifierDehumidifierState ?? this.hap.Characteristic.TargetHumidifierDehumidifierState.HUMIDIFIER,
CurrentHumidifierDehumidifierState: accessory.context.CurrentHumidifierDehumidifierState ?? this.hap.Characteristic.CurrentHumidifierDehumidifierState.INACTIVE,
RelativeHumidityHumidifierThreshold: accessory.context.RelativeHumidityHumidifierThreshold ?? 50,
}
accessory.context.HumidifierDehumidifier = this.HumidifierDehumidifier as object
// Initialize the HumidifierDehumidifier Characteristics
this.HumidifierDehumidifier.Service.setCharacteristic(this.hap.Characteristic.Name, this.HumidifierDehumidifier.Name).setCharacteristic(this.hap.Characteristic.CurrentHumidifierDehumidifierState, this.HumidifierDehumidifier.CurrentHumidifierDehumidifierState).getCharacteristic(this.hap.Characteristic.TargetHumidifierDehumidifierState).setProps({
validValueRanges: [0, 1],
minValue: 0,
maxValue: 1,
validValues: [0, 1],
}).onGet(() => {
return this.HumidifierDehumidifier.TargetHumidifierDehumidifierState
}).onSet(this.TargetHumidifierDehumidifierStateSet.bind(this))
this.HumidifierDehumidifier.Service.getCharacteristic(this.hap.Characteristic.Active).onGet(() => {
return this.HumidifierDehumidifier.Active
}).onSet(this.ActiveSet.bind(this))
this.HumidifierDehumidifier.Service.getCharacteristic(this.hap.Characteristic.RelativeHumidityHumidifierThreshold).setProps({
validValueRanges: [0, 100],
minValue: 0,
maxValue: 100,
minStep: (device as humidifierConfig).set_minStep ?? 1,
}).onGet(() => {
return this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold
}).onSet(this.RelativeHumidityHumidifierThresholdSet.bind(this))
// Initialize the Temperature Sensor Service
if ((device as humidifierConfig).hide_temperature) {
if (this.TemperatureSensor) {
this.debugLog('Removing Temperature Sensor Service')
this.TemperatureSensor!.Service = this.accessory.getService(this.hap.Service.TemperatureSensor) as Service
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) as Service,
CurrentTemperature: accessory.context.CurrentTemperature || 30,
}
accessory.context.TemperatureSensor = this.TemperatureSensor as object
// Initialize the Temperature Sensor Characteristics
this.TemperatureSensor.Service.setCharacteristic(this.hap.Characteristic.Name, this.TemperatureSensor.Name).getCharacteristic(this.hap.Characteristic.CurrentTemperature).setProps({
validValueRanges: [-273.15, 100],
minValue: -273.15,
maxValue: 100,
minStep: 0.1,
}).onGet(() => {
return this.TemperatureSensor!.CurrentTemperature
})
}
// Retrieve initial values and updateHomekit
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.message ?? e}`)
}
// regisiter webhook event handler if enabled
try {
this.debugLog('Registering Webhook Event Handler')
this.registerWebhook()
} catch (e: any) {
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: any) {
this.errorLog(`failed to registerPlatformBLE, Error: ${e.message ?? e}`)
}
// Start an update interval
interval(this.deviceRefreshRate * 1000)
.pipe(skipWhile(() => this.humidifierUpdateInProgress))
.subscribe(async () => {
await this.refreshStatus()
})
// Watch for Humidifier change events
// We put in a debounce of 100ms so we don't make duplicate calls
this.doHumidifierUpdate
.pipe(
tap(() => {
this.humidifierUpdateInProgress = true
}),
debounceTime(this.devicePushRate * 1000),
)
.subscribe(async () => {
try {
await this.pushChanges()
} catch (e: any) {
await this.apiError(e)
this.errorLog(`failed pushChanges with ${device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`)
}
this.humidifierUpdateInProgress = false
})
}
async BLEparseStatus(): Promise<void> {
this.debugLog('BLEparseStatus')
this.debugLog(`(onState, percentage, autoMode) = BLE:(${this.serviceData.onState}, ${this.serviceData.percentage}, ${this.serviceData.autoMode}), current:(${this.HumidifierDehumidifier.Active}, ${this.HumidifierDehumidifier.CurrentRelativeHumidity}, ${this.HumidifierDehumidifier.TargetHumidifierDehumidifierState}, ${this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold})`,
)
// Active
this.HumidifierDehumidifier.Active = this.serviceData.onState ? this.hap.Characteristic.Active.ACTIVE : this.hap.Characteristic.Active.INACTIVE
this.debugLog(`Active: ${this.HumidifierDehumidifier.Active}`)
// Current Relative Humidity
this.HumidifierDehumidifier.CurrentRelativeHumidity = validHumidity(this.serviceData.humidity)
this.debugLog(`CurrentRelativeHumidity: ${this.HumidifierDehumidifier.CurrentRelativeHumidity}`)
// Target Humidifier Dehumidifier State
switch (this.serviceData.autoMode) {
case true:
this.HumidifierDehumidifier.TargetHumidifierDehumidifierState
= this.hap.Characteristic.TargetHumidifierDehumidifierState.HUMIDIFIER_OR_DEHUMIDIFIER
this.HumidifierDehumidifier.CurrentHumidifierDehumidifierState = this.hap.Characteristic.CurrentHumidifierDehumidifierState.HUMIDIFYING
this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold = this.HumidifierDehumidifier.CurrentRelativeHumidity
break
default:
this.HumidifierDehumidifier.TargetHumidifierDehumidifierState = this.hap.Characteristic.TargetHumidifierDehumidifierState.HUMIDIFIER
this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold = this.serviceData.percentage > 100 ? 100 : this.serviceData.percentage
if (this.HumidifierDehumidifier.CurrentRelativeHumidity > this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold) {
this.HumidifierDehumidifier.CurrentHumidifierDehumidifierState = this.hap.Characteristic.CurrentHumidifierDehumidifierState.IDLE
} else if (this.HumidifierDehumidifier.Active === this.hap.Characteristic.Active.INACTIVE) {
this.HumidifierDehumidifier.CurrentHumidifierDehumidifierState = this.hap.Characteristic.CurrentHumidifierDehumidifierState.INACTIVE
} else {
this.HumidifierDehumidifier.CurrentHumidifierDehumidifierState = this.hap.Characteristic.CurrentHumidifierDehumidifierState.HUMIDIFYING
}
}
this.debugLog(`TargetHumidifierDehumidifierState: ${this.HumidifierDehumidifier.TargetHumidifierDehumidifierState}, RelativeHumidityHumidifierThreshold: ${this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold}, CurrentHumidifierDehumidifierState: ${this.HumidifierDehumidifier.CurrentHumidifierDehumidifierState}`)
}
async openAPIparseStatus(): Promise<void> {
this.debugLog('openAPIparseStatus')
this.debugLog(`(power, auto, temperature, lackWater, nebulizationEfficiency, version) = OpenAPI:(${this.deviceStatus.power}, ${this.deviceStatus.auto}, ${this.deviceStatus.temperature}, ${this.deviceStatus.lackWater}, ${this.deviceStatus.nebulizationEfficiency}, ${this.deviceStatus.version}), current:(${this.HumidifierDehumidifier.Active}, ${this.HumidifierDehumidifier.CurrentRelativeHumidity}, ${this.HumidifierDehumidifier.TargetHumidifierDehumidifierState}, ${this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold})`)
// Active
this.HumidifierDehumidifier.Active = this.deviceStatus.power === 'on'
? this.hap.Characteristic.Active.ACTIVE
: this.hap.Characteristic.Active.INACTIVE
this.debugLog(`Active: ${this.HumidifierDehumidifier.Active}`)
// Current Relative Humidity
this.HumidifierDehumidifier.CurrentRelativeHumidity = validHumidity(this.deviceStatus.humidity)
this.debugLog(`CurrentRelativeHumidity: ${this.HumidifierDehumidifier.CurrentRelativeHumidity}`)
// Current Temperature
if (!(this.device as humidifierConfig).hide_temperature && this.TemperatureSensor?.Service) {
this.TemperatureSensor.CurrentTemperature = this.deviceStatus.temperature
this.debugLog(`CurrentTemperature: ${this.TemperatureSensor.CurrentTemperature}`)
}
// Target Humidifier Dehumidifier State
switch (this.deviceStatus.auto) {
case true:
this.HumidifierDehumidifier.TargetHumidifierDehumidifierState
= this.hap.Characteristic.TargetHumidifierDehumidifierState.HUMIDIFIER_OR_DEHUMIDIFIER
this.HumidifierDehumidifier.CurrentHumidifierDehumidifierState = this.hap.Characteristic.CurrentHumidifierDehumidifierState.HUMIDIFYING
this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold = this.HumidifierDehumidifier.CurrentRelativeHumidity
break
default:
this.HumidifierDehumidifier.TargetHumidifierDehumidifierState = this.hap.Characteristic.TargetHumidifierDehumidifierState.HUMIDIFIER
this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold = this.deviceStatus.nebulizationEfficiency > 100
? 100
: this.deviceStatus.nebulizationEfficiency
if (this.HumidifierDehumidifier.CurrentRelativeHumidity > this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold) {
this.HumidifierDehumidifier.CurrentHumidifierDehumidifierState = this.hap.Characteristic.CurrentHumidifierDehumidifierState.IDLE
} else if (this.HumidifierDehumidifier.Active === this.hap.Characteristic.Active.INACTIVE) {
this.HumidifierDehumidifier.CurrentHumidifierDehumidifierState = this.hap.Characteristic.CurrentHumidifierDehumidifierState.INACTIVE
} else {
this.HumidifierDehumidifier.CurrentHumidifierDehumidifierState = this.hap.Characteristic.CurrentHumidifierDehumidifierState.HUMIDIFYING
}
}
this.debugLog(`TargetHumidifierDehumidifierState: ${this.HumidifierDehumidifier.TargetHumidifierDehumidifierState}, RelativeHumidityHumidifierThreshold: ${this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold}, CurrentHumidifierDehumidifierState: ${this.HumidifierDehumidifier.CurrentHumidifierDehumidifierState}`)
// Water Level
if (this.deviceStatus.lackWater) {
this.HumidifierDehumidifier.WaterLevel = 0
} else {
this.HumidifierDehumidifier.WaterLevel = 100
}
this.debugLog(`WaterLevel: ${this.HumidifierDehumidifier.WaterLevel}`)
// Firmware Version
if (this.deviceStatus.version) {
const version = this.deviceStatus.version.toString()
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(`version: ${this.accessory.context.version}`)
}
}
async parseStatusWebhook(): Promise<void> {
this.debugLog('parseStatusWebhook')
this.debugLog(`(temperature, humidity) = Webhook:(${convertUnits(this.webhookContext.temperature, this.webhookContext.scale, (this.device as humidifierConfig).convertUnitTo)}, ${this.webhookContext.humidity}), current:(${this.TemperatureSensor?.CurrentTemperature}, ${this.HumidifierDehumidifier.CurrentRelativeHumidity})`)
// CurrentRelativeHumidity
this.HumidifierDehumidifier.CurrentRelativeHumidity = validHumidity(this.webhookContext.humidity)
this.debugLog(`CurrentRelativeHumidity: ${this.HumidifierDehumidifier.CurrentRelativeHumidity}`)
// CurrentTemperature
if (!(this.device as humidifierConfig).hide_temperature && this.TemperatureSensor?.Service) {
this.TemperatureSensor.CurrentTemperature = convertUnits(this.webhookContext.temperature, this.webhookContext.scale, (this.device as humidifierConfig).convertUnitTo)
this.debugLog(`CurrentTemperature: ${this.TemperatureSensor.CurrentTemperature}`)
}
}
/**
* Asks the SwitchBot API for the latest device information
*/
async refreshStatus(): Promise<void> {
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(): Promise<void> {
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) as humidifierServiceData | humidifier2ServiceData
// Update HomeKit
if (serviceData.model === SwitchBotBLEModel.Humidifier && serviceData.modelName === SwitchBotBLEModelName.Humidifier) {
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(): Promise<void> {
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: humidifierServiceData | humidifier2ServiceData) => {
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: any) {
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(): Promise<void> {
this.debugLog('openAPIRefreshStatus')
try {
const response = await this.deviceRefreshStatus()
const deviceStatus: any = 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: any) {
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: humidifierWebhookContext | humidifier2WebhookContext) => {
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: any) {
this.errorLog(`failed to handle webhook. Received: ${JSON.stringify(context)} Error: ${e.message ?? e}`)
}
}
}
}
/**
* Pushes the requested changes to the SwitchBot API
*/
async pushChanges(): Promise<void> {
if (!this.device.enableCloudService && this.OpenAPI) {
this.errorLog(`pushChanges enableCloudService: ${this.device.enableCloudService}`)
} else if (this.BLE) {
await this.BLEpushChanges()
} else if (this.OpenAPI && this.platform.config.credentials?.token) {
await this.openAPIpushChanges()
} else {
await this.offlineOff()
this.debugWarnLog(`Connection Type: ${this.device.connectionType}, pushChanges will not happen.`)
}
// Refresh the status from the API
interval(15000)
.pipe(skipWhile(() => this.humidifierUpdateInProgress))
.pipe(take(1))
.subscribe(async () => {
await this.refreshStatus()
})
}
async BLEpushChanges(): Promise<void> {
this.debugLog('BLEpushChanges')
if ((this.HumidifierDehumidifier.TargetHumidifierDehumidifierState === this.hap.Characteristic.TargetHumidifierDehumidifierState.HUMIDIFIER)
&& (this.HumidifierDehumidifier.Active === this.hap.Characteristic.Active.ACTIVE)
&& (this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold !== this.HumidifierDehumidifier.CurrentRelativeHumidity)) {
const switchBotBLE = await this.platform.connectBLE(this.accessory, this.device)
try {
const formattedDeviceId = formatDeviceIdAsMac(this.device.deviceId)
this.device.bleMac = formattedDeviceId
this.debugLog(`bleMac: ${this.device.bleMac}`)
if (switchBotBLE !== false) {
switchBotBLE
.discover({ model: this.device.bleModel, quick: true, id: this.device.bleMac })
.then(async (device_list: SwitchbotDevice[]) => {
return await (device_list[0] as WoHumi).percentage(Number(this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold))
})
.then(async () => {
this.successLog(`RelativeHumidityHumidifierThreshold: ${this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold} sent over BLE, sent successfully`)
await this.updateHomeKitCharacteristics()
})
.catch(async (e: any) => {
await this.apiError(e)
this.errorLog(`failed BLEpushChanges with ${this.device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`)
await this.BLEPushConnection()
})
} else {
this.errorLog(`wasn't able to establish BLE Connection, node-switchbot: ${JSON.stringify(switchBotBLE)}`)
await this.BLEPushConnection()
}
} catch (error) {
this.errorLog(`failed to format device ID as MAC, Error: ${error}`)
}
} else {
this.debugLog(`No changes (BLEpushChanges), Active: ${this.HumidifierDehumidifier.Active}, RelativeHumidityHumidifierThreshold: ${this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold}, CurrentRelativeHumidity: ${this.HumidifierDehumidifier.CurrentRelativeHumidity}`)
}
}
async openAPIpushChanges(): Promise<void> {
this.debugLog('openAPIpushChanges')
if ((this.HumidifierDehumidifier.TargetHumidifierDehumidifierState === this.hap.Characteristic.TargetHumidifierDehumidifierState.HUMIDIFIER)
&& (this.HumidifierDehumidifier.Active === this.hap.Characteristic.Active.ACTIVE)
&& (this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold !== this.HumidifierDehumidifier.CurrentRelativeHumidity)) {
this.debugLog(`Auto Off, RelativeHumidityHumidifierThreshold: ${this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold}!`)
const bodyChange: bodyChange = {
command: 'setMode',
parameter: `${this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold}`,
commandType: 'command',
}
this.debugLog(`SwitchBot OpenAPI bodyChange: ${JSON.stringify(bodyChange)}`)
try {
const response = await this.pushChangeRequest(bodyChange)
const deviceStatus: any = 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)}`)
await this.updateHomeKitCharacteristics()
} else {
await this.statusCode(deviceStatus.statusCode)
}
} catch (e: any) {
await this.apiError(e)
this.errorLog(`failed openAPIpushChanges with ${this.device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`)
}
} else if ((this.HumidifierDehumidifier.TargetHumidifierDehumidifierState === this.hap.Characteristic.TargetHumidifierDehumidifierState.HUMIDIFIER_OR_DEHUMIDIFIER) && (this.HumidifierDehumidifier.Active === this.hap.Characteristic.Active.ACTIVE)) {
await this.pushAutoChanges()
} else {
await this.pushActiveChanges()
}
}
/**
* Pushes the requested changes to the SwitchBot API
*/
async pushAutoChanges(): Promise<void> {
this.debugLog('pushAutoChanges')
if ((this.HumidifierDehumidifier.TargetHumidifierDehumidifierState === this.hap.Characteristic.TargetHumidifierDehumidifierState.HUMIDIFIER_OR_DEHUMIDIFIER) && (this.HumidifierDehumidifier.Active === this.hap.Characteristic.Active.ACTIVE)) {
this.debugLog('Pushing Auto')
const bodyChange: bodyChange = {
command: 'setMode',
parameter: 'auto',
commandType: 'command',
}
this.debugLog(`pushAutoChanges, SwitchBot OpenAPI bodyChange: ${JSON.stringify(bodyChange)}`)
try {
const response = await this.pushChangeRequest(bodyChange)
const deviceStatus: any = 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)}`)
await this.updateHomeKitCharacteristics()
} else {
await this.statusCode(deviceStatus.statusCode)
}
} catch (e: any) {
await this.apiError(e)
this.errorLog(`failed pushAutoChanges with ${this.device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`)
}
} else {
this.debugLog(`No changes (pushAutoChanges), TargetHumidifierDehumidifierState: ${this.HumidifierDehumidifier.TargetHumidifierDehumidifierState}, Active: ${this.HumidifierDehumidifier.Active}`)
}
}
/**
* Pushes the requested changes to the SwitchBot API
*/
async pushActiveChanges(): Promise<void> {
this.debugLog('pushActiveChanges')
if (this.HumidifierDehumidifier.Active === this.hap.Characteristic.Active.INACTIVE) {
this.debugLog('Pushing Off')
const bodyChange: bodyChange = {
command: 'turnOff',
parameter: 'default',
commandType: 'command',
}
this.debugLog(`pushActiveChanges, SwitchBot OpenAPI bodyChange: ${JSON.stringify(bodyChange)}`)
try {
const response = await this.pushChangeRequest(bodyChange)
const deviceStatus: any = 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)}`)
await this.updateHomeKitCharacteristics()
} else {
await this.statusCode(deviceStatus.statusCode)
}
} catch (e: any) {
await this.apiError(e)
this.errorLog(`failed pushActiveChanges with ${this.device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`)
}
} else {
this.debugLog(`No changes (pushActiveChanges), Active: ${this.HumidifierDehumidifier.Active}`)
}
}
/**
* Handle requests to set the "Active" characteristic
*/
async ActiveSet(value: CharacteristicValue): Promise<void> {
if (this.HumidifierDehumidifier.Active !== this.accessory.context.Active) {
this.infoLog(`Set Active: ${value}`)
} else {
this.debugLog(`No Changes, Active: ${value}`)
}
this.HumidifierDehumidifier.Active = value
this.doHumidifierUpdate.next()
}
/**
* Handle requests to set the "Target Humidifier Dehumidifier State" characteristic
*/
async TargetHumidifierDehumidifierStateSet(value: CharacteristicValue): Promise<void> {
if (this.HumidifierDehumidifier.Active === this.hap.Characteristic.Active.ACTIVE) {
this.infoLog(`Set TargetHumidifierDehumidifierState: ${value}`)
} else {
this.debugLog(`No Changes, TargetHumidifierDehumidifierState: ${value}`)
}
this.HumidifierDehumidifier.TargetHumidifierDehumidifierState = value
this.doHumidifierUpdate.next()
}
/**
* Handle requests to set the "Relative Humidity Humidifier Threshold" characteristic
*/
async RelativeHumidityHumidifierThresholdSet(value: CharacteristicValue): Promise<void> {
if (this.HumidifierDehumidifier.Active === this.hap.Characteristic.Active.ACTIVE) {
this.infoLog(`Set RelativeHumidityHumidifierThreshold: ${value}`)
} else {
this.debugLog(`No Changes, RelativeHumidityHumidifierThreshold: ${value}`)
}
// If the Humidifier is off, turn it on
if (this.HumidifierDehumidifier.Active === this.hap.Characteristic.Active.INACTIVE) {
this.HumidifierDehumidifier.Active = this.hap.Characteristic.Active.ACTIVE
this.HumidifierDehumidifier.CurrentHumidifierDehumidifierState = this.hap.Characteristic.CurrentHumidifierDehumidifierState.IDLE
}
this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold = value
this.doHumidifierUpdate.next()
}
/**
* Updates the status for each of the HomeKit Characteristics
*/
async updateHomeKitCharacteristics(): Promise<void> {
// CurrentRelativeHumidity
await this.updateCharacteristic(this.HumidifierDehumidifier.Service, this.hap.Characteristic.CurrentRelativeHumidity, this.HumidifierDehumidifier.CurrentRelativeHumidity, 'CurrentRelativeHumidity')
// WaterLevel
await this.updateCharacteristic(this.HumidifierDehumidifier.Service, this.hap.Characteristic.WaterLevel, this.HumidifierDehumidifier.WaterLevel, 'WaterLevel')
// CurrentHumidifierDehumidifierState
await this.updateCharacteristic(this.HumidifierDehumidifier.Service, this.hap.Characteristic.CurrentHumidifierDehumidifierState, this.HumidifierDehumidifier.CurrentHumidifierDehumidifierState, 'CurrentHumidifierDehumidifierState')
// TargetHumidifierDehumidifierState
await this.updateCharacteristic(this.HumidifierDehumidifier.Service, this.hap.Characteristic.TargetHumidifierDehumidifierState, this.HumidifierDehumidifier.TargetHumidifierDehumidifierState, 'TargetHumidifierDehumidifierState')
// Active
await this.updateCharacteristic(this.HumidifierDehumidifier.Service, this.hap.Characteristic.Active, this.HumidifierDehumidifier.Active, 'Active')
// RelativeHumidityHumidifierThreshold
await this.updateCharacteristic(this.HumidifierDehumidifier.Service, this.hap.Characteristic.RelativeHumidityHumidifierThreshold, this.HumidifierDehumidifier.RelativeHumidityHumidifierThreshold, 'RelativeHumidityHumidifierThreshold')
// CurrentTemperature
if (!(this.device as humidifierConfig).hide_temperature && this.TemperatureSensor?.Service) {
await this.updateCharacteristic(this.TemperatureSensor.Service, this.hap.Characteristic.CurrentTemperature, this.TemperatureSensor.CurrentTemperature, 'CurrentTemperature')
}
}
async BLEPushConnection() {
if (this.platform.config.credentials?.token && this.device.connectionType === 'BLE/OpenAPI') {
this.warnLog('Using OpenAPI Connection to Push Changes')
await this.openAPIpushChanges()
}
}
async BLERefreshConnection(switchbot: SwitchBotBLE): Promise<void> {
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(): Promise<void> {
if (this.device.offline) {
this.HumidifierDehumidifier.Service.updateCharacteristic(this.hap.Characteristic.CurrentHumidifierDehumidifierState, this.hap.Characteristic.CurrentHumidifierDehumidifierState.INACTIVE)
this.HumidifierDehumidifier.Service.updateCharacteristic(this.hap.Characteristic.TargetHumidifierDehumidifierState, this.hap.Characteristic.TargetHumidifierDehumidifierState.HUMIDIFIER)
this.HumidifierDehumidifier.Service.updateCharacteristic(this.hap.Characteristic.Active, this.hap.Characteristic.Active.INACTIVE)
}
}
async apiError(e: any): Promise<void> {
this.HumidifierDehumidifier.Service.updateCharacteristic(this.hap.Characteristic.CurrentRelativeHumidity, e)
this.HumidifierDehumidifier.Service.updateCharacteristic(this.hap.Characteristic.WaterLevel, e)
this.HumidifierDehumidifier.Service.updateCharacteristic(this.hap.Characteristic.CurrentHumidifierDehumidifierState, e)
this.HumidifierDehumidifier.Service.updateCharacteristic(this.hap.Characteristic.TargetHumidifierDehumidifierState, e)
this.HumidifierDehumidifier.Service.updateCharacteristic(this.hap.Characteristic.Active, e)
this.HumidifierDehumidifier.Service.updateCharacteristic(this.hap.Characteristic.RelativeHumidityHumidifierThreshold, e)
if (!(this.device as humidifierConfig).hide_temperature && this.TemperatureSensor?.Service) {
this.TemperatureSensor.Service.updateCharacteristic(this.hap.Characteristic.CurrentTemperature, e)
}
}
}
|