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 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 | 1x 1x 1x 1x 1x 1x | /* Copyright(C) 2021-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
*
* curtain.ts: @switchbot/homebridge-switchbot.
*/
import type { CharacteristicChange, CharacteristicValue, PlatformAccessory, Service } from 'homebridge'
import type { bodyChange, curtain3ServiceData, curtain3WebhookContext, curtainServiceData, curtainStatus, curtainWebhookContext, device, SwitchBotBLE, SwitchbotDevice, WoCurtain } from 'node-switchbot'
import type { SwitchBotPlatform } from '../platform.js'
import type { curtainConfig, devicesConfig } from '../settings.js'
import { hostname } from 'node:os'
/*
* 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 { formatDeviceIdAsMac, isCurtainDevice } from '../utils.js'
import { deviceBase } from './device.js'
export class Curtain extends deviceBase {
// Services
private WindowCovering: {
Name: CharacteristicValue
Service: Service
PositionState: CharacteristicValue
TargetPosition: CharacteristicValue
CurrentPosition: CharacteristicValue
HoldPosition: CharacteristicValue
}
private Battery: {
Name: CharacteristicValue
Service: Service
BatteryLevel: CharacteristicValue
StatusLowBattery: CharacteristicValue
ChargingState: CharacteristicValue
}
private LightSensor?: {
Name: CharacteristicValue
Service: Service
CurrentAmbientLightLevel?: CharacteristicValue
}
private OpenModeSwitch?: {
Name: string
Service: Service
On: CharacteristicValue
}
private CloseModeSwitch?: {
Name: string
Service: Service
On: CharacteristicValue
}
// OpenAPI
deviceStatus!: curtainStatus
// Webhook
webhookContext!: curtainWebhookContext | curtain3WebhookContext
// BLE
serviceData!: curtainServiceData | curtain3ServiceData
// Target
hasLoggedStandby!: boolean
setNewTarget!: boolean
setNewTargetTimer!: NodeJS.Timeout
// Updates
curtainMoving!: boolean
curtainUpdateInProgress!: boolean
doCurtainUpdate!: Subject<void>
constructor(
readonly platform: SwitchBotPlatform,
accessory: PlatformAccessory,
device: device & devicesConfig,
) {
super(platform, accessory, device)
// Set category
accessory.category = this.hap.Categories.WINDOW_COVERING
// this is subject we use to track when we need to POST changes to the SwitchBot API
this.doCurtainUpdate = new Subject()
this.curtainMoving = false
this.curtainUpdateInProgress = false
this.setNewTarget = false
// Initialize WindowCovering Service
accessory.context.WindowCovering = accessory.context.WindowCovering ?? {}
this.WindowCovering = {
Name: accessory.displayName,
Service: accessory.getService(this.hap.Service.WindowCovering) ?? accessory.addService(this.hap.Service.WindowCovering) as Service,
PositionState: accessory.context.PositionState ?? this.hap.Characteristic.PositionState.STOPPED,
TargetPosition: accessory.context.TargetPosition ?? 100,
CurrentPosition: accessory.context.CurrentPosition ?? 100,
HoldPosition: accessory.context.HoldPosition ?? false,
}
accessory.context.WindowCovering = this.WindowCovering as object
// Initialize WindowCovering Service
this.WindowCovering.Service.setCharacteristic(this.hap.Characteristic.Name, this.WindowCovering.Name).setCharacteristic(this.hap.Characteristic.ObstructionDetected, false).getCharacteristic(this.hap.Characteristic.PositionState).onGet(() => {
return this.WindowCovering.PositionState
})
// Initialize WindowCovering CurrentPosition
this.WindowCovering.Service.getCharacteristic(this.hap.Characteristic.CurrentPosition).setProps({
minStep: (device as curtainConfig).set_minStep ?? 1,
minValue: 0,
maxValue: 100,
validValueRanges: [0, 100],
}).onGet(() => {
return this.WindowCovering.CurrentPosition
})
// Initialize WindowCovering TargetPosition
this.WindowCovering.Service.getCharacteristic(this.hap.Characteristic.TargetPosition).setProps({
minStep: (device as curtainConfig).set_minStep ?? 1,
minValue: 0,
maxValue: 100,
validValueRanges: [0, 100],
}).onGet(() => {
return this.WindowCovering.TargetPosition
}).onSet(this.TargetPositionSet.bind(this))
// Initialize WindowCovering TargetPosition
this.WindowCovering.Service.getCharacteristic(this.hap.Characteristic.HoldPosition).onGet(() => {
return this.WindowCovering.HoldPosition
}).onSet(this.HoldPositionSet.bind(this))
// 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) as Service,
BatteryLevel: accessory.context.BatteryLevel ?? 100,
StatusLowBattery: accessory.context.StatusLowBattery ?? this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL,
ChargingState: accessory.context.ChargingState ?? this.hap.Characteristic.ChargingState.NOT_CHARGING,
}
accessory.context.Battery = this.Battery as object
// Initialize Battery Service
this.Battery.Service.setCharacteristic(this.hap.Characteristic.Name, this.Battery.Name).getCharacteristic(this.hap.Characteristic.BatteryLevel).onGet(() => {
return this.Battery.BatteryLevel
})
this.Battery.Service.getCharacteristic(this.hap.Characteristic.StatusLowBattery).onGet(() => {
return this.Battery.StatusLowBattery
})
this.Battery.Service.getCharacteristic(this.hap.Characteristic.ChargingState).onGet(() => {
return this.Battery.ChargingState
})
// Initialize LightSensor Service
if ((device as curtainConfig).hide_lightsensor || !isCurtainDevice(device)) {
if (this.LightSensor?.Service) {
this.debugLog('Removing Light Sensor Service')
this.LightSensor.Service = this.accessory.getService(this.hap.Service.LightSensor) as Service
accessory.removeService(this.LightSensor.Service)
accessory.context.LightSensor = {}
}
} else {
accessory.context.LightSensor = accessory.context.LightSensor ?? {}
this.LightSensor = {
Name: `${accessory.displayName} Light Sensor`,
Service: accessory.getService(this.hap.Service.LightSensor) ?? this.accessory.addService(this.hap.Service.LightSensor) as Service,
CurrentAmbientLightLevel: accessory.context.CurrentAmbientLightLevel ?? 0.0001,
}
accessory.context.LightSensor = this.LightSensor as object
// Initialize LightSensor Characteristic
this.LightSensor.Service.setCharacteristic(this.hap.Characteristic.Name, this.LightSensor.Name).setCharacteristic(this.hap.Characteristic.StatusActive, true).getCharacteristic(this.hap.Characteristic.CurrentAmbientLightLevel).onGet(() => {
return this.LightSensor!.CurrentAmbientLightLevel!
})
}
// Initialize Open Mode Switch Service
if (!(device as curtainConfig).silentModeSwitch) {
if (this.OpenModeSwitch?.Service) {
this.debugLog('Removing Open Mode Switch Service')
this.OpenModeSwitch.Service = this.accessory.getService(this.hap.Service.Switch) as Service
accessory.removeService(this.OpenModeSwitch.Service)
accessory.context.OpenModeSwitch = {}
}
} else {
accessory.context.OpenModeSwitch = accessory.context.OpenModeSwitch ?? {}
this.debugLog('Adding Open Mode Switch Service')
const name = `${accessory.displayName} Silent Open Mode`
const uuid = this.api.hap.uuid.generate(name)
this.OpenModeSwitch = {
Name: name,
Service: accessory.getService(name) ?? accessory.addService(this.hap.Service.Switch, name, uuid) as Service,
On: accessory.context.OpenModeSwitch.On ?? false,
}
accessory.context.OpenModeSwitch = this.OpenModeSwitch as object
// Initialize Open Mode Switch Service
this.OpenModeSwitch.Service.setCharacteristic(this.hap.Characteristic.Name, this.OpenModeSwitch.Name).setCharacteristic(this.hap.Characteristic.ConfiguredName, this.OpenModeSwitch.Name).getCharacteristic(this.hap.Characteristic.On).onGet(() => {
return this.OpenModeSwitch?.On ?? false
})
this.OpenModeSwitch.Service.getCharacteristic(this.hap.Characteristic.On).onSet(this.OpenModeSwitchSet.bind(this))
}
// Initialize Close Mode Switch Service
if (!(device as curtainConfig).silentModeSwitch) {
if (this.CloseModeSwitch?.Service) {
this.debugLog('Removing Close Mode Switch Service')
this.CloseModeSwitch.Service = this.accessory.getService(this.hap.Service.Switch) as Service
accessory.removeService(this.CloseModeSwitch.Service)
accessory.context.CloseModeSwitch = {}
}
} else {
accessory.context.CloseModeSwitch = accessory.context.CloseModeSwitch ?? {}
this.debugLog('Adding Close Mode Switch Service')
const name = `${accessory.displayName} Silent Close Mode`
const uuid = this.api.hap.uuid.generate(name)
this.CloseModeSwitch = {
Name: name,
Service: this.accessory.getService(name) ?? accessory.addService(this.hap.Service.Switch, name, uuid) as Service,
On: accessory.context.CloseModeSwitch.On ?? false,
}
accessory.context.CloseModeSwitch = this.CloseModeSwitch as object
// Initialize Close Mode Switch Service
this.CloseModeSwitch.Service.setCharacteristic(this.hap.Characteristic.Name, this.CloseModeSwitch.Name).setCharacteristic(this.hap.Characteristic.ConfiguredName, this.CloseModeSwitch.Name).getCharacteristic(this.hap.Characteristic.On).onGet(() => {
return this.CloseModeSwitch?.On ?? false
})
this.CloseModeSwitch.Service.getCharacteristic(this.hap.Characteristic.On).onSet(this.CloseModeSwitchSet.bind(this))
}
// 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}`)
}
// History
this.history()
// Start an update interval
interval(this.deviceRefreshRate * 1000)
.pipe(skipWhile(() => this.curtainUpdateInProgress))
.subscribe(async () => {
await this.refreshStatus()
})
// update slide progress
interval(this.deviceUpdateRate * 1000)
.pipe(skipWhile(() => !this.curtainMoving))
.subscribe(async () => {
if (this.WindowCovering.PositionState === this.hap.Characteristic.PositionState.STOPPED) {
return
}
this.debugLog(`Refresh Status When Moving, PositionState: ${this.WindowCovering.PositionState}`)
await this.refreshStatus()
})
// Watch for Curtain change events
// We put in a debounce of 100ms so we don't make duplicate calls
this.doCurtainUpdate
.pipe(
tap(() => {
this.curtainUpdateInProgress = 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.curtainUpdateInProgress = false
})
// Setup EVE history features
this.setupHistoryService()
}
async history() {
if (this.device.history === true) {
// initialize when this accessory is newly created.
this.accessory.context.lastActivation = this.accessory.context.lastActivation ?? 0
} else {
// removes cached values if history is turned off
delete this.accessory.context.lastActivation
}
}
/*
* Setup EVE history features for curtain devices.
*/
async setupHistoryService(): Promise<void> {
if (this.device.history !== true) {
return
}
try {
const formattedDeviceId = formatDeviceIdAsMac(this.device.deviceId)
this.device.bleMac = formattedDeviceId
this.debugLog(`bleMac: ${this.device.bleMac}`)
this.historyService = new this.platform.fakegatoAPI('custom', this.accessory, {
log: this.platform.log,
storage: 'fs',
filename: `${hostname().split('.')[0]}_${this.device.bleMac}_persist.json`,
})
const motion: Service
= this.accessory.getService(this.hap.Service.MotionSensor)
|| this.accessory.addService(this.hap.Service.MotionSensor, 'Motion')
motion.addOptionalCharacteristic(this.platform.eve.Characteristics.LastActivation)
motion.getCharacteristic(this.platform.eve.Characteristics.LastActivation).onGet(() => {
const lastActivation = this.accessory.context.lastActivation
? Math.max(0, this.accessory.context.lastActivation - this.historyService.getInitialTime())
: 0
return lastActivation
})
await this.setMinMax()
motion.getCharacteristic(this.hap.Characteristic.MotionDetected).on('change', (event: CharacteristicChange) => {
if (event.newValue !== event.oldValue) {
const sensor = this.accessory.getService(this.hap.Service.MotionSensor)
const entry = {
time: Math.round(new Date().valueOf() / 1000),
motion: event.newValue,
}
this.accessory.context.lastActivation = entry.time
sensor?.updateCharacteristic(
this.platform.eve.Characteristics.LastActivation,
Math.max(0, this.accessory.context.lastActivation - this.historyService.getInitialTime()),
)
this.historyService.addEntry(entry)
}
})
this.updateHistory()
} catch (error) {
this.errorLog(`failed to format device ID as MAC, Error: ${error}`)
}
}
updateHistory(): void {
const motion = Number(this.WindowCovering.CurrentPosition) > 0 ? 1 : 0
this.historyService.addEntry({
time: Math.round(new Date().valueOf() / 1000),
motion,
})
setTimeout(() => {
this.updateHistory()
}, 10 * 60 * 1000)
}
async BLEparseStatus(): Promise<void> {
this.debugLog('BLEparseStatus')
this.debugLog(`(position, battery) = BLE:(${this.serviceData.position}, ${this.serviceData.battery}), current:(${this.WindowCovering.CurrentPosition}, ${this.Battery.BatteryLevel})`)
// CurrentPosition
if ('position' in this.serviceData) {
this.WindowCovering.CurrentPosition = 100 - this.serviceData.position
await this.getCurrentPostion()
}
// CurrentAmbientLightLevel
if (!(this.device as curtainConfig).hide_lightsensor && this.LightSensor?.Service && 'lightLevel' in this.serviceData) {
const set_minLux = (this.device as curtainConfig).set_minLux ?? 1
const set_maxLux = (this.device as curtainConfig).set_maxLux ?? 6001
const lightLevel = this.serviceData.lightLevel
this.LightSensor.CurrentAmbientLightLevel = this.getLightLevel(lightLevel, set_minLux, set_maxLux, 19)
this.debugLog(`LightLevel: ${this.serviceData.lightLevel}, CurrentAmbientLightLevel: ${this.LightSensor.CurrentAmbientLightLevel}`)
}
// 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(): Promise<void> {
this.debugLog('openAPIparseStatus')
this.debugLog(`(slidePosition, battery, version) = OpenAPI:(${this.deviceStatus.slidePosition}, ${this.deviceStatus.battery}, ${this.deviceStatus.version}), current:(${this.WindowCovering.CurrentPosition}, ${this.Battery.BatteryLevel}, ${this.accessory.context.version})`)
// CurrentPosition
this.WindowCovering.CurrentPosition = 100 - this.deviceStatus.slidePosition
await this.getCurrentPostion()
// Brightness
if (!(this.device as curtainConfig).hide_lightsensor && this.LightSensor?.Service) {
const set_minLux = (this.device as curtainConfig).set_minLux ?? 1
const set_maxLux = (this.device as curtainConfig).set_maxLux ?? 6001
const lightLevel = this.deviceStatus.lightLevel === 'bright' ? set_maxLux : set_minLux
this.LightSensor.CurrentAmbientLightLevel = this.getLightLevel(lightLevel, set_minLux, set_maxLux, 2)
this.debugLog(`CurrentAmbientLightLevel: ${this.LightSensor.CurrentAmbientLightLevel}`)
}
// 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}`)
// 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(`(slidePosition, battery) = Webhook:(${this.webhookContext.slidePosition}, ${this.webhookContext.battery}), current:(${this.WindowCovering.CurrentPosition}, ${this.Battery.BatteryLevel})`)
// CurrentPosition
this.WindowCovering.CurrentPosition = 100 - this.webhookContext.slidePosition
await this.getCurrentPostion()
// BatteryLevel
this.Battery.BatteryLevel = this.webhookContext.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}`)
}
/**
* 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 curtainServiceData | curtain3ServiceData
// Update HomeKit
if ((serviceData.model === SwitchBotBLEModel.Curtain || SwitchBotBLEModel.Curtain3)
&& (serviceData.modelName === SwitchBotBLEModelName.Curtain || SwitchBotBLEModelName.Curtain3)) {
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 openAPIRefreshStatus(): Promise<void> {
this.debugLog('openAPIRefreshStatus')
try {
const { body } = await this.deviceRefreshStatus()
const deviceStatus: any = 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: curtainWebhookContext | curtain3WebhookContext) => {
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}`)
}
}
} else {
this.debugLog('is not listening webhook.')
}
}
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: curtainServiceData | curtain3ServiceData) => {
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')
}
}
/**
* 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.curtainUpdateInProgress))
.pipe(take(1))
.subscribe(async () => {
await this.refreshStatus()
})
}
async BLEpushChanges(): Promise<void> {
this.debugLog('BLEpushChanges')
if (this.WindowCovering.TargetPosition !== this.WindowCovering.CurrentPosition) {
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}`)
const { setPositionMode, Mode }: { setPositionMode: number, Mode: string } = await this.setPerformance()
const adjustedMode = setPositionMode === 1 ? 0x01 : 0xFF
this.debugLog(`Mode: ${Mode}, setPositionMode: ${setPositionMode}`)
if (switchBotBLE !== false) {
switchBotBLE
.discover({ model: this.device.bleModel, quick: true, id: this.device.bleMac })
.then(async (device_list: SwitchbotDevice[]) => {
const deviceList = device_list as WoCurtain[]
return await this.retryBLE({
max: this.maxRetryBLE(),
fn: async () => {
return await deviceList[0].runToPos(100 - Number(this.WindowCovering.TargetPosition), adjustedMode)
},
})
})
.then(async () => {
this.successLog(`TargetPostion: ${this.WindowCovering.TargetPosition} sent over SwitchBot 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), TargetPosition: ${this.WindowCovering.TargetPosition}, CurrentPosition: ${this.WindowCovering.CurrentPosition}`)
}
}
async openAPIpushChanges(): Promise<void> {
this.debugLog('openAPIpushChanges')
if (this.WindowCovering.TargetPosition !== this.WindowCovering.CurrentPosition || this.device.disableCaching) {
this.debugLog(`Pushing ${this.WindowCovering.TargetPosition}`)
const adjustedTargetPosition = 100 - Number(this.WindowCovering.TargetPosition)
const { setPositionMode, Mode }: { setPositionMode: number, Mode: string } = await this.setPerformance()
this.debugLog(`Mode: ${Mode}, setPositionMode: ${setPositionMode}`)
const adjustedMode = setPositionMode || 'ff'
let bodyChange: bodyChange
if (this.WindowCovering.HoldPosition) {
bodyChange = {
command: 'pause',
parameter: 'default',
commandType: 'command',
}
} else {
bodyChange = {
command: 'setPosition',
parameter: `0,${adjustedMode},${adjustedTargetPosition}`,
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 {
this.debugLog(`No changes (openAPIpushChanges), CurrentPosition: ${this.WindowCovering.CurrentPosition}, TargetPosition: ${this.WindowCovering.TargetPosition}`)
}
}
/**
* Handle requests to set the value of the "Target Position" characteristic
*/
async TargetPositionSet(value: CharacteristicValue): Promise<void> {
if (this.WindowCovering.TargetPosition !== this.accessory.context.TargetPosition) {
this.infoLog(`Set TargetPosition: ${value}`)
} else {
this.debugLog(`No Changes, TargetPosition: ${value}`)
}
// Set HoldPosition to false when TargetPosition is changed
this.WindowCovering.HoldPosition = false
this.WindowCovering.Service.updateCharacteristic(this.hap.Characteristic.HoldPosition, this.WindowCovering.HoldPosition)
this.WindowCovering.TargetPosition = value
await this.mqtt('TargetPosition', this.WindowCovering.TargetPosition)
await this.mqtt('HoldPosition', this.WindowCovering.HoldPosition)
await this.startUpdatingCurtainIfNeeded()
}
async startUpdatingCurtainIfNeeded() {
await this.setMinMax()
if (this.WindowCovering.TargetPosition > this.WindowCovering.CurrentPosition) {
this.WindowCovering.PositionState = this.hap.Characteristic.PositionState.INCREASING
this.setNewTarget = true
this.debugLog(`value: ${this.WindowCovering.TargetPosition}, CurrentPosition: ${this.WindowCovering.CurrentPosition}`)
} else if (this.WindowCovering.TargetPosition < this.WindowCovering.CurrentPosition) {
this.WindowCovering.PositionState = this.hap.Characteristic.PositionState.DECREASING
this.setNewTarget = true
this.debugLog(`value: ${this.WindowCovering.TargetPosition}, CurrentPosition: ${this.WindowCovering.CurrentPosition}`)
} else {
this.WindowCovering.PositionState = this.hap.Characteristic.PositionState.STOPPED
this.setNewTarget = false
this.debugLog(`value: ${this.WindowCovering.TargetPosition}, CurrentPosition: ${this.WindowCovering.CurrentPosition}`)
}
this.WindowCovering.Service.setCharacteristic(this.hap.Characteristic.PositionState, this.WindowCovering.PositionState)
this.WindowCovering.Service.getCharacteristic(this.hap.Characteristic.PositionState).updateValue(this.WindowCovering.PositionState)
/**
* If Curtain movement time is short, the moving flag from backend is always false.
* The minimum time depends on the network control latency.
*/
clearTimeout(this.setNewTargetTimer)
this.debugLog(`deviceUpdateRate: ${this.deviceUpdateRate}`)
if (this.setNewTarget) {
this.setNewTargetTimer = setTimeout(async () => {
this.debugLog(`setNewTarget ${this.setNewTarget} timeout`)
this.setNewTarget = false
}, this.deviceUpdateRate * 1000)
}
this.doCurtainUpdate.next()
}
/**
* Handle requests to set the value of the "Target Position" characteristic
*/
async HoldPositionSet(value: CharacteristicValue): Promise<void> {
this.debugLog(`HoldPosition: ${value}`)
this.WindowCovering.HoldPosition = value
this.doCurtainUpdate.next()
}
/**
* Handle requests to set the value of the "Target Position" characteristic
*/
async OpenModeSwitchSet(value: CharacteristicValue): Promise<void> {
if (this.OpenModeSwitch && (this.device as curtainConfig).silentModeSwitch) {
this.debugLog(`Silent Open Mode: ${value}`)
this.OpenModeSwitch.On = value
this.accessory.context.OpenModeSwitch.On = value
if (value === true) {
this.infoLog('Silent Open Mode is enabled')
}
}
}
/**
* Handle requests to set the value of the "Target Position" characteristic
*/
async CloseModeSwitchSet(value: CharacteristicValue): Promise<void> {
if (this.CloseModeSwitch && (this.device as curtainConfig).silentModeSwitch) {
this.debugLog(`Silent Close Mode: ${value}`)
this.CloseModeSwitch.On = value
this.accessory.context.CloseModeSwitch.On = value
if (value === true) {
this.infoLog('Silent Close Mode is enabled')
}
}
}
async updateHomeKitCharacteristics(): Promise<void> {
await this.setMinMax()
// CurrentPosition
await this.updateCharacteristic(this.WindowCovering.Service, this.hap.Characteristic.CurrentPosition, this.WindowCovering.CurrentPosition, 'CurrentPosition')
// PositionState
await this.updateCharacteristic(this.WindowCovering.Service, this.hap.Characteristic.PositionState, this.WindowCovering.PositionState, 'PositionState')
// TargetPosition
await this.updateCharacteristic(this.WindowCovering.Service, this.hap.Characteristic.TargetPosition, this.WindowCovering.TargetPosition, 'TargetPosition')
// HoldPosition
await this.updateCharacteristic(this.WindowCovering.Service, this.hap.Characteristic.HoldPosition, this.WindowCovering.HoldPosition, 'HoldPosition')
// CurrentAmbientLightLevel
if (!(this.device as curtainConfig).hide_lightsensor && this.LightSensor?.Service) {
const history = { time: Math.round(new Date().valueOf() / 1000), lux: this.LightSensor.CurrentAmbientLightLevel }
await this.updateCharacteristic(this.LightSensor?.Service, this.hap.Characteristic.CurrentAmbientLightLevel, this.LightSensor?.CurrentAmbientLightLevel, 'CurrentAmbientLightLevel', history)
}
// 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')
// ChargingState
await this.updateCharacteristic(this.Battery.Service, this.hap.Characteristic.ChargingState, this.Battery.ChargingState, 'ChargingState')
}
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 setPerformance() {
let setPositionMode: number
let Mode: string
if (Number(this.WindowCovering.TargetPosition) > 50) {
if ((this.device as curtainConfig).setOpenMode === '1' || this.OpenModeSwitch?.On) {
setPositionMode = 1
Mode = 'Silent Mode'
} else if ((this.device as curtainConfig).setOpenMode === '0' || !this.OpenModeSwitch?.On) {
setPositionMode = 0
Mode = 'Performance Mode'
} else {
setPositionMode = 0
Mode = 'Default Mode'
}
} else {
if ((this.device as curtainConfig).setCloseMode === '1' || this.CloseModeSwitch?.On) {
setPositionMode = 1
Mode = 'Silent Mode'
} else if ((this.device as curtainConfig).setCloseMode === '0' || !this.CloseModeSwitch?.On) {
setPositionMode = 0
Mode = 'Performance Mode'
} else {
setPositionMode = 0
Mode = 'Default Mode'
}
}
this.infoLog(`Position Mode: ${setPositionMode}, Mode: ${Mode}`)
return { setPositionMode, Mode }
}
async getCurrentPostion(): Promise<void> {
await this.setMinMax()
this.debugLog(`CurrentPosition ${this.WindowCovering.CurrentPosition}`)
this.hasLoggedStandby = this.hasLoggedStandby ?? false
if (this.deviceStatus ? (this.setNewTarget || this.deviceStatus.moving) : this.setNewTarget) {
this.hasLoggedStandby = false
this.infoLog('Checking Status ...')
this.curtainMoving = true
if (this.WindowCovering.TargetPosition > this.WindowCovering.CurrentPosition) {
this.debugLog(`Closing, CurrentPosition: ${this.WindowCovering.CurrentPosition}`)
this.WindowCovering.PositionState = this.hap.Characteristic.PositionState.INCREASING
this.WindowCovering.Service.getCharacteristic(this.hap.Characteristic.PositionState).updateValue(this.WindowCovering.PositionState)
this.debugLog(`Increasing, PositionState: ${this.WindowCovering.PositionState}`)
} else if (this.WindowCovering.TargetPosition < this.WindowCovering.CurrentPosition) {
this.debugLog(`Opening, CurrentPosition: ${this.WindowCovering.CurrentPosition}`)
this.WindowCovering.PositionState = this.hap.Characteristic.PositionState.DECREASING
this.WindowCovering.Service.getCharacteristic(this.hap.Characteristic.PositionState).updateValue(this.WindowCovering.PositionState)
this.debugLog(`Decreasing, PositionState: ${this.WindowCovering.PositionState}`)
} else {
this.debugLog(`Standby, CurrentPosition: ${this.WindowCovering.CurrentPosition}`)
this.WindowCovering.PositionState = this.hap.Characteristic.PositionState.STOPPED
this.WindowCovering.Service.getCharacteristic(this.hap.Characteristic.PositionState).updateValue(this.WindowCovering.PositionState)
this.debugLog(`Stopped, PositionState: ${this.WindowCovering.PositionState}`)
}
} else {
if (!this.hasLoggedStandby) {
this.infoLog('Standby ...')
this.hasLoggedStandby = true
}
this.curtainMoving = false
this.debugLog(`Standby, CurrentPosition: ${this.WindowCovering.CurrentPosition}`)
this.WindowCovering.TargetPosition = this.WindowCovering.CurrentPosition
this.WindowCovering.PositionState = this.hap.Characteristic.PositionState.STOPPED
this.debugLog(`Stopped, PositionState: ${this.WindowCovering.PositionState}`)
}
this.debugLog(`CurrentPosition: ${this.WindowCovering.CurrentPosition}, TargetPosition: ${this.WindowCovering.TargetPosition}, PositionState: ${this.WindowCovering.PositionState},`)
}
async setMinMax(): Promise<void> {
if ((this.device as curtainConfig).set_min) {
if (Number(this.WindowCovering.CurrentPosition) >= (this.device as curtainConfig).set_min!) {
this.WindowCovering.CurrentPosition = 100
}
}
if ((this.device as curtainConfig).set_max) {
if (Number(this.WindowCovering.CurrentPosition) <= (this.device as curtainConfig).set_max!) {
this.WindowCovering.CurrentPosition = 0
}
}
if (this.device.history) {
const motion = this.accessory.getService(this.hap.Service.MotionSensor)
const state = Number(this.WindowCovering.CurrentPosition) > 0 ? 1 : 0
motion?.updateCharacteristic(this.hap.Characteristic.MotionDetected, state)
}
}
async offlineOff(): Promise<void> {
if (this.device.offline) {
this.WindowCovering.Service.updateCharacteristic(this.hap.Characteristic.CurrentPosition, 100)
this.WindowCovering.Service.updateCharacteristic(this.hap.Characteristic.TargetPosition, 100)
this.WindowCovering.Service.updateCharacteristic(this.hap.Characteristic.PositionState, this.hap.Characteristic.PositionState.STOPPED)
}
}
async apiError(e: any): Promise<void> {
this.WindowCovering.Service.updateCharacteristic(this.hap.Characteristic.CurrentPosition, e)
this.WindowCovering.Service.updateCharacteristic(this.hap.Characteristic.PositionState, e)
this.WindowCovering.Service.updateCharacteristic(this.hap.Characteristic.TargetPosition, e)
this.Battery.Service.updateCharacteristic(this.hap.Characteristic.BatteryLevel, e)
this.Battery.Service.updateCharacteristic(this.hap.Characteristic.StatusLowBattery, e)
this.Battery.Service.updateCharacteristic(this.hap.Characteristic.ChargingState, e)
if (!(this.device as curtainConfig).hide_lightsensor && this.LightSensor?.Service) {
this.LightSensor.Service.updateCharacteristic(this.hap.Characteristic.CurrentAmbientLightLevel, e)
this.LightSensor.Service.updateCharacteristic(this.hap.Characteristic.StatusActive, e)
}
}
}
|