@switchbot/homebridge-switchbot 3.5.0-beta.27 → 3.5.0-beta.29

package/src/settings.ts

@@ -48,6 +48,9 @@ export type options = {
 };
 
 export interface devicesConfig extends device {
+  bleMac?: string;
+  model?: string;
+  bleModel?: string;
   configDeviceType: string;
   configDeviceName?: string;
   deviceId: string;
@@ -89,11 +92,13 @@ export interface devicesConfig extends device {
 
 export type meter = {
   hide_temperature?: boolean;
+  convertUnitTo?: string;
   hide_humidity?: boolean;
 };
 
 export type iosensor = {
   hide_temperature?: boolean;
+  convertUnitTo?: string;
   hide_humidity?: boolean;
 };
 
@@ -174,6 +179,7 @@ export type lock = {
 
 export type hub = {
   hide_temperature?: boolean;
+  convertUnitTo?: string;
   hide_humidity?: boolean;
   hide_lightsensor?: boolean;
 };
@@ -271,14 +277,28 @@ export type device = {
   slidePosition?: string;
   //the version of the device
   version?: number;
-  //BLE Mac Address
-  bleMac?: string;
-  //Device Model
-  model?: string;
-  //Device BLE Model
-  bleModel?: string;
+  // Fan Mode:  direct mode: direct; natural mode: "natural"; sleep mode: "sleep"; ultra quiet mode: "baby"
+  mode: string;
+  //the current battery level
+  battery: number;
+  //ON/OFF state
+  power: string;
+  //set nightlight status. turn off: off; mode 1: 1; mode 2: 2
+  nightStatus: number;
+  //set horizontal oscillation. turn on: on; turn off: off
+  oscillation: string;
+  //set vertical oscillation. turn on: on; turn off: off
+  verticalOscillation: string;
+  //battery charge status. charging or uncharged
+  chargingStatus: string;
+  //fan speed. 1~100
+  fanSpeed: number;
 };
 
+// values defined but not displayed by API
+export interface deviceInfo extends device {
+}
+
 //a list of virtual infrared remote devices.
 export type infraredRemoteList = {
   device: Array<irdevice>;
@@ -300,7 +320,7 @@ export type deviceStatus = {
 
 export type deviceStatusBody = {
   //v1.1 of API
-  deviceId: string; //device ID. (Used by the following deviceTypes: Bot, Curtain, Meter, Meter Plus, Lock, Keypad, Keypad Touch, Motion Sensor, Contact Sensor, Ceiling Light, Ceiling Light Pro, Plug Mini (US), Plug Mini (JP), Strip Light, Color Bulb, Robot Vacuum Cleaner S1, Robot Vacuum Cleaner S1 Plus, Humidifier, Blind Tilt)
+  deviceId: string; //device ID. (Used by the following deviceTypes: Bot, Curtain, Meter, Meter Plus, Lock, Keypad, Keypad Touch, Motion Sensor, Contact Sensor, Ceiling Light, Ceiling Light Pro, Plug Mini (US), Plug Mini (JP), Strip Light, Color Bulb, Robot Vacuum Cleaner S1, Robot Vacuum Cleaner S1 Plus, Humidifier, Blind Tilt, Battery Circulator Fan)
   deviceType: string; //device type. (Used by the following deviceTypes: Bot, Curtain, Meter, Meter Plus, Lock, Keypad, Keypad Touch, Motion Sensor, Contact Sensor, Ceiling Light, Ceiling Light Pro, Plug Mini (US), Plug Mini (JP), Strip Light, Color Bulb, Robot Vacuum Cleaner S1, Robot Vacuum Cleaner S1 Plus, Humidifier, Blind Tilt)
   hubDeviceId: string; //device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. (Used by the following deviceTypes: Bot, Curtain, Meter, Meter Plus, Lock, Keypad, Keypad Touch, Motion Sensor, Contact Sensor, Ceiling Light, Ceiling Light Pro, Plug Mini (JP), Strip Light, Color Bulb, Robot Vacuum Cleaner S1, Robot Vacuum Cleaner S1 Plus, Humidifier, Blind Tilt)
   power?: string; //ON/OFF state. (Used by the following deviceTypes: Bot, Ceiling Light, Ceiling Light Pro, PLug, Plug Mini (US), Plug Mini (JP), Strip Light, Color Bulb, Humidifier)
@@ -330,16 +350,21 @@ export type deviceStatusBody = {
   childLock?: boolean; //determines if a Humidifier's safety lock is on or not. (Used by the following deviceTypes: Humidifier)
   sound?: boolean; //determines if a Humidifier is muted or not. (Used by the following deviceTypes: Humidifier)
   lackWater?: boolean; //determines if the water tank is empty or not. (Used by the following deviceTypes: Humidifier)
-  version?: number; //the version of the device. (Used by the following deviceTypes: Blind Tilt, Meter, MeterPlus, IOSensor)
+  version?: number; //the version of the device.
   direction?: string; //the opening direction of a Blind Tilt device. (Used by the following deviceTypes: Blind Tilt)
   runStatus?: string; //'static' when not moving. (Used by the following deviceTypes: Blind Tilt)
-  mode?: number; //available for  devices. the fan mode. (Used by the following deviceTypes: Smart Fan)
+  mode?: number | string; //available for  devices. the fan mode. (Used by the following deviceTypes: Smart Fan, Battery Circulator Fan):(direct mode: direct; natural mode: "natural"; sleep mode: "sleep"; ultra quiet mode: "baby")
   speed?: number; //the fan speed. (Used by the following deviceTypes: Smart Fan)
   shaking?: boolean; //determines if the fan is swinging or not. (Used by the following deviceTypes: Smart Fan)
   shakeCenter?: string; //the fan's swing direction. (Used by the following deviceTypes: Smart Fan)
   shakeRange?: string; //the fan's swing range, 0~120°. (Used by the following deviceTypes: Smart Fan)
   status?: number //the leak status. 0 for no leak, 1 for leak. (Used by the following deviceTypes: Water Detector)
   lightLevel?: number; //the light level. (Used by the following deviceTypes: Hub)
+  nightStatus: number  //	set nightlight status. turn off: off; mode 1: 1; mode 2: 2
+  oscillation: string  //	set horizontal oscillation. turn on: on; turn off: off
+  verticalOscillation: string  //	set vertical oscillation. turn on: on; turn off: off
+  chargingStatus: string  //	battery charge status. charging or uncharged
+  fanSpeed: number  //	fan speed. 1~100
 };
 
 export type ad = {

package/src/utils.ts

@@ -19,8 +19,8 @@ export enum SwitchBotModel {
   ContactSensor = 'W1201500',
   ColorBulb = 'W1401400',
   StripLight = 'W1701100',
-  PlugMiniUS = 'W1901400',
-  PlugMiniJP = 'W2001400',
+  PlugMiniUS = 'W1901400/W1901401',
+  PlugMiniJP = 'W2001400/W2001401',
   Lock = 'W1601700',
   LockPro = 'W3500000',
   Keypad = 'W2500010',
@@ -30,16 +30,17 @@ export enum SwitchBotModel {
   WoSweeperMini = 'WoSweeperMini',
   RobotVacuumCleanerS1 = 'W3011000', // Currently only available in Japan.
   RobotVacuumCleanerS1Plus = 'W3011010', // Currently only available in Japan.
+  RobotVacuumCleanerS10 = 'W3211800',
   Remote = 'Remote',
   UniversalRemote = 'UniversalRemote',
-  CeilingLight = 'W2612230', // Currently only available in Japan.
-  CeilingLightPro = 'W2612210', // Currently only available in Japan.
+  CeilingLight = 'W2612230/W2612240', // Currently only available in Japan.
+  CeilingLightPro = 'W2612210/W2612220', // Currently only available in Japan.
   IndoorCam = 'W1301200',
   PanTiltCam = 'W1801200',
   PanTiltCam2K = 'W3101100',
   BlindTilt = 'W2701600',
   BatteryCirculatorFan = 'W3800510',
-  WaterDetector = 'WoWaterDetector',
+  WaterDetector = 'W4402000',
   Unknown = 'Unknown',
 }
 
@@ -77,11 +78,25 @@ export function sleep(ms: number): Promise<void> {
   return new Promise((resolve) => setTimeout(resolve, ms));
 }
 
+/**
+ * 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);
+  } 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 value;
+}
+
+
 export function rgb2hs(r: any, g: any, b: any) {
-  /*
-    Credit:
-    https://github.com/WickyNilliams/pure-color
-  */
+/**
+ * Credit:
+ * https://github.com/WickyNilliams/pure-color
+**/
   r = parseInt(r);
   g = parseInt(g);
   b = parseInt(b);