@switchbot/homebridge-switchbot 3.8.3-beta.11 → 3.8.3-beta.13

package/src/irdevice/tv.ts

@@ -3,10 +3,10 @@
  * tv.ts: @switchbot/homebridge-switchbot.
  */
 import type { CharacteristicValue, PlatformAccessory, Service } from 'homebridge'
+import type { bodyChange, irdevice } from 'node-switchbot'
 
 import type { SwitchBotPlatform } from '../platform.js'
 import type { irDevicesConfig } from '../settings.js'
-import type { irdevice } from '../types/irdevicelist.js'
 
 import { irdeviceBase } from './irdevice.js'
 
@@ -210,11 +210,11 @@ export class TV extends irdeviceBase {
     if (this.Television.Active === this.hap.Characteristic.Active.ACTIVE && !this.disablePushOn) {
       const commandType: string = await this.commandType()
       const command: string = await this.commandOn()
-      const bodyChange = JSON.stringify({
+      const bodyChange: bodyChange = {
         command,
         parameter: 'default',
         commandType,
-      })
+      }
       await this.pushTVChanges(bodyChange)
     }
   }
@@ -224,11 +224,11 @@ export class TV extends irdeviceBase {
     if (this.Television.Active === this.hap.Characteristic.Active.INACTIVE && !this.disablePushOff) {
       const commandType: string = await this.commandType()
       const command: string = await this.commandOff()
-      const bodyChange = JSON.stringify({
+      const bodyChange: bodyChange = {
         command,
         parameter: 'default',
         commandType,
-      })
+      }
       await this.pushTVChanges(bodyChange)
     }
   }
