@switchbot/homebridge-switchbot 3.5.1-beta.0 → 3.5.1-beta.10

package/src/types/devicelist.ts

@@ -0,0 +1,124 @@
+/* Copyright(C) 2017-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
+ *
+ * devicelist.ts: @switchbot/homebridge-switchbot platform class.
+ */
+
+export type deviceList = {
+  device: device[];
+};
+
+export type device = {
+  deviceId: string;
+  deviceName: string;
+  deviceType: string;
+  enableCloudService: boolean;
+  hubDeviceId: string;
+  version?: number;
+};
+
+export type bot = device & {};
+
+export type curtain = device & {
+  curtainDevicesIds: string[];
+  calibrate: boolean;
+  group: boolean;
+  master: boolean;
+  openDirection: string;
+};
+
+export type curtain3 = device & {
+  curtainDevicesIds: string[];
+  calibrate: boolean;
+  group: boolean;
+  master: boolean;
+  openDirection?: string;
+};
+
+export type hub2 = device & {};
+
+export type meter = device & {};
+
+export type meterPlus = device & {};
+
+export type outdoorMeter = device & {};
+
+export type lock = device & {
+  group: boolean;
+  master: boolean;
+  groupName: string;
+  lockDevicesIds: string[];
+};
+
+export type lockPro = device & {
+  group: boolean;
+  master: boolean;
+  groupName: string;
+  lockDevicesIds: string[];
+};
+
+export type keypad = device & {
+  remoteType: string;
+  lockDeviceId: string;
+  keyList: keyList
+};
+
+export type keypadTouch = device & {
+  remoteType: string;
+  lockDeviceId: string;
+  keyList: keyList
+};
+
+type keyList = {
+  id: number;
+  name: string;
+  type: string;
+  password: string;
+  iv: string;
+  status: string;
+  createTime: number;
+};
+
+export type remote = device & {};
+
+export type motionSensor = device & {};
+
+export type contactSensor = device & {};
+
+export type waterLeakDetector = device & {};
+
+export type ceilingLight = device & {};
+
+export type ceilingLightPro = device & {};
+
+export type plug = device & {};
+
+export type plugMini = device & {};
+
+export type stripLight = device & {};
+
+export type colorBulb = device & {};
+
+export type robotVacuumCleanerS1 = device & {};
+
+export type robotVacuumCleanerS1Plus = device & {};
+
+export type floorCleaningRobotS10 = device & {};
+
+export type humidifier = device & {};
+
+export type indoorCam = device & {};
+
+export type pantiltCam = device & {};
+
+export type pantiltCam2k = device & {};
+
+export type blindTilt = device & {
+  blindTiltDevicesIds: string[];
+  calibrate: boolean;
+  group: boolean;
+  master: boolean;
+  direction: string;
+  slidePosition: number;
+};
+
+export type batteryCirculatorFan = device & {};

package/src/types/deviceresponse.ts

@@ -0,0 +1,15 @@
+import type { deviceList } from './devicelist';
+import type { infraredRemoteList } from './irdevicelist';
+
+
+//json response from SwitchBot API
+export type devices = {
+  statusCode: 100 | 190 | 'n/a';
+  message: string;
+  body: body;
+};
+
+type body = {
+  deviceList: deviceList;
+  infraredRemoteList: infraredRemoteList;
+};

package/src/types/devicestatus.ts

