|
| 1 | +/* Copyright(C) 2024, donavanbecker (https://github.com/donavanbecker). All rights reserved. |
| 2 | + * |
| 3 | + * wohumi.ts: Switchbot BLE API registration. |
| 4 | + */ |
| 5 | +import type { humidifier2ServiceData } from '../types/bledevicestatus.js' |
| 6 | +import type { NobleTypes } from '../types/types.js' |
| 7 | + |
| 8 | +import { Buffer } from 'node:buffer' |
| 9 | + |
| 10 | +import { SwitchbotDevice } from '../device.js' |
| 11 | +import { SwitchBotBLEModel, SwitchBotBLEModelFriendlyName, SwitchBotBLEModelName } from '../types/types.js' |
| 12 | + |
| 13 | +const HUMIDIFIER_COMMAND_HEADER = '5701' |
| 14 | +const TURN_ON_KEY = `${HUMIDIFIER_COMMAND_HEADER}0101` |
| 15 | +const TURN_OFF_KEY = `${HUMIDIFIER_COMMAND_HEADER}0102` |
| 16 | +const INCREASE_KEY = `${HUMIDIFIER_COMMAND_HEADER}0103` |
| 17 | +const DECREASE_KEY = `${HUMIDIFIER_COMMAND_HEADER}0104` |
| 18 | +const SET_AUTO_MODE_KEY = `${HUMIDIFIER_COMMAND_HEADER}0105` |
| 19 | +const SET_MANUAL_MODE_KEY = `${HUMIDIFIER_COMMAND_HEADER}0106` |
| 20 | + |
| 21 | +/** |
| 22 | + * Class representing a WoHumi device. |
| 23 | + * @see https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/tree/latest/devicetypes |
| 24 | + */ |
| 25 | +export class WoHumi2 extends SwitchbotDevice { |
| 26 | + constructor(peripheral: NobleTypes['peripheral'], noble: NobleTypes['noble']) { |
| 27 | + super(peripheral, noble) |
| 28 | + } |
| 29 | + |
| 30 | + /** |
| 31 | + * Parses the service data for WoHumi. |
| 32 | + * @param {Buffer} serviceData - The service data buffer. |
| 33 | + * @param {Function} emitLog - The function to emit log messages. |
| 34 | + * @returns {Promise<humidifier2ServiceData | null>} - Parsed service data or null if invalid. |
| 35 | + */ |
| 36 | + static async parseServiceData( |
| 37 | + serviceData: Buffer, |
| 38 | + emitLog: (level: string, message: string) => void, |
| 39 | + ): Promise<humidifier2ServiceData | null> { |
| 40 | + if (serviceData.length !== 8) { |
| 41 | + emitLog('debugerror', `[parseServiceDataForWoHumi] Buffer length ${serviceData.length} !== 8!`) |
| 42 | + return null |
| 43 | + } |
| 44 | + |
| 45 | + const byte1 = serviceData.readUInt8(1) |
| 46 | + const byte4 = serviceData.readUInt8(4) |
| 47 | + |
| 48 | + const onState = !!(byte1 & 0b10000000) // 1 - on |
| 49 | + const autoMode = !!(byte4 & 0b10000000) // 1 - auto |
| 50 | + const percentage = byte4 & 0b01111111 // 0-100%, 101/102/103 - Quick gear 1/2/3 |
| 51 | + const humidity = autoMode ? 0 : percentage === 101 ? 33 : percentage === 102 ? 66 : percentage === 103 ? 100 : percentage |
| 52 | + |
| 53 | + const data: humidifier2ServiceData = { |
| 54 | + model: SwitchBotBLEModel.Humidifier2, |
| 55 | + modelName: SwitchBotBLEModelName.Humidifier2, |
| 56 | + modelFriendlyName: SwitchBotBLEModelFriendlyName.Humidifier2, |
| 57 | + onState, |
| 58 | + autoMode, |
| 59 | + percentage: autoMode ? 0 : percentage, |
| 60 | + humidity, |
| 61 | + } |
| 62 | + |
| 63 | + return data |
| 64 | + } |
| 65 | + |
| 66 | + /** |
| 67 | + * Sends a command to the humidifier. |
| 68 | + * @param {Buffer} reqBuf - The command buffer. |
| 69 | + * @returns {Promise<void>} |
| 70 | + */ |
| 71 | + protected async operateHumi(reqBuf: Buffer): Promise<void> { |
| 72 | + const resBuf = await this.command(reqBuf) |
| 73 | + const code = resBuf.readUInt8(0) |
| 74 | + |
| 75 | + if (resBuf.length !== 3 || (code !== 0x01 && code !== 0x05)) { |
| 76 | + throw new Error(`The device returned an error: 0x${resBuf.toString('hex')}`) |
| 77 | + } |
| 78 | + } |
| 79 | + |
| 80 | + /** |
| 81 | + * Turns on the humidifier. |
| 82 | + * @returns {Promise<void>} |
| 83 | + */ |
| 84 | + public async turnOn(): Promise<void> { |
| 85 | + await this.operateHumi(Buffer.from(TURN_ON_KEY, 'hex')) |
| 86 | + } |
| 87 | + |
| 88 | + /** |
| 89 | + * Turns off the humidifier. |
| 90 | + * @returns {Promise<void>} |
| 91 | + */ |
| 92 | + public async turnOff(): Promise<void> { |
| 93 | + await this.operateHumi(Buffer.from(TURN_OFF_KEY, 'hex')) |
| 94 | + } |
| 95 | + |
| 96 | + /** |
| 97 | + * Increases the humidifier setting. |
| 98 | + * @returns {Promise<void>} |
| 99 | + */ |
| 100 | + public async increase(): Promise<void> { |
| 101 | + await this.operateHumi(Buffer.from(INCREASE_KEY, 'hex')) |
| 102 | + } |
| 103 | + |
| 104 | + /** |
| 105 | + * Decreases the humidifier setting. |
| 106 | + * @returns {Promise<void>} |
| 107 | + */ |
| 108 | + public async decrease(): Promise<void> { |
| 109 | + await this.operateHumi(Buffer.from(DECREASE_KEY, 'hex')) |
| 110 | + } |
| 111 | + |
| 112 | + /** |
| 113 | + * Sets the humidifier to auto mode. |
| 114 | + * @returns {Promise<void>} |
| 115 | + */ |
| 116 | + public async setAutoMode(): Promise<void> { |
| 117 | + await this.operateHumi(Buffer.from(SET_AUTO_MODE_KEY, 'hex')) |
| 118 | + } |
| 119 | + |
| 120 | + /** |
| 121 | + * Sets the humidifier to manual mode. |
| 122 | + * @returns {Promise<void>} |
| 123 | + */ |
| 124 | + public async setManualMode(): Promise<void> { |
| 125 | + await this.operateHumi(Buffer.from(SET_MANUAL_MODE_KEY, 'hex')) |
| 126 | + } |
| 127 | + |
| 128 | + /** |
| 129 | + * Sets the humidifier level. |
| 130 | + * @param {number} level - The level to set (0-100). |
| 131 | + * @returns {Promise<void>} |
| 132 | + */ |
| 133 | + public async percentage(level: number): Promise<void> { |
| 134 | + if (level < 0 || level > 100) { |
| 135 | + throw new Error('Level must be between 0 and 100') |
| 136 | + } |
| 137 | + const levelKey = `${HUMIDIFIER_COMMAND_HEADER}0107${level.toString(16).padStart(2, '0')}` |
| 138 | + await this.operateHumi(Buffer.from(levelKey, 'hex')) |
| 139 | + } |
| 140 | +} |
0 commit comments