@switchbot/homebridge-switchbot 3.8.3-beta.3 → 3.8.3-beta.30

package/dist/platform.js

@@ -1,18 +1,10 @@
-import { Buffer } from 'node:buffer';
-import crypto, { randomUUID } from 'node:crypto';
 import { readFileSync, writeFileSync } from 'node:fs';
-import { createServer } from 'node:http';
 import process from 'node:process';
 import asyncmqtt from 'async-mqtt';
 import fakegato from 'fakegato-history';
 import { EveHomeKitTypes } from 'homebridge-lib/EveHomeKitTypes';
-/*
-* For Testing Locally:
-* import { SwitchBotModel } from '/Users/Shared/GitHub/OpenWonderLabs/node-switchbot/dist/index.js';
-*/
-import { SwitchBot, SwitchBotModel } from 'node-switchbot';
+import { LogLevel, SwitchBotBLE, SwitchBotModel, SwitchBotOpenAPI } from 'node-switchbot';
 import { queueScheduler } from 'rxjs';
-import { request } from 'undici';
 import { BlindTilt } from './device/blindtilt.js';
 import { Bot } from './device/bot.js';
 import { CeilingLight } from './device/ceilinglight.js';
@@ -40,7 +32,7 @@ import { Others } from './irdevice/other.js';
 import { TV } from './irdevice/tv.js';
 import { VacuumCleaner } from './irdevice/vacuumcleaner.js';
 import { WaterHeater } from './irdevice/waterheater.js';