@@ -0,0 +1,178 @@
+import type { device } from './devicelist';
+
+/* Copyright(C) 2017-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
+ *
+ * devicestatus.ts: @switchbot/homebridge-switchbot platform class.
+ */
+export type deviceStatusRequest = {
+  statusCode: number;
+  message: string;
+  body: deviceStatus;
+};
+
+export interface deviceStatus extends device {
+  //properties on all devices
+  deviceId: string;
+  deviceType: string;
+  hubDeviceId: string;
+  version: number;
+};
+
+export type botStatus = deviceStatus & {
+  power: string;
+  battery: number;
+  mode: 'pressMode' | 'switchMode' | 'customizeMode';
+};
+
+export type curtainStatus = deviceStatus & {
+  calibrate: boolean;
+  group: boolean;
+  moving: boolean;
+  battery: number;
+  slidePosition: number;
+  lightLevel?: 'bright' | 'dim';
+};
+
+export type meterStatus = deviceStatus & {
+  temperature: number;
+  battery: number;
+  humidity: number;
+};
+
+export type meterPlusStatus = deviceStatus & {
+  temperature: number;
+  battery: number;
+  humidity: number;
+};
+
+export type outdoorMeterStatus = deviceStatus & {
+  battery: number;
+  temperature: number;
+  humidity: number;
+};
+
+export type lockStatus = deviceStatus & {
+  lockState: string;
+  doorState: string;
+  moveDetected: boolean;
+  battery: number;
+};
+
+export type lockProStatus = deviceStatus & {
+  lockState: string;
+  doorState: string;
+  moveDetected: boolean;
+  battery: number;
+};
+
+export type motionSensorStatus = deviceStatus & {
+  battery: number;
+  moveDetected: boolean;
+  brightness: 'bright' | 'dim';
+};
+
+export type contactSensorStatus = deviceStatus & {
+  battery: number;
+  moveDetected: boolean;
+  openState: 'open' | 'close' | 'timeOutNotClose';
+  brightness: 'bright' | 'dim';
+};
+
+export type waterLeakDetectorStatus = deviceStatus & {
+  battery: number;
+  status: 0 /*dry*/ | 1 /*leak detected*/;
+};
+
+export type ceilingLightStatus = deviceStatus & {
+  power: boolean;
+  brightness: number;
+  colorTemperature: number;
+};
+
+export type ceilingLightProStatus = deviceStatus & {
+  power: boolean;
+  brightness: number;
+  colorTemperature: number;
+};
+
+export type plugStatus = deviceStatus & {
+  power: string;
+  version: string;
+};
+
+export type plugMiniStatus = deviceStatus & {
+  voltage: Float64Array;
+  weight: Float64Array;
+  electricityOfDay: number;
+  electricCurrent: Float64Array;
+  power: string;
+};
+
+export type stripLightStatus = deviceStatus & {
+  power: string;
+  brightness: number;
+  color: string;
+};
+
+export type colorBulbStatus = deviceStatus & {
+  power: string;
+  brightness: number;
+  color: string;
+  colorTemperature: number;
+};
+
+export type robotVacuumCleanerS1Status = deviceStatus & {
+  workingStatus: string;
+  onlineStatus: string;
+  battery: number;
+};
+
+export type robotVacuumCleanerS1PlusStatus = deviceStatus & {
+  workingStatus: string;
+  onlineStatus: string;
+  battery: number;
+};
+
+export type floorCleaningRobotS10Status = deviceStatus & {
+  workingStatus: string;
+  onlineStatus: string;
+  battery: number;
+  waterBaseBattery: number;
+  taskType: string;
+};
+
+export type humidifierStatus = deviceStatus & {
+  power: string;
+  humidity: number;
+  temperature: number;
+  nebulizationEfficiency: number;
+  auto: boolean;
+  childLock: boolean;
+  sound: boolean;
+  lackWater: boolean;
+};
+
+export type blindTiltStatus = deviceStatus & {
+  calibrate: boolean;
+  battery: boolean;
+  direction: string;
+  slidePosition: string;
+  lightLevel?: 'bright' | 'dim';
+};
+
+export type hub2Status = deviceStatus & {
+  temperature: number;
+  lightLevel: number;
+  humidity: number;
+};
+
+export type batteryCirculatorFanStatus = deviceStatus & {
+  mode: 'direct' | 'natural' | 'sleep' | 'baby';
+  battery: number;
+  power: string;
+  nightStatus: number;
+  oscillation: string;
+  verticalOscillation: string;
+  chargingStatus: string;
+  fanSpeed: number;
+};

package/src/types/devicewebhookstatus.ts

