@switchbot/homebridge-switchbot 3.5.1-beta.2 → 3.5.1-beta.3

package/src/types/bledevicestatus.ts

@@ -0,0 +1,305 @@
+/* Copyright(C) 2017-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
+ *
+ * bledevicestatus.ts: @switchbot/homebridge-switchbot platform class.
+ */
+import type { MacAddress } from 'homebridge';
+import type { SwitchBotBLEModel, SwitchBotBLEModelName, SwitchBotBLEModelFriendlyName } from 'node-switchbot';
+
+export type switchbot = {
+  discover: (arg0: { duration?: any; model: string; quick: boolean; id?: MacAddress }) => Promise<any>;
+  wait: (arg0: number) => any;
+};
+
+export type ad = {
+  id: string;
+  address: string;
+  rssi: number;
+  serviceData: botServiceData | colorBulbServiceData | contactSensorServiceData |
+    curtainServiceData | curtain3ServiceData | stripLightServiceData | lockServiceData |
+    lockProServiceData | meterServiceData | meterPlusServiceData | motionSensorServiceData |
+    plugMiniUSServiceData | plugMiniJPServiceData | blindTiltServiceData;
+};
+
+type serviceData = {
+  model: string,
+  modelName: string,
+};
+
+export type botServiceData = serviceData & {
+  model: SwitchBotBLEModel.Bot,
+  modelName: SwitchBotBLEModelName.Bot,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.Bot,
+  mode: string;
+  state: boolean;
+  battery: number;
+};
+
+export type colorBulbServiceData = serviceData & {
+  model: SwitchBotBLEModel.ColorBulb,
+  modelName: SwitchBotBLEModelName.ColorBulb,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.ColorBulb,
+  color_temperature: number;
+  power: boolean;
+  state: boolean;
+  red: number;
+  green: number;
+  blue: number;
+  brightness: number;
+  delay: number;
+  preset: number;
+  color_mode: number;
+  speed: number;
+  loop_index: number;
+};
+
+export type contactSensorServiceData = serviceData & {
+  model: SwitchBotBLEModel.ContactSensor,
+  modelName: SwitchBotBLEModelName.ContactSensor,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.ContactSensor,
+  movement: boolean;
+  tested: boolean;
+  battery: number;
+  contact_open: boolean;
+  contact_timeout: boolean;
+  lightLevel: string;
+  button_count: number;
+  doorState: string;
+};
+
+export type curtainServiceData = serviceData & {
+  model: SwitchBotBLEModel.Curtain,
+  modelName: SwitchBotBLEModelName.Curtain,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.Curtain,
+  calibration: boolean;
+  battery: number;
+  inMotion: boolean;
+  position: number;
+  lightLevel: number;
+  deviceChain: number;
+};
+
+export type curtain3ServiceData = serviceData & {
+  model: SwitchBotBLEModel.Curtain3,
+  modelName: SwitchBotBLEModelName.Curtain3,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.Curtain3,
+  calibration: boolean;
+  battery: number;
+  inMotion: boolean;
+  position: number;
+  lightLevel: number;
+  deviceChain: number;
+};
+
+export type stripLightServiceData = serviceData & {
+  model: SwitchBotBLEModel.StripLight,
+  modelName: SwitchBotBLEModelName.StripLight,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.StripLight,
+  power: boolean;
+  state: boolean;
+  red: number;
+  green: number;
+  blue: number;
+  brightness: number;
+  delay: number;
+  preset: number;
+  color_mode: number;
+  speed: number;
+  loop_index: number;
+};
+
+export type lockServiceData = serviceData & {
+  model: SwitchBotBLEModel.Lock,
+  modelName: SwitchBotBLEModelName.Lock,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.Lock,
+  battery: number;
+  calibration: boolean;
+  status: string;
+  update_from_secondary_lock: boolean;
+  door_open: string;
+  double_lock_mode: boolean;
+  unclosed_alarm: boolean;
+  unlocked_alarm: boolean;
+  auto_lock_paused: boolean;
+  night_latch: boolean;
+};
+
+export type lockProServiceData = serviceData & {
+  model: SwitchBotBLEModel.LockPro,
+  modelName: SwitchBotBLEModelName.LockPro,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.LockPro,
+  battery: number;
+  calibration: boolean;
+  status: string;
+  update_from_secondary_lock: boolean;
+  door_open: string;
+  double_lock_mode: boolean;
+  unclosed_alarm: boolean;
+  unlocked_alarm: boolean;
+  auto_lock_paused: boolean;
+  night_latch: boolean;
+};
+
+export type meterServiceData = serviceData & {
+  model: SwitchBotBLEModel.Meter,
+  modelName: SwitchBotBLEModelName.Meter,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.Meter,
+  temperature: temperature;
+  fahrenheit: boolean;
+  humidity: number;
+  battery: number;
+};
+
+export type meterPlusServiceData = serviceData & {
+  model: SwitchBotBLEModel.MeterPlus,
+  modelName: SwitchBotBLEModelName.MeterPlus,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.MeterPlus,
+  temperature: temperature;
+  fahrenheit: boolean;
+  humidity: number;
+  battery: number;
+};
+
+export type outdoorMeterServiceData = serviceData & {
+  model: SwitchBotBLEModel.OutdoorMeter,
+  modelName: SwitchBotBLEModelName.OutdoorMeter,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.OutdoorMeter,
+  temperature: temperature;
+  fahrenheit: boolean;
+  humidity: number;
+  battery: number;
+};
+
+export type motionSensorServiceData = serviceData & {
+  model: SwitchBotBLEModel.MotionSensor,
+  modelName: SwitchBotBLEModelName.MotionSensor,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.MotionSensor,
+  tested: boolean;
+  movement: boolean;
+  battery: number;
+  led: number;
+  iot: number;
+  sense_distance: number;
+  lightLevel: string;
+  is_light: boolean;
+};
+
+export type plugMiniUSServiceData = serviceData & {
+  model: SwitchBotBLEModel.PlugMiniUS,
+  modelName: SwitchBotBLEModelName.PlugMini,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.PlugMini,
+  state: string;
+  delay: boolean;
+  timer: boolean;
+  syncUtcTime: boolean;
+  wifiRssi: number;
+  overload: boolean;
+  currentPower: number;
+};
+
+export type plugMiniJPServiceData = serviceData & {
+  model: SwitchBotBLEModel.PlugMiniUS,
+  modelName: SwitchBotBLEModelName.PlugMini,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.PlugMini,
+  state: string;
+  delay: boolean;
+  timer: boolean;
+  syncUtcTime: boolean;
+  wifiRssi: number;
+  overload: boolean;
+  currentPower: number;
+};
+
+export type blindTiltServiceData = serviceData & {
+  model: SwitchBotBLEModel.BlindTilt,
+  modelName: SwitchBotBLEModelName.BlindTilt,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.BlindTilt,
+  calibration: boolean;
+  battery: number;
+  inMotion: boolean;
+  tilt: number;
+  lightLevel: number;
+};
+
+export type ceilingLightServiceData = serviceData & {
+  model: SwitchBotBLEModel.CeilingLight,
+  modelName: SwitchBotBLEModelName.CeilingLight,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.CeilingLight,
+  color_temperature: number;
+  power: boolean;
+  state: boolean;
+  red: number;
+  green: number;
+  blue: number;
+  brightness: number;
+  delay: number;
+  preset: number;
+  color_mode: number;
+  speed: number;
+  loop_index: number;
+};
+
+export type ceilingLightProServiceData = serviceData & {
+  model: SwitchBotBLEModel.CeilingLightPro,
+  modelName: SwitchBotBLEModelName.CeilingLightPro,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.CeilingLightPro,
+  color_temperature: number;
+  power: boolean;
+  state: boolean;
+  red: number;
+  green: number;
+  blue: number;
+  brightness: number;
+  delay: number;
+  preset: number;
+  color_mode: number;
+  speed: number;
+  loop_index: number;
+};
+
+export type hub2ServiceData = serviceData & {
+  model: SwitchBotBLEModel.Hub2,
+  modelName: SwitchBotBLEModelName.Hub2,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.Hub2,
+  temperature: temperature;
+  fahrenheit: boolean;
+  humidity: number;
+  lightLevel: number;
+};
+
+export type batteryCirculatorFanServiceData = serviceData & {
+  model: SwitchBotBLEModel.Unknown,
+  modelName: SwitchBotBLEModelName.Unknown,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.Unknown,
+  state: string;
+};
+
+export type waterLeakDetectorServiceData = serviceData & {
+  model: SwitchBotBLEModel.Unknown,
+  modelName: SwitchBotBLEModelName.Unknown,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.Unknown,
+  state: boolean;
+  status: number;
+  battery: number;
+};
+
+export type humidifierServiceData = serviceData & {
+  model: SwitchBotBLEModel.Humidifier,
+  modelName: SwitchBotBLEModelName.Humidifier,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.Humidifier,
+  onState: boolean;
+  autoMode: boolean;
+  percentage: number;
+};
+
+export type robotVacuumCleanerServiceData = serviceData & {
+  model: SwitchBotBLEModel.Unknown,
+  modelName: SwitchBotBLEModelName.Unknown,
+  modelFriendlyName: SwitchBotBLEModelFriendlyName.Unknown,
+  state: string;
+  battery: number;
+};
+
+export type temperature = {
+  c: number;
+  f: number;
+};

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;
+};