@switchbot/homebridge-switchbot 3.7.1-beta.9 → 3.8.0

package/src/types/devicewebhookstatus.ts

@@ -2,195 +2,190 @@
  *
  * devicestatus.ts: @switchbot/homebridge-switchbot platform class.
  */
-export { deviceWebhook };
-
-type deviceWebhook = {
-  eventType: string,
-  eventVersion: string,
+interface deviceWebhook {
+  eventType: string
+  eventVersion: string
   context: deviceWebhookContext
-};
+}
+
+export { deviceWebhook }
 
-export type deviceWebhookContext = {
-  //properties on all devices
-  deviceMac: string;
-  deviceType: string;
+export interface deviceWebhookContext {
+  // properties on all devices
+  deviceMac: string
+  deviceType: string
   timeOfSample: number
-};
+}
 
 export type botWebhookContext = deviceWebhookContext & {
-  power: string, //"on"or"off"
-  battery: number,
-  deviceMode: 'pressMode' | 'switchMode' | 'customizeMode',
-};
+  power: string // "on"or"off"
+  battery: number
+  deviceMode: 'pressMode' | 'switchMode' | 'customizeMode'
+}
 
 export type curtainWebhookContext = deviceWebhookContext & {
-  calibrate: boolean,
-  group: boolean,
-  slidePosition: number, //0~100
-  battery: number,
-};
+  calibrate: boolean
+  group: boolean
+  slidePosition: number // 0~100
+  battery: number
+}
 
 export type curtain3WebhookContext = deviceWebhookContext & {
-  calibrate: boolean,
-  group: boolean,
-  slidePosition: number, //0~100
-  battery: number,
-};
+  calibrate: boolean
+  group: boolean
+  slidePosition: number // 0~100
+  battery: number
+}
 
 export type motionSensorWebhookContext = deviceWebhookContext & {
-  detectionState: 'NOT_DETECTED' | 'DETECTED',
-};
+  detectionState: 'NOT_DETECTED' | 'DETECTED'
+}
 
 export type contactSensorWebhookContext = deviceWebhookContext & {
-  detectionState: 'NOT_DETECTED' | 'DETECTED',
-  doorMode: 'IN_DOOR' | 'OUT_DOOR',
-  brightness: 'dim' | 'bright',
-  openState: 'open' | 'close' | 'timeOutNotClose',
-};
+  detectionState: 'NOT_DETECTED' | 'DETECTED'
+  doorMode: 'IN_DOOR' | 'OUT_DOOR'
+  brightness: 'dim' | 'bright'
+  openState: 'open' | 'close' | 'timeOutNotClose'
+}
 
 export type waterLeakDetectorWebhookContext = deviceWebhookContext & {
-  detectionState: 0 | 1,
-  battery: number, //0~100
-};
+  detectionState: 0 | 1
+  battery: number // 0~100
+}
 
 export type meterWebhookContext = deviceWebhookContext & {
-  temperature: number,
-  scale: 'CELSIUS' | 'FAHRENHEIT',
-  humidity: number,
-};
+  temperature: number
+  scale: 'CELSIUS' | 'FAHRENHEIT'
+  humidity: number
+}
 
 export type meterPlusWebhookContext = deviceWebhookContext & {
-  temperature: number,
-  scale: 'CELSIUS' | 'FAHRENHEIT',
-  humidity: number,
-};
+  temperature: number
+  scale: 'CELSIUS' | 'FAHRENHEIT'
+  humidity: number
+}
 
 export type outdoorMeterWebhookContext = deviceWebhookContext & {
-  temperature: number,
-  scale: 'CELSIUS' | 'FAHRENHEIT',
-  humidity: number,
-};
+  temperature: number
+  scale: 'CELSIUS' | 'FAHRENHEIT'
+  humidity: number
+}
 
 export type lockWebhookContext = deviceWebhookContext & {
-  lockState: 'UNLOCKED' | 'LOCKED' | 'JAMMED',
-};
+  lockState: 'UNLOCKED' | 'LOCKED' | 'JAMMED'
+}
 
 export type lockProWebhookContext = deviceWebhookContext & {
-  lockState: 'UNLOCKED' | 'LOCKED' | 'JAMMED',
-};
+  lockState: 'UNLOCKED' | 'LOCKED' | 'JAMMED'
+}
 
 export type indoorCameraWebhookContext = deviceWebhookContext & {
-  detectionState: 'DETECTED',
-};
+  detectionState: 'DETECTED'
+}
 
 export type panTiltCamWebhookContext = deviceWebhookContext & {
-  detectionState: 'DETECTED',
-};
+  detectionState: 'DETECTED'
+}
 
 export type colorBulbWebhookContext = deviceWebhookContext & {
-  powerState: 'ON' | 'OFF',
-  brightness: number,
-  color: string, //RGB 255:255:255
-  colorTemperature: number, // 2700~6500
-};
+  powerState: 'ON' | 'OFF'
+  brightness: number
+  color: string // RGB 255:255:255
+  colorTemperature: number // 2700~6500
+}
 
 export type stripLightWebhookContext = deviceWebhookContext & {
-  powerState: 'ON' | 'OFF',
-  brightness: number,
-  color: string, //RGB 255:255:255
-};
+  powerState: 'ON' | 'OFF'
+  brightness: number
+  color: string // RGB 255:255:255
+}
 
 export type plugWebhookContext = deviceWebhookContext & {
-  powerState: 'ON' | 'OFF',
-};
+  powerState: 'ON' | 'OFF'
+}
 
 export type plugMiniUSWebhookContext = deviceWebhookContext & {
-  powerState: 'ON' | 'OFF',
-};
+  powerState: 'ON' | 'OFF'
+}
 
 export type plugMiniJPWebhookContext = deviceWebhookContext & {
-  powerState: 'ON' | 'OFF',
-};
+  powerState: 'ON' | 'OFF'
+}
 
 export type robotVacuumCleanerS1WebhookContext = deviceWebhookContext & {
-  workingStatus: 'Standby' | 'Clearing' | 'Paused' | 'GotoChargeBase' | 'Charging' | 'ChargeDone' | 'Dormant' | 'InTrouble'
-  | 'InRemoteControl' | 'InDustCollecting',
-  onlineStatus: 'online' | 'offline',
-  battery: number, //0~100
-};
+  workingStatus: 'Standby' | 'Clearing' | 'Paused' | 'GotoChargeBase' | 'Charging' | 'ChargeDone' | 'Dormant' | 'InTrouble' | 'InRemoteControl' | 'InDustCollecting'
+  onlineStatus: 'online' | 'offline'
+  battery: number // 0~100
+}
 
 export type robotVacuumCleanerS1PlusWebhookContext = deviceWebhookContext & {
-  workingStatus: 'Standby' | 'Clearing' | 'Paused' | 'GotoChargeBase' | 'Charging' | 'ChargeDone' | 'Dormant' | 'InTrouble'
-  | 'InRemoteControl' | 'InDustCollecting',
-  onlineStatus: 'online' | 'offline',
-  battery: number, //0~100
-};
+  workingStatus: 'Standby' | 'Clearing' | 'Paused' | 'GotoChargeBase' | 'Charging' | 'ChargeDone' | 'Dormant' | 'InTrouble' | 'InRemoteControl' | 'InDustCollecting'
+  onlineStatus: 'online' | 'offline'
+  battery: number // 0~100
+}
 
 export type floorCleaningRobotS10WebhookContext = deviceWebhookContext & {
-  workingStatus: 'Standby' | 'Clearing' | 'Paused' | 'GotoChargeBase' | 'Charging' | 'ChargeDone' | 'Dormant' | 'InTrouble'
-  | 'InRemoteControl' | 'InDustCollecting',
-  onlineStatus: 'online' | 'offline',
-  battery: number, //0~100
-  waterBaseBattery: number, //0~100
-  taskType: 'standBy' | 'explore' | 'cleanAll' | 'cleanArea' | 'cleanRoom' | 'fillWater' | 'deepWashing' | 'backToCharge' | 'markingWaterBase'
-  | 'drying' | 'collectDust' | 'remoteControl' | 'cleanWithExplorer' | 'fillWaterForHumi' | 'markingHumi',
-};
+  workingStatus: 'Standby' | 'Clearing' | 'Paused' | 'GotoChargeBase' | 'Charging' | 'ChargeDone' | 'Dormant' | 'InTrouble' | 'InRemoteControl' | 'InDustCollecting'
+  onlineStatus: 'online' | 'offline'
+  battery: number // 0~100
+  waterBaseBattery: number // 0~100
+  taskType: 'standBy' | 'explore' | 'cleanAll' | 'cleanArea' | 'cleanRoom' | 'fillWater' | 'deepWashing' | 'backToCharge' | 'markingWaterBase' | 'drying' | 'collectDust' | 'remoteControl' | 'cleanWithExplorer' | 'fillWaterForHumi' | 'markingHumi'
+}
 
 export type ceilingLightWebhookContext = deviceWebhookContext & {
-  powerState: 'ON' | 'OFF',
-  brightness: number,
-  colorTemperature: number, // 2700~6500
-};
+  powerState: 'ON' | 'OFF'
+  brightness: number
+  colorTemperature: number // 2700~6500
+}
 
 export type ceilingLightProWebhookContext = deviceWebhookContext & {
-  powerState: 'ON' | 'OFF',
-  brightness: number,
-  colorTemperature: number, // 2700~6500
-};
+  powerState: 'ON' | 'OFF'
+  brightness: number
+  colorTemperature: number // 2700~6500
+}
 
 export type keypadWebhookContext = deviceWebhookContext & {
-  eventName: 'createKey' | 'deleteKey',
-  commandId: string,
-  result: 'success' | 'failed' | 'timeout',
-};
+  eventName: 'createKey' | 'deleteKey'
+  commandId: string
+  result: 'success' | 'failed' | 'timeout'
+}
 
 export type keypadTouchWebhookContext = deviceWebhookContext & {
-  eventName: 'createKey' | 'deleteKey',
-  commandId: string,
-  result: 'success' | 'failed' | 'timeout',
-};
+  eventName: 'createKey' | 'deleteKey'
+  commandId: string
+  result: 'success' | 'failed' | 'timeout'
+}
 
 export type hub2WebhookContext = deviceWebhookContext & {
-  temperature: number,
-  humidity: number,
-  lightLevel: number,
-  scale: 'CELSIUS' | 'FAHRENHEIT',
-};
+  temperature: number
+  humidity: number
+  lightLevel: number
+  scale: 'CELSIUS' | 'FAHRENHEIT'
+}
 
 export type batteryCirculatorFanWebhookContext = deviceWebhookContext & {
-  mode: 'direct' | 'natural' | 'sleep' | 'baby',
-  version: string,
-  battery: number,
-  powerState: 'ON' | 'OFF',
-  nightStatus: 'off' | 1 | 2,
-  oscillation: 'on' | 'off',
-  verticalOscillation: 'on' | 'off',
-  chargingStatus: 'charging' | 'uncharged',
-  fanSpeed: number, //1~100
-};
+  mode: 'direct' | 'natural' | 'sleep' | 'baby'
+  version: string
+  battery: number
+  powerState: 'ON' | 'OFF'
+  nightStatus: 'off' | 1 | 2
+  oscillation: 'on' | 'off'
+  verticalOscillation: 'on' | 'off'
+  chargingStatus: 'charging' | 'uncharged'
+  fanSpeed: number // 1~100
+}
 
 export type blindTiltWebhookContext = deviceWebhookContext & {
-  version: string,
-  calibrate: boolean,
-  group: boolean,
-  direction: string,
-  slidePosition: number, //0~100
-  battery: number,
-};
+  version: string
+  calibrate: boolean
+  group: boolean
+  direction: string
+  slidePosition: number // 0~100
+  battery: number
+}
 
 export type humidifierWebhookContext = deviceWebhookContext & {
-  temperature: number,
-  humidity: number,
-  scale: 'CELSIUS' | 'FAHRENHEIT',
-};
-
+  temperature: number
+  humidity: number
+  scale: 'CELSIUS' | 'FAHRENHEIT'
+}