@@ -0,0 +1,196 @@
+/* Copyright(C) 2017-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
+ *
+ * devicestatus.ts: @switchbot/homebridge-switchbot platform class.
+ */
+export { deviceWebhook };
+
+type deviceWebhook = {
+  eventType: string,
+  eventVersion: string,
+  context: deviceWebhookContext
+};
+
+export type 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',
+};
+
+export type curtainWebhookContext = deviceWebhookContext & {
+  calibrate: boolean,
+  group: boolean,
+  slidePosition: number, //0~100
+  battery: number,
+};
+
+export type curtain3WebhookContext = deviceWebhookContext & {
+  calibrate: boolean,
+  group: boolean,
+  slidePosition: number, //0~100
+  battery: number,
+};
+
+export type motionSensorWebhookContext = deviceWebhookContext & {
+  detectionState: 'NOT_DETECTED' | 'DETECTED',
+};
+
+export type contactSensorWebhookContext = deviceWebhookContext & {
+  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
+};
+
+export type meterWebhookContext = deviceWebhookContext & {
+  temperature: number,
+  scale: 'CELSIUS' | 'FAHRENHEIT',
+  humidity: number,
+};
+
+export type meterPlusWebhookContext = deviceWebhookContext & {
+  temperature: number,
+  scale: 'CELSIUS' | 'FAHRENHEIT',
+  humidity: number,
+};
+
+export type outdoorMeterWebhookContext = deviceWebhookContext & {
+  temperature: number,
+  scale: 'CELSIUS' | 'FAHRENHEIT',
+  humidity: number,
+};
+
+export type lockWebhookContext = deviceWebhookContext & {
+  lockState: 'UNLOCKED' | 'LOCKED' | 'JAMMED',
+};
+
+export type lockProWebhookContext = deviceWebhookContext & {
+  lockState: 'UNLOCKED' | 'LOCKED' | 'JAMMED',
+};
+
+export type indoorCameraWebhookContext = deviceWebhookContext & {
+  detectionState: 'DETECTED',
+};
+
+export type panTiltCamWebhookContext = deviceWebhookContext & {
+  detectionState: 'DETECTED',
+};
+
+export type colorBulbWebhookContext = deviceWebhookContext & {
+  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
+};
+
+export type plugWebhookContext = deviceWebhookContext & {
+  powerState: 'ON' | 'OFF',
+};
+
+export type plugMiniUSWebhookContext = deviceWebhookContext & {
+  powerState: 'ON' | 'OFF',
+};
+
+export type plugMiniJPWebhookContext = deviceWebhookContext & {
+  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
+};
+
+export type robotVacuumCleanerS1PlusWebhookContext = deviceWebhookContext & {
+  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',
+};
+
+export type ceilingLightWebhookContext = deviceWebhookContext & {
+  powerState: 'ON' | 'OFF',
+  brightness: number,
+  colorTemperature: number, // 2700~6500
+};
+
+export type ceilingLightProWebhookContext = deviceWebhookContext & {
+  powerState: 'ON' | 'OFF',
+  brightness: number,
+  colorTemperature: number, // 2700~6500
+};
+
+export type keypadWebhookContext = deviceWebhookContext & {
+  eventName: 'createKey' | 'deleteKey',
+  commandId: string,
+  result: 'success' | 'failed' | 'timeout',
+};
+
+export type keypadTouchWebhookContext = deviceWebhookContext & {
+  eventName: 'createKey' | 'deleteKey',
+  commandId: string,
+  result: 'success' | 'failed' | 'timeout',
+};
+
+export type hub2WebhookContext = deviceWebhookContext & {
+  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
+};
+
+export type blindTiltWebhookContext = deviceWebhookContext & {
+  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',
+};
+

package/src/types/irdevicelist.ts

@@ -0,0 +1,15 @@
+/* Copyright(C) 2017-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
+ *
+ * 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[];
+};
+
+export type irdevice = {
+  deviceId?: string;
+  deviceName: string;
+  remoteType: string;
+  hubDeviceId: string;
+};

package/src/types/pushbody.ts

@@ -0,0 +1,9 @@
+/* Copyright(C) 2017-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
+ *
+ * pushbody.ts: @switchbot/homebridge-switchbot platform class.
+ */
+export type body = {
+  command: string;
+  parameter: string;
+  commandType: string;
+};

package/src/utils.ts

@@ -85,6 +85,28 @@ export enum SwitchBotBLEModelName {
   Unknown = 'Unknown',
 }
 
+export enum SwitchBotBLEModelFriendlyName {
+  Bot = 'Bot',
+  Hub2 = 'Hub 2',
+  ColorBulb = 'Color Bulb',
+  Curtain = 'Curtain',
+  Curtain3 = 'Curtain 3',
+  Humidifier = 'Humidifier',
+  Meter = 'Meter',
+  Lock = 'Lock',
+  LockPro = 'Lock Pro',
+  PlugMini = 'Plug Mini',
+  StripLight = 'Strip Light',
+  MeterPlus = 'Meter Plus',
+  OutdoorMeter = 'Outdoor Meter',
+  ContactSensor = 'Contact Sensor',
+  MotionSensor = 'Motion Sensor',
+  BlindTilt = 'Blind Tilt',
+  CeilingLight = 'Ceiling Light',
+  CeilingLightPro = 'Ceiling Light Pro',
+  Unknown = 'Unknown',
+}
+
 export enum BlindTiltMappingMode {
   OnlyUp = 'only_up',
   OnlyDown = 'only_down',
@@ -93,6 +115,17 @@ 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';
+}
+
+export function isBlindTiltDevice(device: device & devicesConfig): device is blindTilt & devicesConfig {
+  return device.deviceType === 'Blind Tilt';
+}
+
 export function sleep(ms: number): Promise<void> {
   return new Promise((resolve) => setTimeout(resolve, ms));
 }