-import { deleteWebhook, Devices, PLATFORM_NAME, PLUGIN_NAME, queryWebhook, setupWebhook, updateWebhook } from './settings.js';
+import { PLATFORM_NAME, PLUGIN_NAME } from './settings.js';
 import { formatDeviceIdAsMac, isBlindTiltDevice, isCurtainDevice, sleep } from './utils.js';
 /**
  * HomebridgePlatform
@@ -64,6 +56,9 @@ export class SwitchBotPlatform {
     // MQTT and Webhook properties
     mqttClient = null;
     webhookEventListener = null;
+    // SwitchBot APIs
+    switchBotAPI;
+    switchBotBLE;
     // External APIs
     eve;
     fakegatoAPI;
@@ -100,6 +95,37 @@ export class SwitchBotPlatform {
             this.debugErrorLog(`Verify Config, Error: ${e}`);
             return;
         }
+        // SwitchBot OpenAPI
+        this.switchBotAPI = new SwitchBotOpenAPI(this.config.credentials?.token, this.config.credentials?.secret);
+        // Listen for log events
+        this.switchBotAPI.on('log', (log) => {
+            switch (log.level) {
+                case LogLevel.SUCCESS:
+                    this.successLog(log.message);
+                    break;
+                case LogLevel.DEBUGSUCCESS:
+                    this.debugSuccessLog(log.message);
+                    break;
+                case LogLevel.WARN:
+                    this.warnLog(log.message);
+                    break;
+                case LogLevel.DEBUGWARN:
+                    this.debugWarnLog(log.message);
+                    break;
+                case LogLevel.ERROR:
+                    this.errorLog(log.message);
+                    break;
+                case LogLevel.DEBUGERROR:
+                    this.debugErrorLog(log.message);
+                    break;
+                case LogLevel.DEBUG:
+                    this.debugLog(log.message);
+                    break;
+                case LogLevel.INFO:
+                default:
+                    this.infoLog(log.message);
+            }
+        });
         // import fakegato-history module and EVE characteristics
         this.fakegatoAPI = fakegato(api);
         this.eve = new EveHomeKitTypes(api);
@@ -181,123 +207,23 @@ export class SwitchBotPlatform {
         if (this.config.options?.webhookURL) {
             const url = this.config.options?.webhookURL;
             try {
-                const xurl = new URL(url);
-                const port = Number(xurl.port);
-                const path = xurl.pathname;
-                this.webhookEventListener = createServer((request, response) => {
-                    try {
-                        if (request.url === path && request.method === 'POST') {
-                            request.on('data', async (data) => {
-                                try {
-                                    const body = JSON.parse(data);
-                                    await this.debugLog(`Received Webhook: ${JSON.stringify(body)}`);
-                                    if (this.config.options?.mqttURL) {
-                                        const mac = body.context.deviceMac?.toLowerCase().match(/[\s\S]{1,2}/g)?.join(':');
-                                        const options = this.config.options?.mqttPubOptions || {};
-                                        this.mqttClient?.publish(`homebridge-switchbot/webhook/${mac}`, `${JSON.stringify(body.context)}`, options);
-                                    }
-                                    this.webhookEventHandler[body.context.deviceMac]?.(body.context);
-                                }
-                                catch (e) {
-                                    await this.errorLog(`Failed to handle webhook event. Error:${e}`);
-                                }
-                            });
-                            response.writeHead(200, { 'Content-Type': 'text/plain' });
-                            response.end('OK');
-                        }
-                        // else {
-                        //   response.writeHead(403, {'Content-Type': 'text/plain'});
-                        //   response.end(`NG`);
-                        // }
+                this.switchBotAPI.setupWebhook(url);
+                // Listen for webhook events
+                this.switchBotAPI.on('webhookEvent', (body) => {
+                    if (this.config.options?.mqttURL) {
+                        const mac = body.context.deviceMac?.toLowerCase().match(/[\s\S]{1,2}/g)?.join(':');
+                        const options = this.config.options?.mqttPubOptions || {};
+                        this.mqttClient?.publish(`homebridge-switchbot/webhook/${mac}`, `${JSON.stringify(body.context)}`, options);
                     }
-                    catch (e) {
-                        this.errorLog(`Failed to handle webhook event. Error:${e}`);
-                    }
-                }).listen(port || 80);
-            }
-            catch (e) {
-                await this.errorLog(`Failed to create webhook listener. Error:${e.message}`);
-                return;
-            }
-            try {
-                const { body, statusCode } = await request(setupWebhook, {
-                    method: 'POST',
-                    headers: this.generateHeaders(),
-                    body: JSON.stringify({
-                        action: 'setupWebhook',
-                        url,
-                        deviceList: 'ALL',
-                    }),
+                    this.webhookEventHandler[body.context.deviceMac]?.(body.context);
                 });
-                const response = await body.json();
-                await this.debugLog(`setupWebhook: url:${url}, body:${JSON.stringify(response)}, statusCode:${statusCode}`);
-                if (statusCode !== 200 || response?.statusCode !== 100) {
-                    await this.errorLog(`Failed to configure webhook. Existing webhook well be overridden. HTTP:${statusCode} API:${response?.statusCode} message:${response?.message}`);
-                }
             }
             catch (e) {
-                await this.errorLog(`Failed to configure webhook. Error: ${e.message}`);
-            }
-            try {
-                const { body, statusCode } = await request(updateWebhook, {
-                    method: 'POST',
-                    headers: this.generateHeaders(),
-                    body: JSON.stringify({
-                        action: 'updateWebhook',
-                        config: {
-                            url,
-                            enable: true,
-                        },
-                    }),
-                });
-                const response = await body.json();
-                await this.debugLog(`updateWebhook: url:${url}, body:${JSON.stringify(response)}, statusCode:${statusCode}`);
-                if (statusCode !== 200 || response?.statusCode !== 100) {
-                    await this.errorLog(`Failed to update webhook. HTTP:${statusCode} API:${response?.statusCode} message:${response?.message}`);
-                }
-            }
-            catch (e) {
-                await this.errorLog(`Failed to update webhook. Error:${e.message}`);
-            }
-            try {
-                const { body, statusCode } = await request(queryWebhook, {
-                    method: 'POST',
-                    headers: this.generateHeaders(),
-                    body: JSON.stringify({
-                        action: 'queryUrl',
-                    }),
-                });
-                const response = await body.json();
-                await this.debugLog(`queryWebhook: body:${JSON.stringify(response)}`);
-                await this.debugLog(`queryWebhook: statusCode:${statusCode}`);
-                if (statusCode !== 200 || response?.statusCode !== 100) {
-                    await this.errorLog(`Failed to query webhook. HTTP:${statusCode} API:${response?.statusCode} message:${response?.message}`);
-                }
-                else {
-                    await this.infoLog(`Listening webhook on ${response?.body?.urls[0]}`);
-                }
-            }
-            catch (e) {
-                await this.errorLog(`Failed to query webhook. Error:${e}`);
+                await this.errorLog(`Failed to setup webhook. Error:${e.message}`);
             }
             this.api.on('shutdown', async () => {
                 try {
-                    const { body, statusCode } = await request(deleteWebhook, {
-                        method: 'POST',
-                        headers: this.generateHeaders(),
-                        body: JSON.stringify({
-                            action: 'deleteWebhook',
-                            url,
-                        }),
-                    });
-                    const response = await body.json();
-                    await this.debugLog(`deleteWebhook: url:${url}, body:${JSON.stringify(response)}, statusCode:${statusCode}`);
-                    if (statusCode !== 200 || response?.statusCode !== 100) {
-                        await this.errorLog(`Failed to delete webhook. HTTP:${statusCode} API:${response?.statusCode} message:${response?.message}`);
-                    }
-                    else {
-                        await this.infoLog('Unregistered webhook to close listening.');
-                    }
+                    this.switchBotAPI.deleteWebhook(url);
                 }
                 catch (e) {
                     await this.errorLog(`Failed to delete webhook. Error:${e.message}`);
@@ -306,20 +232,54 @@ export class SwitchBotPlatform {
         }
     }
     async setupBlE() {
+        this.switchBotBLE = new SwitchBotBLE();
+        // Listen for log events
+        this.switchBotBLE.on('log', (log) => {
+            switch (log.level) {
+                case LogLevel.SUCCESS:
+                    this.successLog(log.message);
+                    break;
+                case LogLevel.DEBUGSUCCESS:
+                    this.debugSuccessLog(log.message);
+                    break;
+                case LogLevel.WARN:
+                    this.warnLog(log.message);
+                    break;
+                case LogLevel.DEBUGWARN:
+                    this.debugWarnLog(log.message);
+                    break;
+                case LogLevel.ERROR:
+                    this.errorLog(log.message);
+                    break;
+                case LogLevel.DEBUGERROR:
+                    this.debugErrorLog(log.message);
+                    break;
+                case LogLevel.DEBUG:
+                    this.debugLog(log.message);
+                    break;
+                case LogLevel.INFO:
+                default:
+                    this.infoLog(log.message);
+            }
+        });
         if (this.config.options?.BLE) {
             await this.debugLog('setupBLE');
-            const switchbot = new SwitchBot();
-            if (switchbot === undefined) {
-                await this.errorLog(`wasn't able to establish BLE Connection, node-switchbot: ${switchbot}`);
+            if (this.switchBotBLE === undefined) {
+                await this.errorLog(`wasn't able to establish BLE Connection, node-switchbot: ${this.switchBotBLE}`);
             }
             else {
                 // Start to monitor advertisement packets
                 (async () => {
                     // Start to monitor advertisement packets
                     await this.debugLog('Scanning for BLE SwitchBot devices...');
-                    await switchbot.startScan();
+                    try {
+                        await this.switchBotBLE.startScan();
+                    }
+                    catch (e) {
+                        await this.errorLog(`Failed to start BLE scanning. Error:${e}`);
+                    }
                     // Set an event handler to monitor advertisement packets
-                    switchbot.onadvertisement = async (ad) => {
+                    this.switchBotBLE.onadvertisement = async (ad) => {
                         try {
                             this.bleEventHandler[ad.address]?.(ad.serviceData);
                         }
@@ -330,7 +290,7 @@ export class SwitchBotPlatform {
                 })();
                 this.api.on('shutdown', async () => {
                     try {
-                        switchbot.stopScan();
+                        this.switchBotBLE.stopScan();
                         await this.infoLog('Stopped BLE scanning to close listening.');
                     }
                     catch (e) {
@@ -492,23 +452,6 @@ export class SwitchBotPlatform {
             await this.errorLog(`Update Token: ${e}`);
         }
     }
-    generateHeaders = () => {
-        const t = `${Date.now()}`;
-        const nonce = randomUUID();
-        const data = this.config.credentials?.token + t + nonce;
-        const signTerm = crypto
-            .createHmac('sha256', this.config.credentials?.secret)
-            .update(Buffer.from(data, 'utf-8'))
-            .digest();
-        const sign = signTerm.toString('base64');
-        return {
-            'Authorization': this.config.credentials?.token,
-            'sign': sign,
-            'nonce': nonce,
-            't': t,
-            'Content-Type': 'application/json',
-        };
-    };
     async discoverDevices() {
         if (!this.config.credentials?.token) {
             return this.handleManualConfig();
@@ -521,17 +464,15 @@ export class SwitchBotPlatform {
         await this.debugWarnLog(`Delay Between Retries: ${delayBetweenRetries}`);
         while (retryCount < maxRetries) {
             try {
-                const { body, statusCode } = await request(Devices, { headers: this.generateHeaders() });
-                await this.debugWarnLog(`statusCode: ${statusCode}`);
-                const devicesAPI = await body.json();
-                await this.debugWarnLog(`devicesAPI: ${JSON.stringify(devicesAPI)}`);
-                if (this.isSuccessfulResponse(statusCode, devicesAPI.statusCode)) {
-                    await this.handleDevices(devicesAPI.body.deviceList);
-                    await this.handleIRDevices(devicesAPI.body.infraredRemoteList);
+                const { response, statusCode } = await this.switchBotAPI.getDevices();
+                await this.debugLog(`response: ${JSON.stringify(response)}`);
+                if (this.isSuccessfulResponse(statusCode)) {
+                    await this.handleDevices(Array.isArray(response.body.deviceList) ? response.body.deviceList : []);
+                    await this.handleIRDevices(Array.isArray(response.body.infraredRemoteList) ? response.body.infraredRemoteList : []);
                     break;
                 }
                 else {
-                    await this.handleErrorResponse(statusCode, devicesAPI.statusCode, retryCount, maxRetries, delayBetweenRetries);
+                    await this.handleErrorResponse(statusCode, retryCount, maxRetries, delayBetweenRetries);
                     retryCount++;
                 }
             }
@@ -565,8 +506,8 @@ export class SwitchBotPlatform {
             await this.errorLog('Neither SwitchBot Token or Device Config are set.');
         }
     }
-    isSuccessfulResponse(statusCode, apiStatusCode) {
-        return (statusCode === 200 || statusCode === 100) && (apiStatusCode === 200 || apiStatusCode === 100);
+    isSuccessfulResponse(apiStatusCode) {
+        return (apiStatusCode === 200 || apiStatusCode === 100);
     }
     async handleDevices(deviceLists) {
         if (!this.config.options?.devices) {
@@ -631,11 +572,10 @@ export class SwitchBotPlatform {
             return { ...matchingItem, ...itm };
         });
     }
-    async handleErrorResponse(statusCode, apiStatusCode, retryCount, maxRetries, delayBetweenRetries) {
-        await this.statusCode(statusCode);
+    async handleErrorResponse(apiStatusCode, retryCount, maxRetries, delayBetweenRetries) {
         await this.statusCode(apiStatusCode);
-        if (statusCode === 500) {
-            this.infoLog(`statusCode: ${statusCode} Attempt ${retryCount + 1} of ${maxRetries}`);
+        if (apiStatusCode === 500) {
+            this.infoLog(`statusCode: ${apiStatusCode} Attempt ${retryCount + 1} of ${maxRetries}`);
             await sleep(delayBetweenRetries);
         }
     }
@@ -2531,19 +2471,15 @@ export class SwitchBotPlatform {
             await this.errorLog(message);
         }
     }
-    async retryRequest(deviceMaxRetries, deviceDelayBetweenRetries, url, options) {
+    async retryRequest(deviceId, deviceMaxRetries, deviceDelayBetweenRetries) {
         let retryCount = 0;
         const maxRetries = deviceMaxRetries;
         const delayBetweenRetries = deviceDelayBetweenRetries;
         while (retryCount < maxRetries) {
             try {
-                const { body, statusCode } = await request(url, options);
-                if (statusCode === 200 || statusCode === 100) {
-                    return { body, statusCode };
-                }
-                else {
-                    await this.debugLog(`Received status code: ${statusCode}`);
-                }
+                const { response, statusCode } = await this.switchBotAPI.getDeviceStatus(deviceId);
+                await this.debugLog(`response: ${JSON.stringify(response)}`);
+                return { response, statusCode };
             }
             catch (error) {
                 await this.errorLog(`Error making request: ${error.message}`);
@@ -2552,15 +2488,14 @@ export class SwitchBotPlatform {
             await this.debugLog(`Retry attempt ${retryCount} of ${maxRetries}`);
             await sleep(delayBetweenRetries);
         }
-        return { body: null, statusCode: -1 };
+        return { response: null, statusCode: 500 };
     }
     // BLE Connection
     async connectBLE(accessory, device) {
         try {
-            const switchbot = new SwitchBot();
-            queueScheduler.schedule(async () => switchbot);
-            await this.debugLog(`${device.deviceType}: ${accessory.displayName} 'node-switchbot' found: ${switchbot}`);
-            return switchbot;
+            queueScheduler.schedule(async () => this.switchBotBLE);
+            await this.debugLog(`${device.deviceType}: ${accessory.displayName} 'node-switchbot' found: ${this.switchBotBLE}`);
+            return this.switchBotBLE;
         }
         catch (e) {
             await this.errorLog(`${device.deviceType}: ${accessory.displayName} 'node-switchbot' not found, Error: ${e}`);