@@ -236,11 +236,11 @@ export class TV extends irdeviceBase {
   async pushOkChanges(): Promise<void> {
     await this.debugLog(`pushOkChanges disablePushDetail: ${this.disablePushDetail}`)
     if (!this.disablePushDetail) {
-      const bodyChange = JSON.stringify({
+      const bodyChange: bodyChange = {
         command: 'Ok',
         parameter: 'default',
         commandType: 'command',
-      })
+      }
       await this.pushTVChanges(bodyChange)
     }
   }
@@ -248,11 +248,11 @@ export class TV extends irdeviceBase {
   async pushBackChanges(): Promise<void> {
     await this.debugLog(`pushBackChanges disablePushDetail: ${this.disablePushDetail}`)
     if (!this.disablePushDetail) {
-      const bodyChange = JSON.stringify({
+      const bodyChange: bodyChange = {
         command: 'Back',
         parameter: 'default',
         commandType: 'command',
-      })
+      }
       await this.pushTVChanges(bodyChange)
     }
   }
@@ -260,11 +260,11 @@ export class TV extends irdeviceBase {
   async pushMenuChanges(): Promise<void> {
     await this.debugLog(`pushMenuChanges disablePushDetail: ${this.disablePushDetail}`)
     if (!this.disablePushDetail) {
-      const bodyChange = JSON.stringify({
+      const bodyChange: bodyChange = {
         command: 'Menu',
         parameter: 'default',
         commandType: 'command',
-      })
+      }
       await this.pushTVChanges(bodyChange)
     }
   }
@@ -272,11 +272,11 @@ export class TV extends irdeviceBase {
   async pushUpChanges(): Promise<void> {
     await this.debugLog(`pushUpChanges disablePushDetail: ${this.disablePushDetail}`)
     if (!this.disablePushDetail) {
-      const bodyChange = JSON.stringify({
+      const bodyChange: bodyChange = {
         command: 'Up',
         parameter: 'default',
         commandType: 'command',
-      })
+      }
       await this.pushTVChanges(bodyChange)
     }
   }
@@ -284,11 +284,11 @@ export class TV extends irdeviceBase {
   async pushDownChanges(): Promise<void> {
     await this.debugLog(`pushDownChanges disablePushDetail: ${this.disablePushDetail}`)
     if (!this.disablePushDetail) {
-      const bodyChange = JSON.stringify({
+      const bodyChange: bodyChange = {
         command: 'Down',
         parameter: 'default',
         commandType: 'command',
-      })
+      }
       await this.pushTVChanges(bodyChange)
     }
   }
@@ -296,11 +296,11 @@ export class TV extends irdeviceBase {
   async pushRightChanges(): Promise<void> {
     await this.debugLog(`pushRightChanges disablePushDetail: ${this.disablePushDetail}`)
     if (!this.disablePushDetail) {
-      const bodyChange = JSON.stringify({
+      const bodyChange: bodyChange = {
         command: 'Right',
         parameter: 'default',
         commandType: 'command',
-      })
+      }
       await this.pushTVChanges(bodyChange)
     }
   }
@@ -308,11 +308,11 @@ export class TV extends irdeviceBase {
   async pushLeftChanges(): Promise<void> {
     await this.debugLog(`pushLeftChanges disablePushDetail: ${this.disablePushDetail}`)
     if (!this.disablePushDetail) {
-      const bodyChange = JSON.stringify({
+      const bodyChange: bodyChange = {
         command: 'Left',
         parameter: 'default',
         commandType: 'command',
-      })
+      }
       await this.pushTVChanges(bodyChange)
     }
   }
@@ -320,11 +320,11 @@ export class TV extends irdeviceBase {
   async pushVolumeUpChanges(): Promise<void> {
     await this.debugLog(`pushVolumeUpChanges disablePushDetail: ${this.disablePushDetail}`)
     if (!this.disablePushDetail) {
-      const bodyChange = JSON.stringify({
+      const bodyChange: bodyChange = {
         command: 'volumeAdd',
         parameter: 'default',
         commandType: 'command',
-      })
+      }
       await this.pushTVChanges(bodyChange)
     }
   }
@@ -332,11 +332,11 @@ export class TV extends irdeviceBase {
   async pushVolumeDownChanges(): Promise<void> {
     await this.debugLog(`pushVolumeDownChanges disablePushDetail: ${this.disablePushDetail}`)
     if (!this.disablePushDetail) {
-      const bodyChange = JSON.stringify({
+      const bodyChange: bodyChange = {
         command: 'volumeSub',
         parameter: 'default',
         commandType: 'command',
-      })
+      }
       await this.pushTVChanges(bodyChange)
     }
   }

package/src/irdevice/vacuumcleaner.ts

@@ -3,10 +3,10 @@
  * vacuumcleaner.ts: @switchbot/homebridge-switchbot.
  */
 import type { CharacteristicValue, PlatformAccessory, Service } from 'homebridge'
+import type { bodyChange, irdevice } from 'node-switchbot'
 
 import type { SwitchBotPlatform } from '../platform.js'
 import type { irDevicesConfig } from '../settings.js'
-import type { irdevice } from '../types/irdevicelist.js'
 
 import { irdeviceBase } from './irdevice.js'
 
@@ -69,11 +69,11 @@ export class VacuumCleaner extends irdeviceBase {
     if (this.Switch.On && !this.disablePushOn) {
       const commandType: string = await this.commandType()
       const command: string = await this.commandOn()
-      const bodyChange = JSON.stringify({
+      const bodyChange: bodyChange = {
         command,
         parameter: 'default',
         commandType,
-      })
+      }
       await this.pushChanges(bodyChange)
     }
   }
@@ -83,11 +83,11 @@ export class VacuumCleaner extends irdeviceBase {
     if (!this.Switch.On && !this.disablePushOff) {
       const commandType: string = await this.commandType()
       const command: string = await this.commandOff()
-      const bodyChange = JSON.stringify({
+      const bodyChange: bodyChange = {
         command,
         parameter: 'default',
         commandType,
-      })
+      }
       await this.pushChanges(bodyChange)
     }
   }

package/src/irdevice/waterheater.ts

@@ -3,10 +3,10 @@
  * waterheater.ts: @switchbot/homebridge-switchbot.
  */
 import type { CharacteristicValue, PlatformAccessory, Service } from 'homebridge'
+import type { bodyChange, irdevice } from 'node-switchbot'
 
 import type { SwitchBotPlatform } from '../platform.js'
 import type { irDevicesConfig } from '../settings.js'
-import type { irdevice } from '../types/irdevicelist.js'
 
 import { irdeviceBase } from './irdevice.js'
 
@@ -70,11 +70,11 @@ export class WaterHeater extends irdeviceBase {
     if (this.Valve.Active === this.hap.Characteristic.Active.ACTIVE && !this.disablePushOn) {
       const commandType: string = await this.commandType()
       const command: string = await this.commandOn()
-      const bodyChange = JSON.stringify({
+      const bodyChange: bodyChange = {
         command,
         parameter: 'default',
         commandType,
-      })
+      }
       await this.pushChanges(bodyChange)
     }
   }
@@ -84,11 +84,11 @@ export class WaterHeater extends irdeviceBase {
     if (this.Valve.Active === this.hap.Characteristic.Active.INACTIVE && !this.disablePushOff) {
       const commandType: string = await this.commandType()
       const command: string = await this.commandOff()
-      const bodyChange = JSON.stringify({
+      const bodyChange: bodyChange = {
         command,
         parameter: 'default',
         commandType,
-      })
+      }
       await this.pushChanges(bodyChange)
     }
   }

package/src/platform.ts

@@ -2,21 +2,14 @@
  *
  * platform.ts: @switchbot/homebridge-switchbot platform class.
  */
-import type { IncomingMessage, Server, ServerResponse } from 'node:http'
-import type { UrlObject } from 'node:url'
+import type { Server } from 'node:http'
 
 import type { API, DynamicPlatformPlugin, Logging, PlatformAccessory } from 'homebridge'
 import type { MqttClient } from 'mqtt'
-import type { Dispatcher } from 'undici'
 
 import type { devicesConfig, irDevicesConfig, options, SwitchBotPlatformConfig } from './settings.js'
-import type { blindTilt, curtain, curtain3, device } from './types/devicelist.js'
-import type { irdevice } from './types/irdevicelist.js'
 
-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'
@@ -26,9 +19,10 @@ 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 type { blindTilt, curtain, curtain3, device, irdevice } from 'node-switchbot'
+
+import { LogLevel, SwitchBot, 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'
@@ -57,7 +51,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'
 
 /**
@@ -92,6 +86,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
   // Event Handlers
   public readonly webhookEventHandler: { [x: string]: (context: any) => void } = {}
   public readonly bleEventHandler: { [x: string]: (context: any) => void } = {}
+  switchBotAPI!: SwitchBotOpenAPI
 
   constructor(
     log: Logging,
@@ -132,6 +127,10 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       return
     }
 
+    // SwitchBot OpenAPI
+    this.switchBotAPI = new SwitchBotOpenAPI(this.config.credentials?.token, this.config.credentials?.secret)
+    // Set the log level
+    this.switchBotAPI.setLogLevel(LogLevel.DEBUG)
     // import fakegato-history module and EVE characteristics
     this.fakegatoAPI = fakegato(api)
     this.eve = new EveHomeKitTypes(api)
@@ -208,121 +207,32 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
     // webhook configuration
     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: IncomingMessage, response: ServerResponse) => {
-          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: any) {
-                  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`);
-            // }
-          } catch (e: any) {
-            this.errorLog(`Failed to handle webhook event. Error:${e}`)
-          }
-        }).listen(port || 80)
-      } catch (e: any) {
-        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.switchBotAPI.setupWebhook(url)
+        // Listen for webhook events
+        this.switchBotAPI.on('webhookEvent', (body) => {
+          this.debugLog('Received webhook event:', body)
+          this.webhookEventHandler[body.context.deviceMac]?.(body.context)
         })
-        const response: any = 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: any) {
-        await this.errorLog(`Failed to configure webhook. Error: ${e.message}`)
+        await this.errorLog(`Failed to setup 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: any = 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}`)
-        }
+        this.switchBotAPI.updateWebhook(url)
       } catch (e: any) {
         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: any = 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]}`)
-        }
+        this.switchBotAPI.queryWebhook()
       } catch (e: any) {
-        await this.errorLog(`Failed to query webhook. Error:${e}`)
+        await this.errorLog(`Failed to query 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: any = 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: any) {
           await this.errorLog(`Failed to delete webhook. Error:${e.message}`)
         }
@@ -535,25 +445,6 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
     }
   }
 
-  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()
@@ -569,7 +460,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
 
     while (retryCount < maxRetries) {
       try {
-        const { body, statusCode } = await request(Devices, { headers: this.generateHeaders() })
+        const { body, statusCode } = await this.switchBotAPI.getDevices()
         await this.debugWarnLog(`statusCode: ${statusCode}`)
         const devicesAPI: any = await body.json()
         await this.debugWarnLog(`devicesAPI: ${JSON.stringify(devicesAPI)}`)
@@ -2643,13 +2534,13 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
     }
   }
 
-  async retryRequest(deviceMaxRetries: number, deviceDelayBetweenRetries: number, url: string | URL | UrlObject, options?: { dispatcher?: Dispatcher } & Omit<Dispatcher.RequestOptions, 'origin' | 'path' | 'method'> & Partial<Pick<Dispatcher.RequestOptions, 'method'>>): Promise<{ body: any, statusCode: number }> {
+  async retryRequest(deviceId: string, deviceMaxRetries: number, deviceDelayBetweenRetries: number): Promise<{ body: any, statusCode: number }> {
     let retryCount = 0
     const maxRetries = deviceMaxRetries
     const delayBetweenRetries = deviceDelayBetweenRetries
     while (retryCount < maxRetries) {
       try {
-        const { body, statusCode } = await request(url, options)
+        const { body, statusCode } = await this.switchBotAPI.getDeviceStatus(deviceId)
         if (statusCode === 200 || statusCode === 100) {
           return { body, statusCode }
         } else {

package/src/settings.ts

@@ -4,10 +4,7 @@
  */
 import type { IClientOptions } from 'async-mqtt'
 import type { PlatformConfig } from 'homebridge'
-import type { SwitchBotBLEModel, SwitchBotBLEModelFriendlyName, SwitchBotBLEModelName } from 'node-switchbot'
-
-import type { device } from './types/devicelist'
-import type { irdevice } from './types/irdevicelist'
+import type { device, irdevice, SwitchBotBLEModel, SwitchBotBLEModelFriendlyName, SwitchBotBLEModelName } from 'node-switchbot'
 /**
  * This is the name of the platform that users will use to register the plugin in the Homebridge config.json
  */

package/src/utils.ts

@@ -2,8 +2,9 @@
  *
  * util.ts: @switchbot/homebridge-switchbot platform class.
  */
+import type { blindTilt, curtain, curtain3, device } from 'node-switchbot'
+
 import type { devicesConfig } from './settings.js'
-import type { blindTilt, curtain, curtain3, device } from './types/devicelist.js'
 
 export enum SwitchBotModel {
   HubMini = 'W0202200',