package/src/types/irdevicelist.ts

@@ -2,14 +2,14 @@
  *
  * irdevicelist.ts: @switchbot/homebridge-switchbot platform class.
  */
-//a list of virtual infrared remote devices that are linked to SwitchBot Hubs.
-export type infraredRemoteList = {
-  device: irdevice[];
-};
+// a list of virtual infrared remote devices that are linked to SwitchBot Hubs.
+export interface infraredRemoteList {
+  device: irdevice[]
+}
 
-export type irdevice = {
-  deviceId?: string;
-  deviceName: string;
-  remoteType: string;
-  hubDeviceId: string;
-};
+export interface irdevice {
+  deviceId?: string
+  deviceName: string
+  remoteType: string
+  hubDeviceId: string
+}

package/src/types/pushbody.ts

@@ -2,8 +2,8 @@
  *
  * pushbody.ts: @switchbot/homebridge-switchbot platform class.
  */
-export type body = {
-  command: string;
-  parameter: string;
-  commandType: string;
-};
+export interface body {
+  command: string
+  parameter: string
+  commandType: string
+}

package/src/utils.ts

@@ -2,6 +2,9 @@
  *
  * util.ts: @switchbot/homebridge-switchbot platform class.
  */
+import type { devicesConfig } from './settings.js'
+import type { blindTilt, curtain, curtain3, device } from './types/devicelist.js'
+
 export enum SwitchBotModel {
   HubMini = 'W0202200',
   HubPlus = 'SwitchBot Hub S1',
@@ -115,19 +118,16 @@ export enum BlindTiltMappingMode {
   UseTiltForDirection = 'use_tilt_for_direction',
 }
 
-import type { devicesConfig } from './settings.js';
-import type { blindTilt, curtain, curtain3, device } from './types/devicelist.js';
-
 export function isCurtainDevice(device: device & devicesConfig): device is (curtain | curtain3) & devicesConfig {
-  return device.deviceType === 'Curtain' || device.deviceType === 'Curtain3';
+  return device.deviceType === 'Curtain' || device.deviceType === 'Curtain3'
 }
 
 export function isBlindTiltDevice(device: device & devicesConfig): device is blindTilt & devicesConfig {
-  return device.deviceType === 'Blind Tilt';
+  return device.deviceType === 'Blind Tilt'
 }
 
 export function sleep(ms: number): Promise<void> {
-  return new Promise((resolve) => setTimeout(resolve, ms));
+  return new Promise(resolve => setTimeout(resolve, ms))
 }
 /**
  * Check if the humidity is within the min and max range
@@ -135,63 +135,62 @@ export function sleep(ms: number): Promise<void> {
  * @param min - The minimum humidity value
  * @param max - The maximum humidity value
  * @returns The humidity value
-**/
+ */
 export function validHumidity(humidity: number, min?: number, max?: number): number {
   if (humidity < (min || 0)) {
-    return min ?? 0;
+    return min ?? 0
   } else if (humidity > (max || 100)) {
-    return max ?? 100;
+    return max ?? 100
   }
-  return humidity;
+  return humidity
 }
 
 /**
  * Converts the value to celsius if the temperature units are in Fahrenheit
-**/
+ */
 export function convertUnits(value: number, unit: string, convert?: string): number {
   if (unit === 'CELSIUS' && convert === 'CELSIUS') {
-    return Math.round((value * 9) / 5 + 32);
+    return Math.round((value * 9) / 5 + 32)
   } else if (unit === 'FAHRENHEIT' && convert === 'FAHRENHEIT') {
     // celsius should be to the nearest 0.5 degree
-    return Math.round((5 / 9) * (value - 32) * 2) / 2;
+    return Math.round((5 / 9) * (value - 32) * 2) / 2
   }
-  return value;
+  return value
 }
 
-
 export function rgb2hs(r: any, g: any, b: any) {
   /**
    * Credit:
    * https://github.com/WickyNilliams/pure-color
-  **/
-  r = parseInt(r);
-  g = parseInt(g);
-  b = parseInt(b);
-  const min = Math.min(r, g, b);
-  const max = Math.max(r, g, b);
-  const delta = max - min;
-  let h;
-  let s;
+   */
+  r = Number.parseInt(r)
+  g = Number.parseInt(g)
+  b = Number.parseInt(b)
+  const min = Math.min(r, g, b)
+  const max = Math.max(r, g, b)
+  const delta = max - min
+  let h
+  let s
   if (max === 0) {
-    s = 0;
+    s = 0
   } else {
-    s = (delta / max) * 100;
+    s = (delta / max) * 100
   }
   if (max === min) {
-    h = 0;
+    h = 0
   } else if (r === max) {
-    h = (g - b) / delta;
+    h = (g - b) / delta
   } else if (g === max) {
-    h = 2 + (b - r) / delta;
+    h = 2 + (b - r) / delta
   } else if (b === max) {
-    h = 4 + (r - g) / delta;
+    h = 4 + (r - g) / delta
   }
-  h = Math.min(h * 60, 360);
+  h = Math.min(h * 60, 360)
 
   if (h < 0) {
-    h += 360;
+    h += 360
   }
-  return [Math.round(h), Math.round(s)];
+  return [Math.round(h), Math.round(s)]
 }
 
 export function hs2rgb(h: any, s: any) {
@@ -199,48 +198,48 @@ export function hs2rgb(h: any, s: any) {
     Credit:
     https://github.com/WickyNilliams/pure-color
   */
-  h = parseInt(h) / 60;
-  s = parseInt(s) / 100;
-  const f = h - Math.floor(h);
-  const p = 255 * (1 - s);
-  const q = 255 * (1 - s * f);
-  const t = 255 * (1 - s * (1 - f));
-  let rgb;
+  h = Number.parseInt(h) / 60
+  s = Number.parseInt(s) / 100
+  const f = h - Math.floor(h)
+  const p = 255 * (1 - s)
+  const q = 255 * (1 - s * f)
+  const t = 255 * (1 - s * (1 - f))
+  let rgb
   switch (Math.floor(h) % 6) {
     case 0:
-      rgb = [255, t, p];
-      break;
+      rgb = [255, t, p]
+      break
     case 1:
-      rgb = [q, 255, p];
-      break;
+      rgb = [q, 255, p]
+      break
     case 2:
-      rgb = [p, 255, t];
-      break;
+      rgb = [p, 255, t]
+      break
     case 3:
-      rgb = [p, q, 255];
-      break;
+      rgb = [p, q, 255]
+      break
     case 4:
-      rgb = [t, p, 255];
-      break;
+      rgb = [t, p, 255]
+      break
     case 5:
-      rgb = [255, p, q];
-      break;
+      rgb = [255, p, q]
+      break
   }
   if (rgb[0] === 255) {
-    rgb[1] *= 0.8;
-    rgb[2] *= 0.8;
+    rgb[1] *= 0.8
+    rgb[2] *= 0.8
     if (rgb[1] <= 25 && rgb[2] <= 25) {
-      rgb[1] = 0;
-      rgb[2] = 0;
+      rgb[1] = 0
+      rgb[2] = 0
     }
   }
-  return [Math.round(rgb[0]), Math.round(rgb[1]), Math.round(rgb[2])];
+  return [Math.round(rgb[0]), Math.round(rgb[1]), Math.round(rgb[2])]
 }
 
 export function k2rgb(k: number) {
   // Set kelvin to nearest 100, between 2000 and 7100
-  k = Math.round(k / 100) * 100;
-  k = Math.max(Math.min(k, 7100), 2000);
+  k = Math.round(k / 100) * 100
+  k = Math.max(Math.min(k, 7100), 2000)
 
   // k should now appear in our table of kelvin to rgb
   const values = {
@@ -295,10 +294,10 @@ export function k2rgb(k: number) {
     6900: [247, 245, 255],
     7000: [245, 243, 255],
     7100: [243, 242, 255],
-  };
+  }
 
   // Return the value
-  return values[k];
+  return values[k]
 }
 
 export function m2hs(m) {
@@ -708,8 +707,8 @@ export function m2hs(m) {
     498: [63.8, 28.3],
     499: [63.9, 28.3],
     500: [64.1, 28.3],
-  };
-  const input = Math.min(Math.max(Math.round(m), 140), 500);
-  const toReturn = table[input];
-  return [Math.round(toReturn[1]), Math.round(toReturn[0])];
+  }
+  const input = Math.min(Math.max(Math.round(m), 140), 500)
+  const toReturn = table[input]
+  return [Math.round(toReturn[1]), Math.round(toReturn[0])]
 }

package/tsconfig.json

@@ -1,22 +1,23 @@
 {
   "compilerOptions": {
     "target": "ES2022",
-    "module": "ES2022",
     "lib": [
       "DOM",
       "ES2022"
     ],
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true,
-    "outDir": "dist",
     "rootDir": "src",
+    "module": "ES2022",
+    "moduleResolution": "node",
+    "types": ["node"],
     "strict": true,
-    "esModuleInterop": true,
     "noImplicitAny": false,
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "dist",
+    "sourceMap": true,
     "allowSyntheticDefaultImports": true,
-    "forceConsistentCasingInFileNames": true,
-    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true
   },
   "include": [
     "src"
@@ -24,4 +25,4 @@
   "exclude": [
     "**/*.spec.ts"
   ]
-}
+}