@@ -1518,7 +1518,7 @@ The `deviceList` array contains a list of objects with the following key-value a
15181518| ------------------ | ---------- | ------------------------------------------------------------ |
15191519| deviceId | String | device ID |
15201520| deviceName | String | device name |
1521- | deviceType | String | device type. * LED Strip Light 3* |
1521+ | deviceType | String | device type. * Strip Light 3* |
15221522| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
15231523| hubDeviceId | String | device's parent Hub ID. * 000000000000* when the device itself is a Hub or it is connected through Wi-Fi. | |
15241524
@@ -2176,10 +2176,10 @@ The `body` object contains the following properties,
21762176| hubDeviceId | String | Hub ID, equivalent to device ID |
21772177| version | String | the current firmware version, e.g. V4.2 |
21782178| temperature | Float | temperature in celsius |
2179- | lightLevel | Integer | the level of illuminance of the ambience light, 1~ 10 |
2179+ | lightLevel | Integer | the level of illuminance of the ambience light, 1~ 10 |
21802180| humidity | Integer | humidity percentage |
2181- | moveDetected | Boolean | determines if motion is detected |
2182- | online | String | the connection status of the device. * online* or * offline* |
2181+ | moveDetected | Boolean | determines if motion is detected |
2182+ | onlineStatus | String | the connection status of the device. * online* or * offline* |
21832183
21842184##### Battery Circulator Fan
21852185| Key | Value Type | Description |
@@ -2218,11 +2218,12 @@ The `body` object contains the following properties,
22182218| deviceId | String | device ID |
22192219| deviceType | String | device type. * Relay Switch 1PM* |
22202220| switchStatus | Integer | the current switch state. ` 0 ` , off; ` 1 ` , on |
2221- | voltage | Integer | the current voltage, measured in Volt |
2221+ | voltage | Float | the current voltage, measured in Volt |
22222222| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
2223- | power | Integer | the current power, measured in Watts |
2223+ | power | Float | the current power, measured in Watts |
22242224| usedElectricity | Integer | daily power consumption, measured in watt-minutes |
22252225| electricCurrent | Integer | the electrical current measured in mA |
2226+ | hubDeviceId | String | Hub ID, equivalent to device ID |
22262227
22272228##### Relay Switch 1
22282229
@@ -2232,6 +2233,7 @@ The `body` object contains the following properties,
22322233| deviceType | String | device type. * Relay Switch 1* |
22332234| switchStatus | Integer | the current switch state. ` 0 ` , off; ` 1 ` , on |
22342235| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
2236+ | hubDeviceId | String | Hub ID, equivalent to device ID |
22352237
22362238##### Relay Switch 2PM
22372239
@@ -2242,18 +2244,19 @@ The `body` object contains the following properties,
22422244| online | Boolean | the connection status of the device. * true* or * false* |
22432245| switch1Status | Integer | the current switch1 state. ` 0 ` , off; ` 1 ` , on |
22442246| switch2Status | Integer | the current switch2 state. ` 0 ` , off; ` 1 ` , on |
2245- | switch1voltage | Integer | the switch1 current voltage, measured in Volt |
2246- | switch2voltage | Integer | the switch2 current voltage, measured in Volt |
2247+ | switch1Voltage | Float | the switch1 current voltage, measured in Volt |
2248+ | switch2Voltage | Float | the switch2 current voltage, measured in Volt |
22472249| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
2248- | switch1power | Integer | the switch1 current power, measured in Watts |
2249- | switch2power | Integer | the switch2 current power, measured in Watts |
2250- | switch1usedElectricity | Integer | switch1 daily power consumption, measured in watt-minutes |
2251- | switch2usedElectricity | Integer | switch2 daily power consumption, measured in watt-minutes |
2252- | switch1electricCurrent | Integer | the switch1 electrical current measured in mA |
2253- | switch2electricCurrent | Integer | the switch2 electrical current measured in mA |
2250+ | switch1Power | Float | the switch1 current power, measured in Watts |
2251+ | switch2Power | Float | the switch2 current power, measured in Watts |
2252+ | switch1UsedElectricity | Integer | switch1 daily power consumption, measured in watt-minutes |
2253+ | switch2UsedElectricity | Integer | switch2 daily power consumption, measured in watt-minutes |
2254+ | switch1ElectricCurrent | Integer | the switch1 electrical current measured in mA |
2255+ | switch2ElectricCurrent | Integer | the switch2 electrical current measured in mA |
22542256| calibrate | Boolean | determines if the open and the closed positions have been properly calibrated or not |
22552257| position | Integer | the current position, 0-100 |
22562258| isStuck | String | determine if the roller blind is stuck |
2259+ | hubDeviceId | String | Hub ID, equivalent to device ID |
22572260
22582261
22592262##### Garage Door Opener
@@ -2285,8 +2288,7 @@ The `body` object contains the following properties,
22852288| Key | Value Type | Description |
22862289| --------------- | ---------- | --------------------------------------------------------- |
22872290| deviceId | String | device ID |
2288- | online | Boolean | the connection status of the device. * true* or * false* |
2289- | deviceType | String | device type. * LED Strip Light 3* |
2291+ | deviceType | String | device type. * Strip Light 3* |
22902292| hubDeviceId | String | device's parent Hub ID |
22912293| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
22922294| power | String | ON/OFF state |
@@ -2306,6 +2308,18 @@ The `body` object contains the following properties,
23062308| lockState | String | determines if locked or not, * jammed* , * unlock* or * lock* |
23072309| calibrate | Boolean | determines if the open and the closed positions have been properly calibrated or not |
23082310
2311+ ##### Lock Ultra
2312+ | Key | Value Type | Description |
2313+ | ------------------ | --------------- | ------------------------------------------------------------ |
2314+ | deviceId | String | device ID |
2315+ | deviceType | String | device type. * Lock Ultra* |
2316+ | hubDeviceId | String | device's parent Hub ID |
2317+ | battery | Integer | the current battery level, 0-100 |
2318+ | version | String | the current firmware version, e.g. V4.2 |
2319+ | lockState | String | determines if locked or not, * jammed* , * unlock* or * lock* |
2320+ | doorState | String | determines if the door is closed or not, * open* or * close* |
2321+ | calibrate | Boolean | determines if Lock has been calibrated or not |
2322+
23092323##### Video Doorbell
23102324
23112325| Key | Value Type | Description |
@@ -2540,9 +2554,9 @@ Send control commands to physical devices and virtual infrared remote devices.
25402554| deviceType | commandType | Command | command parameter | Description |
25412555| ---------------------------- | ----------- | ------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
25422556| Relay Switch 2PM | command | turnOn | “1”or"2" | set to ON state 1 represents channel 1 2 represents channel 2 |
2543- | Relay Switch 2PM | command | turnOff | default | set to OFF state |
2557+ | Relay Switch 2PM | command | turnOff | “1”or"2" | set to OFF state 1 represents channel 1 2 represents channel 2 |
25442558| Relay Switch 2PM | command | toggle | “1”or"2" | toggle 1 represents channel 1 2 represents channel 2state |
2545- | Relay Switch 2PM | command | setMode | “1”/“2”, ` 0~3 ` | The first item represents the switching of channel number, 1 represents channel number 1 and 2 represents channel number 2. The second item represents set the switch mode. ` 0 ` , toggle mode; ` 1 ` , edge switch mode; ` 2 ` , detached switch mode; ` 3 ` , momentary switch mode |
2559+ | Relay Switch 2PM | command | setMode | channel;mode< br >e.g ` 1;0 ` | The first item represents the switching of channel number, 1 represents channel number 1 and 2 represents channel number 2. The second item represents set the switch mode. ` 0 ` , toggle mode; ` 1 ` , edge switch mode; ` 2 ` , detached switch mode; ` 3 ` , momentary switch mode |
25462560| Relay Switch 2PM | command | setPosition | ` 0~100 ` | Set roller blind opening and closing percentage. ` 0 ` , Open All; ` 100 ` , Close All |
25472561
25482562##### Garage Door Opener
@@ -2685,7 +2699,7 @@ The following table describes the parameter object for `deleteKey`,
26852699| Robot Vacuum Cleaner K10+ Pro Combo | command | pause | default | pause cleaning |
26862700| Robot Vacuum Cleaner K10+ Pro Combo | command | dock | default | return to charging dock |
26872701| Robot Vacuum Cleaner K10+ Pro Combo | command | setVolume | ` {0-100} ` | set the robot volume |
2688- | Robot Vacuum Cleaner K10+ Pro Combo | command | changeParam | {"fanLevel": fan_level_int, "waterLevel": water_level_int, " times": clean_cycle_int} | change clean parameters. ` fan_level_int ` , the vacuum level, ` 1-4 ` ; ` water_level_int ` , the mop moisture level, ` 1-2 ` ; ` times ` , the number of cycles, ` 1-2639999 ` , in theory. |
2702+ | Robot Vacuum Cleaner K10+ Pro Combo | command | changeParam | {"fanLevel": fan_level_int, "times": clean_cycle_int} | change clean parameters. ` fan_level_int ` , the vacuum level, ` 1-4 ` ; ` times ` , the number of cycles, ` 1-2639999 ` , in theory. |
26892703
26902704
26912705##### Floor Cleaning Robot S10
@@ -4626,8 +4640,7 @@ When an event gets triggered, SwitchBot server will send a `POST` request to the
46264640| deviceType | String | the type of the device |
46274641| deviceMac | String | the MAC address of the device |
46284642| power | String | the power state of the device |
4629- | mode | Integer | the current mode. ` 1 ` , level 4; ` 2 ` , level 3; ` 3 ` , level 2; ` 4 ` , level 1; ` 5 ` , humidity mode; ` 6 ` , sleep mode; ` 7 ` , auto mode; ` 8 ` , drying mode |
4630- | drying | Boolean | determines if the device is drying its filter or not |
4643+ | mode | Integer | the current mode. ` 1 ` , normal or fan mode; ` 2 ` , auto mode; ` 3 ` , sleep mode; ` 4 ` , pet mode |
46314644| childLock | Integer | child lock. ` 0 ` , disabled; ` 1 ` , enabled |
46324645| timeOfSample | Long | the time stamp when the event is sent |
46334646
@@ -4656,8 +4669,7 @@ When an event gets triggered, SwitchBot server will send a `POST` request to the
46564669| deviceType | String | the type of the device |
46574670| deviceMac | String | the MAC address of the device |
46584671| power | String | the power state of the device |
4659- | mode | Integer | the current mode. ` 1 ` , level 4; ` 2 ` , level 3; ` 3 ` , level 2; ` 4 ` , level 1; ` 5 ` , humidity mode; ` 6 ` , sleep mode; ` 7 ` , auto mode; ` 8 ` , drying mode |
4660- | drying | Boolean | determines if the device is drying its filter or not |
4672+ | mode | Integer | the current mode. ` 1 ` , normal or fan mode; ` 2 ` , auto mode; ` 3 ` , sleep mode; ` 4 ` , pet mode |
46614673| childLock | Integer | child lock. ` 0 ` , disabled; ` 1 ` , enabled |
46624674| timeOfSample | Long | the time stamp when the event is sent |
46634675
@@ -4686,8 +4698,7 @@ When an event gets triggered, SwitchBot server will send a `POST` request to the
46864698| deviceType | String | the type of the device |
46874699| deviceMac | String | the MAC address of the device |
46884700| power | String | the power state of the device |
4689- | mode | Integer | the current mode. ` 1 ` , level 4; ` 2 ` , level 3; ` 3 ` , level 2; ` 4 ` , level 1; ` 5 ` , humidity mode; ` 6 ` , sleep mode; ` 7 ` , auto mode; ` 8 ` , drying mode |
4690- | drying | Boolean | determines if the device is drying its filter or not |
4701+ | mode | Integer | the current mode. ` 1 ` , normal or fan mode; ` 2 ` , auto mode; ` 3 ` , sleep mode; ` 4 ` , pet mode |
46914702| childLock | Integer | child lock. ` 0 ` , disabled; ` 1 ` , enabled |
46924703| timeOfSample | Long | the time stamp when the event is sent |
46934704
@@ -4716,8 +4727,7 @@ When an event gets triggered, SwitchBot server will send a `POST` request to the
47164727| deviceType | String | the type of the device |
47174728| deviceMac | String | the MAC address of the device |
47184729| power | String | the power state of the device |
4719- | mode | Integer | the current mode. ` 1 ` , level 4; ` 2 ` , level 3; ` 3 ` , level 2; ` 4 ` , level 1; ` 5 ` , humidity mode; ` 6 ` , sleep mode; ` 7 ` , auto mode; ` 8 ` , drying mode |
4720- | drying | Boolean | determines if the device is drying its filter or not |
4730+ | mode | Integer | the current mode. ` 1 ` , normal or fan mode; ` 2 ` , auto mode; ` 3 ` , sleep mode; ` 4 ` , pet mode |
47214731| childLock | Integer | child lock. ` 0 ` , disabled; ` 1 ` , enabled |
47224732| timeOfSample | Long | the time stamp when the event is sent |
47234733
@@ -4992,7 +5002,7 @@ When an event gets triggered, SwitchBot server will send a `POST` request to the
49925002 " eventType" : " changeReport" ,
49935003 " eventVersion" : " 1" ,
49945004 " context" : {
4995- " deviceType" : " WoKeypadTouch " ,
5005+ " deviceType" : " WoKeypadVision " ,
49965006 " deviceMac" : DEVICE_MAC_ADDR ,
49975007 " eventName" : " createKey" ,
49985008 " commandId" : " CMD-1663558451952-01" ,
@@ -5008,7 +5018,7 @@ When an event gets triggered, SwitchBot server will send a `POST` request to the
50085018 " eventType" : " changeReport" ,
50095019 " eventVersion" : " 1" ,
50105020 " context" : {
5011- " deviceType" : " WoKeypadTouch " ,
5021+ " deviceType" : " WoKeypadVision " ,
50125022 " deviceMac" : DEVICE_MAC_ADDR ,
50135023 " eventName" : " deleteKey " ,
50145024 " commandId" : " CMD-1663558451952-01" ,
@@ -5096,14 +5106,13 @@ When an event gets triggered, SwitchBot server will send a `POST` request to the
50965106 " eventType" : " changeReport" ,
50975107 " eventVersion" : " 1" ,
50985108 " context" : {
5099- " deviceType" : " Robot Vacuum Cleaner K10 + Pro Combo " ,
5109+ " deviceType" : " Robot Vacuum Cleaner K20 + Pro" ,
51005110 " deviceMac" : DEVICE_MAC_ADDR ,
51015111 " workingStatus" :" StandBy" ,
51025112 // StandBy,Clearing,Paused,GotoChargeBase,Charging,ChargeDone,Dormant,InTrouble,InRemoteControl,InDustCollecting
51035113 " onlineStatus" : " online" ,// online,offline
51045114 " battery" : 100 ,// 0-100
5105- " waterBaseBattery" : 100 ,
5106- " taskType" : " explore" , // standBy,explore,cleanAll,cleanArea,cleanRoom,deepWashing,backToCharge,drying,collectDust,remoteControl,cleanWithExplorer
5115+ " taskType" : " explore" , // standBy,explore,cleanAll,cleanArea,cleanRoom,deepWashing,backToCharge,drying,collectDust,remoteControl,cleanWithExplorer
51075116 " timeOfSample" : 123456789
51085117 }
51095118}
0 commit comments