This document describes a collection of SwitchBot API methods, examples, and best practices for, but not limited to, IoT hobbyists, developers, and gurus to make their own smart home programs or applications.
Note: This API is limited to personal uses.
It is prohibited for commercial uses or for large-scale applications. There is a daily call limit to all users to ensure resources are evenly distributed to each API user.
For commercial uses, please do consult SwitchBot via this form.
日本でご利用の皆さまへ:
弊社はAPIインターフェイスを通じて、より柔軟でパーソナルな利用体験を提供できることを願っております。
すべてのユーザーの皆様の公平な利用とサービス品質を保証するため、APIの利用範囲についてご説明いたします。
①個人ユーザーの利用
弊社は、個人のプロジェクト、学習研究、および日常生活におけるクリエイティブなシーンでのAPI利用を歓迎し、奨励いたします。
これらの目的で利用する場合は追加の申請なしにAPIを自由に呼び出すことができます。
➁商用利用
SwitchBot APIを商業製品やサービスに統合する予定がある場合、または大規模な呼び出し（例：数千回以上のリクエスト）を行う場合は、まず弊社にご連絡ください、別途EnterpriseAPIをご用意しております。
• 貴社の製品/サービスの動作がより安定します。
• 専門的な技術サポートと割り当ての保証を提供できます。
• 貴社の利用が弊社のサービス利用規約およびブランドガイドラインに準拠していることを確認できます。
お問い合わせ方法
商用利用に関するご要望やご質問がございましたら、いつでもお気軽にお問い合わせください。 📧 メール：biz@switchbot.jp
We will stop adding support for new products on v1.0 as we release v1.1.
Hence, we strongly recommend all SwitchBot users to migrate to the new API version because we have improved the authentication method. This will make the communication between your server and the SwitchBot server more secure.
Please follow these steps,
-
Download the SwitchBot app on App Store or Google Play Store
-
Register a SwitchBot account and log in into your account
-
Generate an Open Token within the app
For app version ≥ V9.0,
a) Go to Profile > Preferences > About
b) Tap App Version 10 times. Developer Options will show up
c) Tap Developer Options
d) Tap Get Token
For app version < V9.0,
a) Go to Profile > Preferences
b) Tap App Version 10 times. Developer Options will show up
c) Tap Developer Options
d) Tap Get Token
- Roll up your sleeves and get your hands dirty with SwitchBot OpenAPI!
Note: You must update the app to the latest version, V6.14 or later, in order to get the secret key.
In SwitchBot API v1.1, the authentication method has been improved. In order to gain access to private data through the API, you must generate a unique signature using a token and a secret key. When you make a request, the Authorization token and signature will be validated simultaneously.
You as a developer will then be able to add, delete, edit, and look up your data including profile data and data associated with the devices that have been added to your SwitchBot account.
To continue to use SwitchBot API v1.0, refer to the legacy document.
We have attached some scripts for you to quickly generate a sign. If you prefer to write your own script or routine, here is the procedure.
- Print the 13 digit timestamp and concatenate it with your
token
- Create a signature using your
secret and the string produced in the previous step
- Convert the signature to upper case
For instance,
# secret key
secret = "" # copy and paste from the SwitchBot app V6.14 or later
# open token
token = "" # copy and paste from the SwitchBot app V6.14 or later
t = 1661927531000
sign = HMAC-SHA256(token + t, secret).toUpperCase()
import time
import hashlib
import hmac
import base64
# open token
token = '' # copy and paste from the SwitchBot app V6.14 or later
# secret key
secret = '' # copy and paste from the SwitchBot app V6.14 or later
nonce = ''
t = int(round(time.time() * 1000))
string_to_sign = '{}{}{}'.format(token, t, nonce)
sign = base64.b64encode(hmac.new(secret, msg=string_to_sign, digestmod=hashlib.sha256).digest())
print ('Authorization: {}'.format(token))
print ('t: {}'.format(t))
print ('sign: {}'.format(sign))
print ('nonce: {}'.format(nonce))
import json
import time
import hashlib
import hmac
import base64
import uuid
# Declare empty header dictionary
apiHeader = {}
# open token
token = '' # copy and paste from the SwitchBot app V6.14 or later
# secret key
secret = '' # copy and paste from the SwitchBot app V6.14 or later
nonce = uuid.uuid4()
t = int(round(time.time() * 1000))
string_to_sign = '{}{}{}'.format(token, t, nonce)
string_to_sign = bytes(string_to_sign, 'utf-8')
secret = bytes(secret, 'utf-8')
sign = base64.b64encode(hmac.new(secret, msg=string_to_sign, digestmod=hashlib.sha256).digest())
print ('Authorization: {}'.format(token))
print ('t: {}'.format(t))
print ('sign: {}'.format(str(sign, 'utf-8')))
print ('nonce: {}'.format(nonce))
#Build api header JSON
apiHeader['Authorization']=token
apiHeader['Content-Type']='application/json'
apiHeader['charset']='utf8'
apiHeader['t']=str(t)
apiHeader['sign']=str(sign, 'utf-8')
apiHeader['nonce']=str(nonce)
const crypto = require('crypto');
const https = require('https');
const token = "yourToken";
const secret = "yourSecret";
const t = Date.now();
const nonce = "requestID";
const data = token + t + nonce;
const sign = crypto
.createHmac('sha256', secret)
.update(data)
.digest('base64');
console.log(sign);
const body = JSON.stringify({
"command": "turnOn",
"parameter": "default",
"commandType": "command"
});
const deviceId = "MAC";
const options = {
hostname: 'api.switch-bot.com',
port: 443,
path: `/v1.1/devices/${deviceId}/commands`,
method: 'POST',
headers: {
"Authorization": token,
"sign": sign,
"nonce": nonce,
"t": t,
'Content-Type': 'application/json',
'Content-Length': body.length,
},
};
const req = https.request(options, res => {
console.log(`statusCode: ${res.statusCode}`);
res.on('data', d => {
process.stdout.write(d);
});
});
req.on('error', error => {
console.error(error);
});
req.write(body);
req.end();
using System;
using System.Diagnostics;
using System.Text;
using System.Security.Cryptography;
using System.Net.Http;
string token = "My Token";
string secret = "My Secret Key";
DateTime dt1970 = new DateTime(1970, 1, 1);
DateTime current = DateTime.Now;
TimeSpan span = current - dt1970;
long time = Convert.ToInt64(span.TotalMilliseconds);
string nonce = Guid.NewGuid().ToString();
string data = token + time.ToString() + nonce;
Encoding utf8 = Encoding.UTF8;
HMACSHA256 hmac = new HMACSHA256(utf8.GetBytes(secret));
string signature = Convert.ToBase64String(hmac.ComputeHash(utf8.GetBytes(data)));
//Create http client
HttpClient client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, @"https://api.switch-bot.com/v1.1/devices");
request.Headers.TryAddWithoutValidation(@"Authorization", token);
request.Headers.TryAddWithoutValidation(@"sign", signature);
request.Headers.TryAddWithoutValidation(@"nonce", nonce);
request.Headers.TryAddWithoutValidation(@"t", time.ToString());
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Instant;
import java.util.Base64;
import java.util.UUID;
import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;
public class Main {
public static void main(String[] args) throws Exception {
String token = args[0];
String secret = args[1];
String nonce = UUID.randomUUID().toString();
String time= "" + Instant.now().toEpochMilli();
String data = token + time + nonce;
SecretKeySpec secretKeySpec = new SecretKeySpec(secret.getBytes("UTF-8"), "HmacSHA256");
Mac mac = Mac.getInstance("HmacSHA256");
mac.init(secretKeySpec);
String signature = new String(Base64.getEncoder().encode(mac.doFinal(data.getBytes("UTF-8"))));
HttpRequest getDevices = HttpRequest.newBuilder()
.uri(new URI("https://api.switch-bot.com/v1.1/devices"))
.header("Authorization", token)
.header("sign", signature)
.header("nonce", nonce)
.header("t", time)
.GET()
.build();
HttpResponse<String> response = HttpClient.newBuilder().build().send(getDevices, BodyHandlers.ofString());
System.out.println(response.body());
}
}
<?php
$token = 'XXXXXXXXXXXXXXXXXXX';
$secret = 'YYYYYYYYYYY';
$nonce = guidv4();
$t = time() * 1000;
$data = utf8_encode($token . $t . $nonce);
$sign = hash_hmac('sha256', $data, $secret,true);
$sign = strtoupper(base64_encode($sign));
$url = "https://api.switch-bot.com/v1.1/devices";
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$headers = array(
"Content-Type:application/json",
"Authorization:" . $token,
"sign:" . $sign,
"nonce:" . $nonce,
"t:" . $t
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($curl);
curl_close($curl);
function guidv4($data = null) {
// Generate 16 bytes (128 bits) of random data or use the data passed into the function.
$data = $data ?? random_bytes(16);
assert(strlen($data) == 16);
$data[6] = chr(ord($data[6]) & 0x0f | 0x40);
$data[8] = chr(ord($data[8]) & 0x3f | 0x80);
// Output the 36 character UUID.
return vsprintf('%s%s-%s-%s-%s-%s%s%s', str_split(bin2hex($data), 4));
}
import CryptoKit
let token = 'TTTTTTT'
let secret = 'SSSS'
func getDevices() async throws -> Any {
let hostname = "https://api.switch-bot.com"
var components = URLComponents(string: hostname)!
components.path = "/v1.1/devices"
components.port = 443
var request = URLRequest(url: components.url!)
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.setValue("utf-8", forHTTPHeaderField: "charset")
let timestamp = Int(Date().timeIntervalSince1970.rounded() * 1000) // Date().timeInterval returns seconds, not milliseconds, since1970
let nonce = UUID().uuidString
let timeAdjustedToken = token + "\(timestamp)" + nonce
let key = SymmetricKey(data: Data(secret.utf8))
let authenticationCode = HMAC<SHA256>.authenticationCode(for: Data(timeAdjustedToken.utf8), using: key)
let signatureToken = Data(authenticationCode).base64EncodedString()
request.setValue(token, forHTTPHeaderField: "Authorization")
request.setValue(signatureToken, forHTTPHeaderField: "sign")
request.setValue(nonce, forHTTPHeaderField: "nonce")
request.setValue("\(timestamp)", forHTTPHeaderField: "t")
let (data, response) = try await URLSession.shared.data(for: request)
return try JSONSerialization.jsonObject(with: data)
}
package main
import (
"crypto/hmac"
"crypto/sha256"
"encoding/base64"
"fmt"
"io"
"log"
"net/http"
"strings"
"time"
)
func main() {
token := "XXXXXXXXXXXXXXXXXXX" // copy and paste from the SwitchBot app V6.14 or later
secret := "YYYYYYYYYYY" // copy and paste from the SwitchBot app V6.14 or later
nonce := UUID() // generate random UUID v4
timestamp := time.Now().UnixMilli() // 13-digit milliseconds Unix timestamp
data := fmt.Sprintf("%s%d%s", token, timestamp, nonce)
mac := hmac.New(sha256.New, []byte(secret))
if _, err := mac.Write([]byte(data)); err != nil {
log.Fatalf("Error generating signature: %v", err)
}
signature := mac.Sum(nil)
signatureB64 := strings.ToUpper(base64.StdEncoding.EncodeToString(signature))
url := "https://api.switch-bot.com/v1.1/devices"
req, err := http.NewRequest("GET", url, nil)
if err != nil {
log.Fatalf("Error creating request: %v", err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", token)
req.Header.Set("sign", signatureB64)
req.Header.Set("nonce", nonce)
req.Header.Set("t", fmt.Sprintf("%d", timestamp))
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
log.Fatalf("Error sending request: %v", err)
}
defer resp.Body.Close()
body, err := io.ReadAll(resp.Body)
if err != nil {
log.Fatalf("Error reading response: %v", err)
}
fmt.Println(string(body)) // Response in JSON format
}
// UUID returns an RFC 4122/9562–compliant random UUIDv4 string.
func UUID() string {
var uuid [16]byte // 128-bit long array
rand.Read(uuid[:]) // Use cryptographically secure random source
uuid[6] = (uuid[6] & 0x0F) | 0x40 // Version (UUIDv4 = 0100)
uuid[8] = (uuid[8] & 0x3F) | 0x80 // Variant (RFC9562 / RFC4122 = 10xxxxxx)
return fmt.Sprintf("%08x-%04x-%04x-%04x-%012x",
uuid[0:4], // 4 bytes
uuid[4:6], // 2 bytes
uuid[6:8], // 2 bytes (version included)
uuid[8:10], // 2 bytes (variant included)
uuid[10:]) // 6 bytes
}
The following table provides definitions to the terms to be frequently mentioned in the subsequent sections.
| Term | Description | Model No. | Availability |
|---|
| Hub Mini | Short for SwitchBot Hub Mini | W0202200 | |
| Hub Plus | Short for SwitchBot Hub Plus | SwitchBot Hub S1 | |
| Hub 2 | Short for SwitchBot Hub 2 | W3202100 | |
| Hub 3 | Short for SwitchBot Hub 3 | W7202100 | |
| Bot | Short for SwitchBot Bot | SwitchBot S1 | |
| Curtain | Short for SwitchBot Curtain | W0701600 | |
| Curtain 3 | Short for SwitchBot Curtain 3 | W2400000 | |
| Plug | Short for SwitchBot Plug | SP11 | Currently only available in Japan |
| Meter | Short for SwitchBot Thermometer and Hygrometer | SwitchBot MeterTH S1 | |
| Meter Plus (JP) | Short for SwitchBot Thermometer and Hygrometer Plus (JP). | W2201500 | Only available in Japan |
| Meter Plus (US) | Short for SwitchBot Thermometer and Hygrometer Plus (US) | W2301500 | Only available in US |
| Outdoor Meter | Short for Indoor/Outdoor Thermo-Hygrometer | W3400010 | |
| Weather Station | Short for SwitchBot Weather Station | W3400010 | |
| Meter Pro | Short for SwitchBot Meter Pro | W4900000 | |
| Meter Pro (CO2 Monitor) | Short for SwitchBot Meter Pro (CO2 Monitor) | W4900010 | |
| Motion Sensor | Short for SwitchBot Motion Sensor | W1101500 | |
| Contact Sensor | Short for SwitchBot Contact Sensor | W1201500 | |
| Prensence Sensor | Short for SwitchBot Prensence Sensor | W8200000 | |
| Water Leak Detector | Short for SwitchBot Water Leak Detector | W4402000 | |
| Color Bulb | Short for SwitchBot Color Bulb | W1401400 | |
| Strip Light | Short for SwitchBot LED Strip Light | W1701100 | |
| Plug Mini (US) | Short for SwitchBot Plug Mini (US) | W1901400 and W1901401 | Only available in US |
| Plug Mini (JP) | Short for SwitchBot Plug Mini (JP) | W2001400 and W2001401 | Only available in Japan |
| Plug Mini (EU) | Short for SwitchBot Plug Mini (EU) | W7732300 | Only available in Europe |
| Lock | Short for SwitchBot Lock | W1601700 | |
| Lock Pro | Short for SwitchBot Lock Pro | W3500000 | |
| Lock Pro Matter Enabled | Short for SwitchBot Lock Pro Matter Enabled | W8102000 | |
| Lock Vision | Short for SwitchBot Lock Vision | W1141000 | |
| Lock Vision Pro | Short for SwitchBot Lock Vision Pro | W1141001 | |
| Keypad | Short for SwitchBot Lock | W2500010 | |
| Keypad Touch | Short for SwitchBot Lock | W2500020 | |
| S1 | Short for SwitchBot Robot Vacuum Cleaner S1 | W3011000 | |
| S1 Plus | Short for SwitchBot Robot Vacuum Cleaner S1 Plus | W3011010 | |
| K10+ | Short for SwitchBot Mini Robot Vacuum K10+ | W3011020 | |
| K10+ Pro | Short for SwitchBot Mini Robot Vacuum K10+ Pro | W3011026 | |
| S10 | Short for SwitchBot Floor Cleaning Robot S10 | W3211800 | |
| S20 | Short for SwitchBot Floor Cleaning Robot S20 | W6602310 | |
| K10+ Pro Combo | Short for SwitchBot Robot Vacuum K10+ Pro Combo | W3002500 | |
| K20+ Pro | Short for SwitchBot Multitasking Household Robot K20+ Pro | W3002520 | |
| K11+ | Short for Robot Vacuum K11+ | W3003100 | |
| Ceiling Light | Short for SwitchBot Ceiling Light | W2612230 and W2612240 | Currently only available in Japan |
| Ceiling Light Pro | Short for SwitchBot Ceiling Light Pro | W2612210 and W2612220 | Currently only available in Japan |
| RGBICWW Strip Light | Short for SwitchBot RGBICWW Strip Light | W1702109 | |
| RGBICWW Floor Lamp | Short for SwitchBot RGBICWW Floor Lamp | W1702101 | |
| RGBIC Neon Rope Light | Short for SwitchBot RGBIC Neon Rope Light | W1702107 | |
| RGBIC Neon Wire Rope Light | Short for SwitchBot RGBIC Neon Wire Rope Light | W1702108 | |
| Indoor Cam | Short for SwitchBot Indoor Cam | W1301200 | |
| Pan/Tilt Cam | Short for SwitchBot Pan/Tilt Cam | W1801200 | |
| Pan/Tilt Cam 2K | Short for SwitchBot Pan/Tilt Cam 2K | W3101100 | |
| Blind Tilt | Short for SwitchBot Blind Tilt | W2701600 | |
| Battery Circulator Fan | Short for SwitchBot Battery Circulator Fan | W3800510 | |
| Circulator Fan | Short for SwitchBot Circulator Fan | W3800511 | |
| Evaporative Humidifier | Short for SwitchBot Evaporative Humidifier | W3902300 | |
| Evaporative Humidifier (Auto-refill) | Short for SwitchBot Evaporative Humidifier (Auto-refill) | W3902310 | |
| Air Purifier PM2.5 | Short for SwitchBot Air Purifier | W5302300 | |
| Air Purifier Table PM2.5 | Short for SwitchBot Air Purifier Table | W5302310 | |
| Air Purifier VOC | Short for SwitchBot Air Purifier | W5302300 | Currently only available in Japan |
| Air Purifier Table VOC | Short for SwitchBot Air Purifier Table | W5302310 | Currently only available in Japan |
| Roller Shade | Short for SwitchBot Roller Shade | W5000000 | |
| Relay Switch 1PM | Short for SwitchBot Relay Switch 1PM | W5502310 | |
| Relay Switch 1 | Short for SwitchBot Relay Switch 1 | W5502300 | |
| Relay Switch 2PM | Short for SwitchBot Relay Switch 2PM | W5502320 | |
| Garage Door Opener | Short for SwitchBot Garage Door Opener | W5502330 | |
| Floor Lamp | Short for SwitchBot RGBWW Floor Lamp | W1702100 | |
| Strip Light 3 | Short for SwitchBot RGBWW Strip Light 3 | W1702110 | |
| Lock Lite | Short for SwitchBot Lock Lite | W5110000 | |
| Video Doorbell | Short for SwitchBot Video Doorbell | W6702000 | |
| Keypad Vision | Short for SwitchBot Keypad Vision | W5600003 | |
| Keypad Vision Pro | Short for SwitchBot Keypad Vision Pro | W5600009 | |
| Lock Ultra | Short for SwitchBot Lock Ultra | W5600000 | |
| Standing Circulator Fan | Short for SwitchBot Standing Circulator Fan | W3800520 | |
| Pan/Tilt Cam Plus 2K | Short for SwitchBot Pan/Tilt Cam Plus 2K | W3101102 | |
| Pan/Tilt Cam Plus 3K | Short for SwitchBot Pan/Tilt Cam Plus 3K | W4001100 | |
| AI Hub | Short for SwitchBot AI Hub | W8002100 | |
| Candle Warmer Lamp | Short for SwitchBot Candle Warmer Lamp | W8302100 and W8302101 | |
| Home Climate Panel | Short for SwitchBot Home Climate Panel | W7400000 | |
| Smart Radiator Thermostat | Short for SwitchBot Smart Radiator Thermostat | W7830000 | |
| AI Art Frame | Short for SwitchBot AI Art Frame | W8402000 and W8402010 and W8402020 | |
Important note: Beyond V9.0, there will NOT be a Cloud Services option in the app. You will see Third-party Services instead. Please read this article for more information, https://support.switch-bot.com/hc/en-us/articles/7257579858455
A SwitchBot app feature, which appears in the app <V9.0 that
- Enables SwitchBot products to be discovered and communicated with third-party services such as Home Assistant, Alexa, Google Home, IFTTT, SmartThings, and so forth
- Allows users to create customized smart scenes and widgets. For BLE-based devices such as Bot and Curtain
- You MUST first add a SwitchBot Hub such as Hub 2, Hub Mini with Matter Enabled, or Hub Mini
- Then enable Cloud Services on the Settings page in order to make use of the web API!
https://api.switch-bot.com
The following request types are supported,
For POST requests, use application/json; charset=utf8 as the Content-Type
The amount of API calls per day is limited to 10000 times. Going over that limit will return "Unauthorized."
The following parameters need to be included into the header,
| Parameter | Type | Location | Required | Description |
|---|
| Authorization | String | header | Yes | Open Token acquired |
| sign | String | header | Yes | A signature generated from the token and secret key using a specific algorithm. |
| t | Long | header | Yes | A 13 digit timestamp (standard time). |
| nonce | Long | header | Yes | A random UUID generated by developers themselves to blend into the string to sign. |
The following table lists the most common HTTP error response,
| Code | Name | Description |
|---|
| 400 | Bad Request | The client has issued an invalid request. This is commonly used to specify validation errors in a request payload. |
| 401 | Unauthorized | Authorization for the API is required, but the request has not been authenticated. |
| 403 | Forbidden | The request has been authenticated but does not have appropriate permissions, or a requested resource is not found. |
| 404 | Not Found | Specifies the requested path does not exist. |
| 406 | Not Acceptable | The client has requested a MIME type via the Accept header for a value not supported by the server. |
| 415 | Unsupported Media Type | The client has defined a contentType header that is not supported by the server. |
| 422 | Unprocessable Entity | The client has made a valid request, but the server cannot process it. This is often used for APIs for which certain limits have been exceeded. |
| 429 | Too Many Requests | The client has exceeded the number of requests allowed for a given time window. |
| 500 | Internal Server Error | An unexpected error on the SmartThings servers has occurred. These errors should be rare. |
The devices API is used to access the properties and states of SwitchBot devices and to send control commands to those devices.
GET /v1.1/devices
Get a list of devices, which include physical devices and virtual infrared remote devices that have been added to the current user's account.
Note: For devices that communicate via BLE, please enable Cloud Services on SwitchBot app first.
Physical devices refer to the following SwitchBot products,
- Hub
- Hub Plus
- Hub Mini
- Bot
- Curtain
- Plug
- Meter
- Motion Sensor
- Contact Sensor
- Color Bulb
- Humidifier
- Smart Fan
- Strip Light
- Plug Mini (US)
- Plug Mini (JP)
- Lock
- Meter Plus (JP)
- Meter Plus (US)
- Robot Vacuum Cleaner S1
- Robot Vacuum Cleaner S1 Plus
- Keypad
- Keypad Touch
- Ceiling Light
- Ceiling Light Pro
- Blind Tilt
- Hub 2
- Hub 3
- Outdoor Meter
- Weather Station
- Battery Circulator Fan
- Curtain 3
- Lock Pro
- Floor Cleaning Robot S10
- Water Leak Detector
- Mini Robot Vacuum K10+
- Mini Robot Vacuum K10+ Pro
- Meter Pro
- Meter Pro CO2
- Circulator Fan
- Evaporative Humidifier
- Evaporative Humidifier (Auto-refill)
- K10+ Pro Combo
- Air Purifier VOC
- Air Purifier Table VOC
- Air Purifier PM2.5
- Air Purifier Table PM2.5
- Roller Shade
- Relay Switch 1PM
- Relay Switch 1
- Hub 3
- Relay Switch 2PM
- S20
- Floor Lamp
- Strip Light 3
- Garage Door Opener
- Lock Lite
- Video Doorbell
- Keypad Vision
- Lock Ultra
- Lock Vision
- Lock Vision Pro
- K20+ Pro
- K11+
- Plug Mini (EU)
- RGBICWW Strip Light
- RGBICWW Floor Lamp
- RGBIC Neon Wire Rope Light
- Smart Radiator Thermostat
- Pan/Tilt Cam Plus 2K
- Pan/Tilt Cam Plus 3K
- Standing Circulator Fan
- AI Hub
- Keypad Vision Pro
- Candle Warmer Lamp
- Presence Sensor
- Home Climate Panel
- RGBIC Neon Rope Light
- AI Art Frame
Virtual infrared remote devices refer to virtual devices that are used to simulate infrared signals of a home appliance remote control. A SwitchBot Hub Plus, Hub Mini, Hub 2, Hub 3 or Ceiling Light is required in order to be able to create these virtual devices within the app. The types of appliances supported include,
- Air Conditioner
- TV
- Light
- Streamer
- Set Top Box
- DVD Player
- Fan
- Projector
- Camera
- Air Purifier
- Speaker
- Water Heater
- Robot Vacuum Cleaner
- Others
The response is basically a JSON object, which contains the following properties,
| Key Name | Value Type |
|---|
| statusCode | Integer |
| message | String |
| body | Object |
The body object contains the following properties,
| Key Name | Value Type | Description |
|---|
| deviceList | Array | a list of physical devices |
| infraredRemoteList | Array | a list of virtual infrared remote devices |
The response may contain the following codes and messages,
| Status Code | Body Content | Message | Description |
|---|
| 100 | Device list object | success | Returns an object that contains two device lists |
| n/a | n/a | Unauthorized | Http 401 Error. User permission is denied due to invalid token. |
| 190 | n/a | System error | Device internal error due to device states not synchronized with server |
The deviceList array contains a list of objects with the following key-value attributes,
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Bot |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Curtain |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| curtainDevicesIds | Array | a list of Curtain device IDs such that the Curtain devices are being paired or grouped |
| calibrate | Boolean | determines if the open position and the close position of a device have been properly calibrated or not |
| group | Boolean | determines if a Curtain is paired with or grouped with another Curtain or not |
| master | Boolean | determines if a Curtain is the master device or not when paired with or grouped with another Curtain |
| openDirection | String | the opening direction of a Curtain |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Curtain3 |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| curtainDevicesIds | Array | a list of Curtain device IDs such that the Curtain devices are being paired or grouped |
| calibrate | Boolean | determines if the open position and the close position of a device have been properly calibrated or not |
| group | Boolean | determines if a Curtain is paired with or grouped with another Curtain or not |
| master | Boolean | determines if a Curtain is the master device or not when paired with or grouped with another Curtain |
| openDirection | String | the opening direction of a Curtain |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Hub, Hub Plus, Hub Mini, Hub 2 or Hub 3. |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Meter |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. MeterPlus |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. WoIOSensor |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. WeatherStation |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. MeterPro |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. MeterPro(CO2) |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Smart Lock |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| group | Boolean | determines if a Lock is grouped with another Lock or not |
| master | Boolean | determines if a Lock is the master device or not when grouped with another Lock in Dual Lock mode |
| groupName | String | the name of the Lock group |
| lockDevicesIds | Array | a list of Lock device IDs such that the Lock devices are being grouped in Dual Lock mode |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Smart Lock Pro |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| group | Boolean | determines if a Lock is grouped with another Lock or not |
| master | Boolean | determines if a Lock is the master device or not when grouped with another Lock in Dual Lock mode |
| groupName | String | the name of the Lock group |
| lockDevicesIds | Array | a list of Lock device IDs such that the Lock devices are being grouped in Dual Lock mode |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Smart Lock Pro Wifi |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
Device status example (GET /v1.1/devices/{deviceId}/status),
{
"deviceId": "FFFFFFFFFFF",
"deviceType": "Smart Lock Pro Wifi",
"hubDeviceId": "FFFFFFFFFFF",
"battery": 100,
"version": "V6.3",
"lockState": "unlock",
"doorState": "open",
"calibrate": true
}
lockState can be jammed, unlock, lock, latchBoltLocked.
doorState can be open or close.
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Smart Lock Ultra |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| group | Boolean | determines if a Lock is grouped with another Lock or not |
| master | Boolean | determines if a Lock is the master device or not when grouped with another Lock in Dual Lock mode |
| groupName | String | the name of the Lock group |
| lockDevicesIds | Array | a list of Lock device IDs such that the Lock devices are being grouped in Dual Lock mode |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Lock Vision |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| keyList | Object | a list of passcodes |
keyList maintains a list of passcodes,
| Key | Value Type | Description |
|---|
| id | Integer | passcode ID |
| name | String | name of the passcode |
| type | String | type of the passcode. permanent, a permanent passcode. timeLimit, a temporary passcode. disposable, a one-time passcode. |
| password | String | the passcode string encrypted with the developer secret key using the aes-128-cbc algorithm |
| iv | String | an arbitrary number used for the encryption |
| status | String | validity of the passcode. normal, the passcode is valid. expired, the passcode is invalid. |
| createTime | Long | the time when the passcode is generated |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Lock Vision Pro |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| keyList | Object | a list of passcodes |
keyList maintains a list of passcodes,
| Key | Value Type | Description |
|---|
| id | Integer | passcode ID |
| name | String | name of the passcode |
| type | String | type of the passcode. permanent, a permanent passcode. timeLimit, a temporary passcode. disposable, a one-time passcode. |
| password | String | the passcode string encrypted with the developer secret key using the aes-128-cbc algorithm |
| iv | String | an arbitrary number used for the encryption |
| status | String | validity of the passcode. normal, the passcode is valid. expired, the passcode is invalid. |
| createTime | Long | the time when the passcode is generated |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Keypad |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| lockDeviceId | String | MAC address of the Lock that the current device is paired with |
| keyList | Object | a list of passcodes |
keyList maintains a list of passcodes,
| Key | Value Type | Description |
|---|
| id | Integer | passcode ID |
| name | String | name of the passcode |
| type | String | type of the passcode. permanent, a permanent passcode. timeLimit, a temporary passcode. disposable, a one-time passcode. urgent, an emergency passcode. |
| password | String | the passcode string encrypted with the developer secret key using the aes-128-cbc algorithm |
| iv | String | an arbitrary number used for the encryption |
| status | String | validity of the passcode. normal, the passcode is valid. expired, the passcode is invalid. |
| createTime | Long | the time when the passcode is generated |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Keypad Touch |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| lockDeviceId | String | MAC address of the Lock that the current device is paired with |
| keyList | Object | a list of passcodes |
keyList maintains a list of passcodes,
| Key | Value Type | Description |
|---|
| id | Integer | passcode ID |
| name | String | name of the passcode |
| type | String | type of the passcode. permanent, a permanent passcode. timeLimit, a temporary passcode. disposable, a one-time passcode. urgent, an emergency passcode. |
| password | String | the passcode string encrypted with the developer secret key using the aes-128-cbc algorithm |
| iv | String | an arbitrary number used for the encryption |
| status | String | validity of the passcode. normal, the passcode is valid. expired, the passcode is invalid. |
| createTime | Long | the time when the passcode is generated |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Remote |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Motion Sensor |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Contact Sensor |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Presence Sensor |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Water Detector |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Ceiling Light |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Ceiling Light Pro |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. RGBICWW Strip Light |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. RGBICWW Floor Lamp |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. RGBIC Neon Rope Light |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. RGBIC Neon Wire Rope Light |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Smart Radiator Thermostat |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Plug Mini (US) |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Plug Mini (JP) |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Plug Mini (EU) |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Plug |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Strip Light |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Color Bulb |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Robot Vacuum Cleaner S1 |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Robot Vacuum Cleaner S1 Plus |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. K10+ |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. K10+ Pro |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Robot Vacuum Cleaner K10+ Pro Combo |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | returns null if not a bluetooth device |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Robot Vacuum Cleaner S10 |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Robot Vacuum Cleaner S20 |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Robot Vacuum Cleaner K11+ |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Robot Vacuum Cleaner K20 Plus Pro |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Humidifier |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Humidifier2 |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | returns null if not a bluetooth device |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Humidifier2 |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | returns null if not a bluetooth device |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Air Purifier VOC |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | returns null if not a bluetooth device |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Air Purifier Table VOC |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | returns null if not a bluetooth device |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Air Purifier PM2.5 |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | returns null if not a bluetooth device |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Air Purifier Table PM2.5 |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | returns null if not a bluetooth device |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Indoor Cam |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Pan/Tilt Cam |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Pan/Tilt Cam 2K |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Blind Tilt |
| version | Integer | the version of the device |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| blindTiltDevicesIds | Array | a list of Blind Tilt device IDs such that the Blind Tilt devices are being paired or grouped |
| calibrate | Boolean | determines if the open and the closed positions have been properly calibrated or not |
| group | Boolean | determines if a Blind Tilt device is paired with or grouped with one or more devices of the same type or not |
| master | Boolean | determines if a Blind Tilt device is the master device or not when paired with or grouped with one or more devices of the same type |
| direction | String | the opening direction of a Blind Tilt device |
| slidePosition | Integer | the current position, 0-100 |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Battery Circulator Fan |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Circulator Fan |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Roller Shade |
| bleVersion | Integer | firmware version |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| groupingDevicesIds | Array | a list of device IDs such that the Roller Shade devices are being paired or grouped |
| group | Boolean | determines if a device is paired with or grouped with one or more devices of the same type or not |
| master | Boolean | determines if a device is the master device or not when paired with or grouped with one or more devices of the same type |
| groupName | String | the name of the device group |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Relay Switch 1PM |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Relay Switch 1 |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Relay Switch 2PM |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Garage Door Opener |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Floor Lamp |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Strip Light 3 |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Lock Lite |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| group | Boolean | determines if a Lock is grouped with another Lock or not |
| master | Boolean | determines if a Lock is the master device or not when grouped with another Lock in Dual Lock mode |
| groupName | String | the name of the Lock group |
| lockDevicesIds | Array | a list of Lock device IDs such that the Lock devices are being grouped in Dual Lock mode |
Note: Some clients refer to this product as Smart Lock Lite. In this document we use deviceType: "Lock Lite".
Lock Lite supports the following commands,
| deviceType | commandType | Command | command parameter | Description |
|---|
| Lock Lite | command | lock | default | rotate to locked position |
| Lock Lite | command | unlock | default | rotate to unlocked position |
| Lock Lite | command | deadbolt | default | disengage deadbolt or latch |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Video Doorbell |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Keypad Vision |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| lockDeviceId | String | MAC address of the Lock that the current device is paired with |
| keyList | Object | a list of passcodes |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Keypad Vision Pro |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| lockDeviceId | String | MAC address of the Lock that the current device is paired with |
| keyList | Object | a list of passcodes |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Standing Circulator Fan |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Pan/Tilt Cam Plus 2K |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Pan/Tilt Cam Plus 3K |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. AI Hub |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Candle Warmer Lamp |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Home Climate Panel |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. AI Art Frame |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID |
The infraredRemoteList array contains a list of objects with the following key-value attributes,
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| remoteType | String | device type |
| hubDeviceId | String | remote device's parent Hub ID |
Request
GET https://api.switch-bot.com/v1.1/devices
Response
{
"statusCode": 100,
"body": {
"deviceList": [
{
"deviceId": "500291B269BE",
"deviceName": "Living Room Humidifier",
"deviceType": "Humidifier",
"enableCloudService": true,
"hubDeviceId": "000000000000"
}
],
"infraredRemoteList": [
{
"deviceId": "02-202008110034-13",
"deviceName": "Living Room TV",
"remoteType": "TV",
"hubDeviceId": "FA7310762361"
}
]
},
"message": "success"
}
GET /v1.1/devices/{deviceId}/status
Get the status of a physical device that has been added to the current user's account.
Physical devices refer to the following SwitchBot products,
- Bot
- Plug
- Curtain
- Meter
- Motion Sensor
- Contact Sensor
- Color Bulb
- Humidifier
- Smart Fan
- Strip Light
- Plug Mini (US)
- Plug Mini (JP)
- Lock
- Meter Plus (JP)
- Meter Plus (US)
- Robot Vacuum Cleaner S1
- Robot Vacuum Cleaner S1 Plus
- Keypad
- Keypad Touch
- Ceiling Light
- Ceiling Light Pro
- Hub 2
- Outdoor Meter
- Battery Circulator Fan
- Lock Pro
- Floor Cleaning Robot S10
- Water Leak Detector
- Mini Robot Vacuum K10+
- Mini Robot Vacuum K10+ Pro
- Meter Pro
- Meter Pro CO2
- Circulator Fan
- Evaporative Humidifier
- Evaporative Humidifier (Auto-refill)
- K10+ Pro Combo
- Air Purifier VOC
- Air Purifier Table VOC
- Air Purifier PM2.5
- Air Purifier Table PM2.5
- Roller Shade
- Relay Switch 1PM
- Relay Switch 1
- Hub 3
- Relay Switch 2PM
- Garage Door Opener
- S20
- Floor Lamp
- Strip Light 3
- Lock Lite
- Lock Ultra
- Video Doorbell
- Keypad Vision
- K20+ Pro
- Plug Mini (EU)
- K11+
- Standing Circulator Fan
- AI Hub
- Keypad Vision Pro
- Candle Warmer Lamp
- Presence Sensor
- Home Climate Panel
- RGBIC Neon Rope Light
- AI Art Frame
new Weather Stationnew Lock Pro Matter Enablednew Lock Visionnew Lock Vision Pro
| Name | Type | Required | Description |
|---|
| deviceId | String | Yes | device ID |
The response is basically a JSON object, which contains the following properties,
| Key Name | Value Type |
|---|
| statusCode | Integer |
| message | String |
| body | Object |
The reponses may contain the following codes and message,
| Status Code | Body Content | Message | Description |
|---|
| 100 | Device list object | success | Returns an object that contains two device lists |
| n/a | n/a | Unauthorized | Http 401 Error. User permission is denied due to invalid token. |
| 190 | n/a | System error | Device internal error due to device states not synchronized with server |
The body object contains the following properties,
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Bot |
| power | String | ON/OFF state |
| battery | Integer | Four-segment battery level division,<10%, shown as 9;10%~20%, shown as 19;20%~60%, shown as 59;≥60%, shown as 100 |
| version | String | the current firmware version, e.g. V6.3 |
| deviceMode | String | pressMode, switchMode, or customizeMode |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Curtain |
| hubDeviceId | String | device's parent Hub ID |
| calibrate | Boolean | determines if the open position and the close position of a device have been properly calibrated or not |
| group | Boolean | determines if a Curtain is paired with or grouped with another Curtain or not |
| moving | Boolean | determines if a Curtain is moving or not |
| battery | Integer | Four-segment battery level division,<10%, shown as 5;10%~20%, shown as 15;20%~60%, shown as 40;≥60%, shown as 80 |
| version | String | the current firmware version, e.g. V4.2 |
| slidePosition | String | the percentage of the distance between the calibrated open position and closed position that Curtain has traversed |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Curtain3 |
| hubDeviceId | String | device's parent Hub ID |
| calibrate | Boolean | determines if the open position and the close position of a device have been properly calibrated or not |
| group | Boolean | determines if a Curtain is paired with or grouped with another Curtain or not |
| moving | Boolean | determines if a Curtain is moving or not |
| battery | Integer | Four-segment battery level division,<10%, shown as 5;10%~20%, shown as 15;20%~60%, shown as 40;≥60%, shown as 80 |
| version | String | the current firmware version, e.g. V4.2 |
| slidePosition | String | the percentage of the distance between the calibrated open position and closed position that Curtain has traversed |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Meter |
| hubDeviceId | String | device's parent Hub ID |
| temperature | Float | temperature in celsius |
| version | String | the current firmware version, e.g. V4.2 |
| battery | Integer | Four-segment battery level division,<10%, shown as 10;10%~20%, shown as 20;20%~60%, shown as 60;≥60%, shown as 100 |
| humidity | Integer | humidity percentage |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. MeterPlus |
| hubDeviceId | String | device's parent Hub ID |
| battery | Integer | Four-segment battery level division,<10%, shown as 10;10%~20%, shown as 20;20%~60%, shown as 60;≥60%, shown as 100 |
| version | String | the current firmware version, e.g. V4.2 |
| temperature | Float | temperature in celsius |
| humidity | Integer | humidity percentage |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. WoIOSensor |
| hubDeviceId | String | device's parent Hub ID |
| battery | Integer | Four-segment battery level division,<10%, shown as 10;10%~20%, shown as 20;20%~60%, shown as 60;≥60%, shown as 100 |
| version | String | the current firmware version, e.g. V4.2 |
| temperature | Float | temperature in celsius |
| humidity | Integer | humidity percentage |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. WeatherStation |
| hubDeviceId | String | device's parent Hub ID |
| battery | Integer | the current battery level, 0-100 |
| version | String | the current firmware version, e.g. V6.3 |
| temperature | Float | temperature in celsius |
| humidity | Integer | humidity percentage |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. MeterPro |
| hubDeviceId | String | device's parent Hub ID |
| battery | Integer | the current battery level, 0-100 |
| version | String | the current firmware version, e.g. V4.2 |
| temperature | Float | temperature in celsius |
| humidity | Integer | humidity percentage |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. MeterPro(CO2) |
| hubDeviceId | String | device's parent Hub ID |
| battery | Integer | the current battery level, 0-100 |
| version | String | the current firmware version, e.g. V4.2 |
| temperature | Float | temperature in celsius |
| humidity | Integer | humidity percentage |
| CO2 | Integer | CO2 ppm value, 0-9999 |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Smart Lock |
| hubDeviceId | String | device's parent Hub ID |
| battery | Integer | Four-segment battery level division,<10%, shown as 10;10%~20%, shown as 20;20%~60%, shown as 60;≥60%, shown as 100 |
| version | String | the current firmware version, e.g. V4.2 |
| lockState | String | determines if locked or not |
| doorState | String | determines if the door is closed or not |
| calibrate | Boolean | determines if Lock has been calibrated or not |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Smart Lock Pro |
| hubDeviceId | String | device's parent Hub ID |
| battery | Integer | the current battery level, 0-100 |
| version | String | the current firmware version, e.g. V4.2 |
| lockState | String | determines if locked or not, jammed, unlock or lock |
| doorState | String | determines if the door is closed or not, open or close |
| calibrate | Boolean | determines if Lock has been calibrated or not |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Smart Lock Pro Wifi |
| hubDeviceId | String | device's parent Hub ID |
| battery | Integer | the current battery level, 0-100 |
| version | String | the current firmware version, e.g. V6.3 |
| lockState | String | jammed, unlock, lock, latchBoltLocked |
| doorState | String | open, close |
| calibrate | Boolean | determines if Lock has been calibrated or not |
| onlineStatus | String | the connection status of the device. online or offline |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Keypad |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Keypad Touch |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Motion Sensor |
| hubDeviceId | String | device's parent Hub ID |
| battery | Integer | Four-segment battery level division,<10%, shown as 10;10%~20%, shown as 20;20%~60%, shown as 60;≥60%, shown as 100 |
| version | String | the current firmware version, e.g. V4.2 |
| moveDetected | Boolean | determines if motion is detected |
| brightness | String | the ambient brightness picked up by the sensor. bright or dim |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Contact Sensor |
| hubDeviceId | String | device's parent Hub ID |
| battery | Integer | Four-segment battery level division,<10%, shown as 10;10%~20%, shown as 20;20%~60%, shown as 60;≥60%, shown as 100 |
| version | String | the current firmware version, e.g. V4.2 |
| moveDetected | Boolean | determines if motion is detected |
| openState | String | the open state of the sensor. open, close, or timeOutNotClose |
| brightness | String | the ambient brightness picked up by the sensor. bright or dim |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Presence Sensor |
| hubDeviceId | String | device's parent Hub ID |
| battery | Integer | Four-segment battery level division,<10%, shown as 10;10%~20%, shown as 20;20%~60%, shown as 60;≥60%, shown as 100 |
| version | String | the current firmware version, e.g. V4.2 |
| lightLevel | Integer | the level of illuminance of the ambience light, 1~20 |
| Detected | Boolean | determines if human is detected |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Water Detector |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| battery | Integer | the current battery level, 0-100 |
| version | String | the current firmware version, e.g. V4.2 |
| status | Integer | 0, dry. 1, leak detected |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Ceiling Light |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| power | String | ON/OFF state |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| brightness | Integer | the brightness value, range from 1 to 100 |
| colorTemperature | Integer | the color temperature value, range from 2700 to 6500 |
| onlineStatus | String | the connection status of the device. online or offline |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Ceiling Light Pro |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| power | String | ON/OFF state |
| brightness | Integer | the brightness value, range from 1 to 100 |
| colorTemperature | Integer | the color temperature value, range from 2700 to 6500 |
| onlineStatus | String | the connection status of the device. online or offline |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. RGBICWW Strip Light |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| power | String | ON/OFF state |
| onlineStatus | String | the connection status of the device. online or offline |
| brightness | Integer | the brightness value, range from 1 to 100 |
| color | String | the color value, RGB "255:255:255" |
| colorTemperature | Integer | the color temperature value, range from 2700 to 6500 |
| onlineStatus | String | the connection status of the device. online or offline |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. RGBICWW Floor Lamp |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| power | String | ON/OFF state |
| onlineStatus | String | the connection status of the device. online or offline |
| brightness | Integer | the brightness value, range from 1 to 100 |
| color | String | the color value, RGB "255:255:255" |
| colorTemperature | Integer | the color temperature value, range from 2700 to 6500 |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. RGBIC Neon Wire Rope Light |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| power | String | ON/OFF state |
| onlineStatus | String | the connection status of the device. online or offline |
| brightness | Integer | the brightness value, range from 1 to 100 |
| color | String | the color value, RGB "255:255:255" |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. RGBIC Neon Rope Light |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| power | String | ON/OFF state |
| onlineStatus | String | the connection status of the device. online or offline |
| brightness | Integer | the brightness value, range from 1 to 100 |
| color | String | the color value, RGB "255:255:255" |
| Key | Value Type | Description |
|---|
| battery | Integer | the current battery level |
| deviceId | String | device ID |
| deviceType | String | device type. Smart Radiator Thermostat |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| mode | Integter | the current mode. 0, schedule mode; 1,manual mode; 2, power off mode; 3, energy saving mode; 4, comfort mode;5, quick heating mode |
| temperature | Float | temperature in celsius |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Plug Mini (US) |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| voltage | Float | the voltage of the device, measured in Volt |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| weight | Float | the power consumed in a day, measured in Watts |
| electricityOfDay | Integer | the duration that the device has been used during a day, measured in minutes |
| electricCurrent | Float | the current of the device at the moment, measured in mA |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Plug Mini (JP) |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| voltage | Float | the voltage of the device, measured in Volt |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| weight | Float | the power consumed in a day, measured in Watts |
| electricityOfDay | Integer | the duration that the device has been used during a day, measured in minutes |
| electricCurrent | Float | the current of the device at the moment, measured in mA |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Plug Mini (EU) |
| switchStatus | Integer | the current switch state. 0, off; 1, on |
| voltage | Float | the voltage of the device, measured in Volt |
| power | Float | the current power, measured in Watts |
| electricCurrent | Float | the current of the device at the moment, measured in mA |
| usedElectricity | Integer | daily power consumption, measured in watt-minutes |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Plug |
| power | String | ON/OFF state |
| version | String | the current Wi-Fi firmware version, e.g. V4.2 |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Strip Light |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| power | String | ON/OFF state |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| brightness | Integer | the brightness value, range from 1 to 100 |
| color | String | the color value, RGB "255:255:255" |
| onlineStatus | String | the connection status of the device. online or offline |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Color Bulb |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| power | String | ON/OFF state |
| brightness | Integer | the brightness value, range from 1 to 100 |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| color | String | the color value, RGB "255:255:255" |
| colorTemperature | Integer | the color temperature value, range from 2700 to 6500 |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Robot Vacuum Cleaner S1 |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| workingStatus | String | the working status of the device. StandBy, Clearing, Paused, GotoChargeBase, Charging, ChargeDone, Dormant, InTrouble, InRemoteControl, or InDustCollecting |
| onlineStatus | String | the connection status of the device. online or offline |
| battery | Integer | the current battery level |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Robot Vacuum Cleaner S1 Plus |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| workingStatus | String | the working status of the device. StandBy, Clearing, Paused, GotoChargeBase, Charging, ChargeDone, Dormant, InTrouble, InRemoteControl, or InDustCollecting |
| onlineStatus | String | the connection status of the device. online or offline |
| battery | Integer | the current battery level |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. K10+ |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| workingStatus | String | the working status of the device. StandBy, Clearing, Paused, GotoChargeBase, Charging, ChargeDone, Dormant, InTrouble, InRemoteControl, or InDustCollecting |
| onlineStatus | String | the connection status of the device. online or offline |
| battery | Integer | the current battery level 0-100 |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. K10+ Pro |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| workingStatus | String | the working status of the device. StandBy, Clearing, Paused, GotoChargeBase, Charging, ChargeDone, Dormant, InTrouble, InRemoteControl, or InDustCollecting |
| onlineStatus | String | the connection status of the device. online or offline |
| battery | Integer | the current battery level 0-100 |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Robot Vacuum Cleaner K10+ Pro Combo |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| workingStatus | String | the working status of the device. StandBy, Clearing, Paused, GotoChargeBase, Charging, ChargeDone, Dormant, InTrouble, InRemoteControl, or InDustCollecting |
| onlineStatus | String | the connection status of the device. online or offline |
| battery | Integer | the current battery level 0-100 |
| taskType | String | the current task in progress. standBy, explore, cleanAll, cleanArea, cleanRoom, backToCharge, collectDust, remoteControl, cleanWithExplorer |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Robot Vacuum Cleaner S10 |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| workingStatus | String | the working status of the device. StandBy, Clearing, Paused, GotoChargeBase, Charging, ChargeDone, Dormant, InTrouble, InRemoteControl, or InDustCollecting |
| onlineStatus | String | the connection status of the device. online or offline |
| battery | Integer | the current battery level 0-100 |
| waterBaseBattery | Integer | the current battery level 0-100 |
| taskType | String | the current task in progress. standBy, explore, cleanAll, cleanArea, cleanRoom, fillWater, deepWashing, backToCharge, markingWaterBase, drying, collectDust, remoteControl, cleanWithExplorer, fillWaterForHumi, markingHumi |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Robot Vacuum Cleaner S20 |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| workingStatus | String | the working status of the device. StandBy, Clearing, Paused, GotoChargeBase, Charging, ChargeDone, Dormant, InTrouble, InRemoteControl, or InDustCollecting |
| onlineStatus | String | the connection status of the device. online or offline |
| battery | Integer | the current battery level 0-100 |
| waterBaseBattery | Integer | the current battery level 0-100 |
| taskType | String | the current task in progress. standBy, explore, cleanAll, cleanArea, cleanRoom, fillWater, deepWashing, backToCharge, markingWaterBase, drying, collectDust, remoteControl, cleanWithExplorer, fillWaterForHumi, markingHumi |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Robot Vacuum Cleaner K11+ |
| enableCloudService | Boolean | determines if Cloud Service is enabled or not for the current device |
| hubDeviceId | String | device's parent Hub ID. 000000000000 when the device itself is a Hub or it is connected through Wi-Fi. |
| workingStatus | String | the working status of the device. StandBy, Clearing, Paused, GotoChargeBase, Charging, ChargeDone, Dormant, InTrouble, InRemoteControl, or InDustCollecting |
| onlineStatus | String | the connection status of the device. online or offline |
| battery | Integer | the current battery level 0-100 |
| taskType | String | the current task in progress. standBy, explore, cleanAll, cleanArea, cleanRoom, fillWater, deepWashing, backToCharge, markingWaterBase, drying, collectDust, remoteControl, cleanWithExplorer, fillWaterForHumi, markingHumi |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Humidifier |
| power | String | ON/OFF state |
| humidity | Integer | humidity percentage |
| temperature | Float | temperature in celsius |
| nebulizationEfficiency | Integer | atomization efficiency percentage |
| auto | Boolean | determines if a Humidifier is in Auto Mode or not |
| childLock | Boolean | determines if a Humidifier's safety lock is on or not |
| sound | Boolean | determines if a Humidifier is muted or not |
| lackWater | Boolean | determines if the water tank is empty or not |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Humidifier2 |
| power | String | ON/OFF state |
| humidity | Integer | humidity percentage |
| 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 |
| drying | Boolean | determines if the device is drying its filter or not |
| childLock | Boolean | determines if the safety lock is on or not |
| filterElement | Object | contains status info of the filter. e.g. {"effectiveUsageHours": 240, "usedHours": 20}. effectiveUsageHours, the effective duration of the filter in hours; usedHours, the number of hours the filter has been used. |
| version | Integer | firmware version |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Humidifier2 |
| power | String | ON/OFF state |
| humidity | Integer | humidity percentage |
| 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 |
| drying | Boolean | determines if the device is drying its filter or not |
| childLock | Boolean | determines if the safety lock is on or not |
| filterElement | Object | contains status info of the filter. e.g. {"effectiveUsageHours": 240, "usedHours": 20}. effectiveUsageHours, the effective duration of the filter in hours; usedHours, the number of hours the filter has been used. |
| version | Integer | firmware version |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Air Purifier VOC |
| power | String | current state; ON, on; OFF, off |
| version | String | the current firmware version, e.g. V4.2 |
| hubDeviceId | String | returns null if not a bluetooth device |
| mode | Integter | the current mode. 1, normal or fan mode; 2, auto mode; 3, sleep mode; 4, pet mode |
| childLock | Integter | child lock. 0, disabled; 1, enabled |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Air Purifier Table VOC |
| power | String | current state; ON, on; OFF, off |
| version | String | the current firmware version, e.g. V4.2 |
| hubDeviceId | String | returns null if not a bluetooth device |
| mode | Integter | the current mode. 1, normal or fan mode; 2, auto mode; 3, sleep mode; 4, pet mode |
| childLock | Integter | child lock. 0, disabled; 1, enabled |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Air Purifier PM2.5 |
| power | String | current state; ON, on; OFF, off |
| version | String | the current firmware version, e.g. V4.2 |
| hubDeviceId | String | returns null if not a bluetooth device |
| mode | Integter | the current mode. 1, normal or fan mode; 2, auto mode; 3, sleep mode; 4, pet mode |
| childLock | Integter | child lock. 0, disabled; 1, enabled |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Air Purifier Table PM2.5 |
| power | String | current state; ON, on; OFF, off |
| version | String | the current firmware version, e.g. V4.2 |
| hubDeviceId | String | returns null if not a bluetooth device |
| mode | Integter | the current mode. 1, normal or fan mode; 2, auto mode; 3, sleep mode; 4, pet mode |
| childLock | Integter | child lock. 0, disabled; 1, enabled |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Blind Tilt |
| hubDeviceId | String | device's parent Hub ID |
| version | Integer | the firmware version of the device |
| calibrate | Boolean | determines if the open and the closed positions have been properly calibrated or not |
| group | Boolean | determines if a Blind Tilt device is paired with or grouped with one or more devices of the same type or not |
| moving | Boolean | determines if the device is moving or not |
| direction | String | the opening direction of a Blind Tilt device |
| slidePosition | Integer | the current position, 0-100 |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Roller Shade |
| hubDeviceId | String | device's parent Hub ID |
| version | String | the current firmware version, e.g. V4.2 |
| calibrate | Boolean | determines if the open and the closed positions have been properly calibrated or not |
| battery | Integer | the current battery level 0-100 |
| moving | Boolean | determines if the device is moving or not |
| slidePosition | Integer | the current position, 0-100 |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Hub 2 |
| hubDeviceId | String | Hub ID, equivalent to device ID |
| temperature | Float | temperature in celsius |
| lightLevel | Integer | the level of illuminance of the ambience light, 1~20 |
| version | String | the current firmware version, e.g. V4.2 |
| humidity | Integer | humidity percentage |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Hub 3 |
| hubDeviceId | String | Hub ID, equivalent to device ID |
| version | String | the current firmware version, e.g. V4.2 |
| temperature | Float | temperature in celsius |
| lightLevel | Integer | the level of illuminance of the ambience light, 1~10 |
| humidity | Integer | humidity percentage |
| moveDetected | Boolean | determines if motion is detected |
| onlineStatus | String | the connection status of the device. online or offline |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Battery Circulator Fan |
| mode | String | fan mode. direct mode: direct; natural mode: "natural"; sleep mode: "sleep"; ultra quiet mode: "baby" |
| version | String | the current firmware version, e.g. V4.2 |
| battery | Integer | the current battery level |
| power | String | ON/OFF state |
| nightStatus | String | 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 | Integer | fan speed. 1~100 |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceName | String | device name |
| deviceType | String | device type. Circulator Fan |
| mode | String | fan mode. direct mode: direct; natural mode: "natural"; sleep mode: "sleep"; ultra quiet mode: "baby" |
| version | String | the current firmware version, e.g. V4.2 |
| power | String | ON/OFF state |
| nightStatus | String | 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 |
| fanSpeed | Integer | fan speed. 1~100 |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Relay Switch 1PM |
| switchStatus | Integer | the current switch state. 0, off; 1, on |
| voltage | Float | the current voltage, measured in Volt |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| power | Float | the current power, measured in Watts |
| usedElectricity | Integer | daily power consumption, measured in watt-minutes |
| electricCurrent | Integer | the electrical current measured in mA |
| hubDeviceId | String | Hub ID, equivalent to device ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Relay Switch 1 |
| switchStatus | Integer | the current switch state. 0, off; 1, on |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| hubDeviceId | String | Hub ID, equivalent to device ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Relay Switch 2PM |
| online | Boolean | the connection status of the device. true or false |
| switch1Status | Integer | the current switch1 state. 0, off; 1, on |
| switch2Status | Integer | the current switch2 state. 0, off; 1, on |
| switch1Voltage | Float | the switch1 current voltage, measured in Volt |
| switch2Voltage | Float | the switch2 current voltage, measured in Volt |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| switch1Power | Float | the switch1 current power, measured in Watts |
| switch2Power | Float | the switch2 current power, measured in Watts |
| switch1UsedElectricity | Integer | switch1 daily power consumption, measured in watt-minutes |
| switch2UsedElectricity | Integer | switch2 daily power consumption, measured in watt-minutes |
| switch1ElectricCurrent | Integer | the switch1 electrical current measured in mA |
| switch2ElectricCurrent | Integer | the switch2 electrical current measured in mA |
| calibrate | Boolean | determines if the open and the closed positions have been properly calibrated or not |
| position | Integer | the current position, 0-100 |
| isStuck | String | determine if the roller blind is stuck |
| hubDeviceId | String | Hub ID, equivalent to device ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Garage Door Opener |
| doorStatus | Integer | the current switch state. 0, on; 1, off |
| online | Boolean | the connection status of the device. true or false |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Floor Lamp |
| online | Boolean | the connection status of the device. true or false |
| hubDeviceId | String | device's parent Hub ID |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| power | String | ON/OFF state |
| brightness | Integer | the brightness value, range from 1 to 100 |
| color | String | the color value, RGB "255:255:255" |
| colorTemperature | Integer | the color temperature value, range from 2700 to 6500 |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Strip Light 3 |
| hubDeviceId | String | device's parent Hub ID |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| power | String | ON/OFF state |
| brightness | Integer | the brightness value, range from 1 to 100 |
| color | String | the color value, RGB "255:255:255" |
| colorTemperature | Integer | the color temperature value, range from 2700 to 6500 |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Lock Lite |
| hubDeviceId | String | device's parent Hub ID |
| battery | Integer | the current battery level |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| lockState | String | determines if locked or not, jammed, unlock or lock |
| calibrate | Boolean | determines if the open and the closed positions have been properly calibrated or not |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Lock Ultra |
| hubDeviceId | String | device's parent Hub ID |
| battery | Integer | the current battery level, 0-100 |
| version | String | the current firmware version, e.g. V6.3 |
| lockState | String | jammed, unlock, lock, latchBoltLocked |
| doorState | String | open, close |
| calibrate | Boolean | determines if Lock has been calibrated or not |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Lock Vision |
| hubDeviceId | String | device's parent Hub ID |
| battery | Integer | the current battery level, 0-100 |
| version | String | the current firmware version, e.g. V6.3 |
| lockState | String | jammed, unlock, lock, latchBoltLocked |
| doorState | String | open, close |
| calibrate | Boolean | determines if Lock has been calibrated or not |
| onlineStatus | String | the connection status of the device. online or offline |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Lock Vision Pro |
| hubDeviceId | String | device's parent Hub ID |
| battery | Integer | the current battery level, 0-100 |
| version | String | the current firmware version, e.g. V6.3 |
| lockState | String | jammed, unlock, lock, latchBoltLocked |
| doorState | String | open, close |
| calibrate | Boolean | determines if Lock has been calibrated or not |
| onlineStatus | String | the connection status of the device. online or offline |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Video Doorbell |
| hubDeviceId | String | device's parent Hub ID |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| battery | Integer | the current battery level |
| online | Boolean | the connection status of the device. true or false |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Robot Vacuum Cleaner K20 Plus Pro |
| hubDeviceId | String | device's parent Hub ID |
| workingStatus | String | the working status of the device. StandBy, Clearing, Paused, GotoChargeBase, Charging, ChargeDone, Dormant, InTrouble, InRemoteControl, or InDustCollecting |
| onlineStatus | String | the connection status of the device. online or offline |
| battery | Integer | the current battery level 0-100 |
| taskType | String | the current task in progress. standBy, explore, cleanAll, cleanArea, cleanRoom, backToCharge, collectDust, remoteControl, cleanWithExplorer |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Keypad Vision |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Keypad Vision Pro |
| hubDeviceId | String | device's parent Hub ID |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Standing Circulator Fan |
| hubDeviceId | String | device's parent Hub ID |
| mode | String | fan mode. direct mode: direct; natural mode: "natural"; sleep mode: "sleep"; ultra quiet mode: "baby" |
| version | String | the current firmware version, e.g. V4.2 |
| power | String | ON/OFF state |
| nightStatus | String | 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 |
| fanSpeed | Integer | fan speed. 1~100 |
| battery | Integer | the current battery level |
| chargingStatus | String | battery charge status. charging or uncharged |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Candle Warmer Lamp |
| hubDeviceId | String | device's parent Hub ID |
| onlineStatus | String | the connection status of the device. online or offline |
| brightness | Integer | the brightness value, range from 1 to 100 |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| power | String | ON/OFF state |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. AI Hub |
| hubDeviceId | String | device's parent Hub ID |
| version | String | the current firmware version, e.g. V4.2 |
| onlineStatus | String | attributes of the context object. the connection status of the device. online or offline |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. Home Climate Panel |
| battery | Integer | the current battery level 0-100 |
| version | String | the current BLE and Wi-Fi firmware version, e.g. V3.1-6.3 |
| temperature | Float | temperature in celsius |
| humidity | Integer | humidity percentage |
| moveDetected | Boolean | determines if motion is detected |
| brightness | Integer | the brightness value, range from 1 to 100 |
| Key | Value Type | Description |
|---|
| deviceId | String | device ID |
| deviceType | String | device type. AI Art Frame |
| hubDeviceId | String | device's parent Hub ID |
| battery | Integer | the current battery level, 0-100 |
| displayMode | Integer | display mode: 0 = Static image; 1 = Slideshow |
| imageUrl | String | the URL of the image currently displayed on the photo frame |
| version | String | the current firmware version, e.g. V0.0-0.5 |
Request the status of a SwitchBot Thermometer and Hygrometer
Request
GET https://api.switch-bot.com/v1.1/devices/C271111EC0AB/status
Response
{
"statusCode": 100,
"body": {
"deviceId": "C271111EC0AB",
"deviceType": "Meter",
"hubDeviceId": "FA7310762361",
"humidity": 52,
"temperature": 26.1
},
"message": "success"
}
Request the status of a SwitchBot Curtain
Request
GET https://api.switch-bot.com/v1.1/devices/E2F6032048AB/status
Response
{
"statusCode": 100,
"body": {
"deviceId": "E2F6032048AB",
"deviceType": "Curtain",
"hubDeviceId": "FA7310762361",
"calibrate": true,
"group": false,
"moving": false,
"slidePosition": 0
},
"message": "success"
}
POST /v1.1/devices/{deviceId}/commands
Send control commands to physical devices and virtual infrared remote devices.
| deviceType | commandType | Command | command parameter | Description |
|---|
| Bot | command | turnOff | default | set to OFF state |
| Bot | command | turnOn | default | set to ON state |
| Bot | command | press | default | trigger press |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Curtain | command | setPosition | index0,mode0,position0
e.g. 0,ff,80 | mode: 0 (Performance Mode), 1 (Silent Mode), ff (default mode)
position: 0~100 (0 means open, 100 means closed) |
| Curtain | command | turnOff | default | equivalent to set position to 100 |
| Curtain | command | turnOn | default | equivalent to set position to 0 |
| Curtain | command | pause | default | set to PAUSE state |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Curtain 3 | command | setPosition | index0,mode0,position0
e.g. 0,ff,80 | mode: 0 (Performance Mode), 1 (Silent Mode), ff (default mode)
position: 0~100 (0 means open, 100 means closed) |
| Curtain 3 | command | turnOff | default | equivalent to set position to 100 |
| Curtain 3 | command | turnOn | default | equivalent to set position to 0 |
| Curtain 3 | command | pause | default | set to PAUSE state |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Lock | command | lock | default | rotate to locked position |
| Lock | command | unlock | default | rotate to unlocked position |
| Lock | command | deadbolt | default | disengage deadbolt or latch |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Lock Pro | command | lock | default | rotate to locked position |
| Lock Pro | command | unlock | default | rotate to unlocked position |
| Lock Pro | command | deadbolt | default | disengage deadbolt or latch |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Smart Lock Pro Wifi | command | lock | default | rotate to locked position |
| Smart Lock Pro Wifi | command | unlock | default | rotate to unlocked position |
| Smart Lock Pro Wifi | command | nightLatchUnlock | default | unlock night latch (EU) |
| Smart Lock Pro Wifi | command | deadbolt | default | disengage deadbolt or latch |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Lock Vision | command | lock | default | rotate to locked position |
| Lock Vision | command | unlock | default | rotate to unlocked position |
| Lock Vision | command | deleteKey | {"id": ""} | delete a passcode by id |
| Lock Vision | command | createKey | {"name":"","type":"","password":"","startTime":0,"endTime":0} | create a passcode |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Lock Vision Pro | command | lock | default | rotate to locked position |
| Lock Vision Pro | command | unlock | default | rotate to unlocked position |
| Lock Vision Pro | command | deleteKey | {"id": ""} | delete a passcode by id |
| Lock Vision Pro | command | createKey | {"name":"","type":"","password":"","startTime":0,"endTime":0} | create a passcode |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Humidifier | command | turnOff | default | set to OFF state |
| Humidifier | command | turnOn | default | set to ON state |
| Humidifier | command | setMode | auto or 101 or
102 or 103 or {0~100} | auto, set to Auto Mode,
101, set atomization efficiency to 34%,
102, set atomization efficiency to 67%,
103, set atomization efficiency to 100% |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Humidifier2 | command | turnOff | default | set to OFF state |
| Humidifier2 | command | turnOn | default | set to ON state |
| Humidifier2 | command | setMode | {"mode": mode_int, "targetHumidify": humidity_int} | set the mode. mode_int, 1, level 4; 2, level 3; 3, level 2; 4, level 1; 5, humidity mode; 6, sleep mode; 7, auto mode; 8, drying mode; targetHumidify, the target humidity level in percentage, 0~100. |
| Humidifier2 | command | setChildLock | true or false | enable or disable child lock. true, enable; false, disable |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Humidifier2 | command | turnOff | default | set to OFF state |
| Humidifier2 | command | turnOn | default | set to ON state |
| Humidifier2 | command | setMode | {"mode": mode_int, "targetHumidify": humidity_int} | set the mode. mode_int, 1, level 4; 2, level 3; 3, level 2; 4, level 1; 5, humidity mode; 6, sleep mode; 7, auto mode; 8, drying mode; targetHumidify, the target humidity level in percentage, 0~100. |
| Humidifier2 | command | setChildLock | true or false | enable or disable child lock. true, enable; false, disable |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Air Purifier VOC | command | turnOff | default | set to OFF state |
| Air Purifier VOC | command | turnOn | default | set to ON state |
| Air Purifier VOC | command | setMode | {"mode": mode_int, "fanGear": fan_level_int} | set the mode. mode_int, 1, normal or fan mode; 2, auto mode; 3, sleep mode; 4, pet mode; fan_level_int, the fan level can only be set if mode_int is set to 1, 1~3 |
| Air Purifier VOC | command | setChildLock | 0 or 1 | enable or disable child lock. 1, enable; 0, disable |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Air Purifier Table VOC | command | turnOff | default | set to OFF state |
| Air Purifier Table VOC | command | turnOn | default | set to ON state |
| Air Purifier Table VOC | command | setMode | {"mode": mode_int, "fanGear": fan_level_int} | set the mode. mode_int, 1, normal or fan mode; 2, auto mode; 3, sleep mode; 4, pet mode; fan_level_int, the fan level can only be set if mode_int is set to 1, 1~3 |
| Air Purifier Table VOC | command | setChildLock | 0 or 1 | enable or disable child lock. 1, enable; 0, disable |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Air Purifier PM2.5 | command | turnOff | default | set to OFF state |
| Air Purifier PM2.5 | command | turnOn | default | set to ON state |
| Air Purifier PM2.5 | command | setMode | {"mode": mode_int, "fanGear": fan_level_int} | set the mode. mode_int, 1, normal or fan mode; 2, auto mode; 3, sleep mode; 4, pet mode; fan_level_int, the fan level can only be set if mode_int is set to 1, 1~3 |
| Air Purifier PM2.5 | command | setChildLock | 0 or 1 | enable or disable child lock. 1, enable; 0, disable |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Air Purifier Table PM2.5 | command | turnOff | default | set to OFF state |
| Air Purifier Table PM2.5 | command | turnOn | default | set to ON state |
| Air Purifier Table PM2.5 | command | setMode | {"mode": mode_int, "fanGear": fan_level_int} | set the mode. mode_int, 1, normal or fan mode; 2, auto mode; 3, sleep mode; 4, pet mode; fan_level_int, the fan level can only be set if mode_int is set to 1, 1~3 |
| Air Purifier Table PM2.5 | command | setChildLock | 0 or 1 | enable or disable child lock. 1, enable; 0, disable |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Plug | command | turnOn | default | set to ON state |
| Plug | command | turnOff | default | set to OFF state |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Plug Mini (US) | command | turnOn | default | set to ON state |
| Plug Mini (US) | command | turnOff | default | set to OFF state |
| Plug Mini (US) | command | toggle | default | toggle state |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Plug Mini (JP) | command | turnOn | default | set to ON state |
| Plug Mini (JP) | command | turnOff | default | set to OFF state |
| Plug Mini (JP) | command | toggle | default | toggle state |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Plug Mini (EU) | command | turnOn | default | set to ON state |
| Plug Mini (EU) | command | turnOff | default | set to OFF state |
| Plug Mini (EU) | command | toggle | default | toggle state |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Relay Switch 1PM | command | turnOn | default | set to ON state |
| Relay Switch 1PM | command | turnOff | default | set to OFF state |
| Relay Switch 1PM | command | toggle | default | toggle state |
| Relay Switch 1PM | command | setMode | 0~3 | set the switch mode. 0, toggle mode; 1, edge switch mode; 2, detached switch mode; 3, momentary switch mode |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Relay Switch 1 | command | turnOn | default | set to ON state |
| Relay Switch 1 | command | turnOff | default | set to OFF state |
| Relay Switch 1 | command | toggle | default | toggle state |
| Relay Switch 1 | command | setMode | 0~3 | set the switch mode. 0, toggle mode; 1, edge switch mode; 2, detached switch mode; 3, momentary switch mode |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Relay Switch 2PM | command | turnOn | “1”or"2" | set to ON state 1 represents channel 1 2 represents channel 2 |
| Relay Switch 2PM | command | turnOff | “1”or"2" | set to OFF state 1 represents channel 1 2 represents channel 2 |
| Relay Switch 2PM | command | toggle | “1”or"2" | toggle 1 represents channel 1 2 represents channel 2state |
| Relay Switch 2PM | command | setMode | channel;mode
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 |
| Relay Switch 2PM | command | setPosition | 0~100 | Set roller blind opening and closing percentage. 0, Open All; 100, Close All |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Garage Door Opener | command | turnOn | default | set to ON state |
| Garage Door Opener | command | turnOff | default | set to OFF state |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Floor Lamp | command | turnOn | default | set to ON state |
| Floor Lamp | command | turnOff | default | set to OFF state |
| Floor Lamp | command | toggle | default | toggle state |
| Floor Lamp | command | setBrightness | {0-100} | set brightness |
| Floor Lamp | command | setColor | "{0-255}:{0-255}:{0-255}" | set RGB color value |
| Floor Lamp | command | setColorTemperature | {2700-6500} | set color temperature |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Strip Light 3 | command | turnOn | default | set to ON state |
| Strip Light 3 | command | turnOff | default | set to OFF state |
| Strip Light 3 | command | toggle | default | toggle state |
| Strip Light 3 | command | setBrightness | {0-100} | set brightness |
| Strip Light 3 | command | setColor | "{0-255}:{0-255}:{0-255}" | set RGB color value |
| Strip Light 3 | command | setColorTemperature | {2700-6500} | set color temperature |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Lock Lite | command | lock | default | rotate to locked position |
| Lock Lite | command | unlock | default | rotate to unlocked position |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Lock Ultra | command | lock | default | rotate to locked position |
| Lock Ultra | command | unlock | default | rotate to unlocked position |
| Lock Ultra | command | deadbolt | default | disengage deadbolt or latch |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Video Doorbell | command | enableMotionDetection | default | Set to enabled state |
| Video Doorbell | command | disableMotionDetection | default | Set to disabled state |
The control commands for this product work differently than the other products. Due to security concerns, the passcodes are stored locally. This mechanism dramatically prolongs the time needed to successfully create a passcode and get the correct result through the Web API. Hence, the actual results of the following commands are returned from the SwitchBot server asynchronously and are delivered through a webhook.
You need to configure a webhook to receive the correct result. Refer to this product's webhook definition.
| deviceType | commandType | Command | command parameter | Description |
|---|
| Keypad Vision | command | createKey | { "name": passcode _name_str, "type": passcode_type_str, "password": passcode_str, "startTime": valid_from_long, "endTime": valid_to_long } | create a new passcode |
| Keypad Vision | command | deleteKey | { "id": passcode_id_int } | delete an existing passcode |
The following table describes the parameter object for createKey,
| Key Name | Value Type | Description |
|---|
| name | String | a unique name for the passcode. duplicates under the same device are not allowed. |
| type | String | type of the passcode. permanent, a permanent passcode. timeLimit, a temporary passcode. disposable, a one-time passcode. urgent, an emergency passcode. |
| password | String | a 6 to 12-digit passcode in plain text |
| startTime | Long | set the time the passcode becomes valid from, mandatory for one-time passcode and temporary passcode. a 10-digit timestamp. |
| endTime | Long | set the time the passcode becomes expired, mandatory for one-time passcode and temporary passcode. a 10-digit timestamp. |
The following table describes the parameter object for deleteKey,
| Key Name | Value Type | Description |
|---|
| id | String | the id of the passcode |
The control commands for this product work differently than the other products. Due to security concerns, the passcodes are stored locally. This mechanism dramatically prolongs the time needed to successfully create a passcode and get the correct result through the Web API. Hence, the actual results of the following commands are returned from the SwitchBot server asynchronously and are delivered through a webhook.
You need to configure a webhook to receive the correct result. Refer to this product's webhook definition.
| deviceType | commandType | Command | command parameter | Description |
|---|
| Keypad Vision Pro | command | createKey | { "name": passcode _name_str, "type": passcode_type_str, "password": passcode_str, "startTime": valid_from_long, "endTime": valid_to_long } | create a new passcode |
| Keypad Vision Pro | command | deleteKey | { "id": passcode_id_int } | delete an existing passcode |
The following table describes the parameter object for createKey,
| Key Name | Value Type | Description |
|---|
| name | String | a unique name for the passcode. duplicates under the same device are not allowed. |
| type | String | type of the passcode. permanent, a permanent passcode. timeLimit, a temporary passcode. disposable, a one-time passcode. urgent, an emergency passcode. |
| password | String | a 6 to 12-digit passcode in plain text |
| startTime | Long | set the time the passcode becomes valid from, mandatory for one-time passcode and temporary passcode. a 10-digit timestamp. |
| endTime | Long | set the time the passcode becomes expired, mandatory for one-time passcode and temporary passcode. a 10-digit timestamp. |
The following table describes the parameter object for deleteKey,
| Key Name | Value Type | Description |
|---|
| id | String | the id of the passcode |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Color Bulb | command | turnOn | default | set to ON state |
| Color Bulb | command | turnOff | default | set to OFF state |
| Color Bulb | command | toggle | default | toggle state |
| Color Bulb | command | setBrightness | {1-100} | set brightness |
| Color Bulb | command | setColor | "{0-255}:{0-255}:{0-255}" | set RGB color value |
| Color Bulb | command | setColorTemperature | {2700-6500} | set color temperature |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Strip Light | command | turnOn | default | set to ON state |
| Strip Light | command | turnOff | default | set to OFF state |
| Strip Light | command | toggle | default | toggle state |
| Strip Light | command | setBrightness | {1-100} | set brightness |
| Strip Light | command | setColor | "{0-255}:{0-255}:{0-255}" | set RGB color value |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Robot Vacuum Cleaner S1 | command | start | default | start vacuuming |
| Robot Vacuum Cleaner S1 | command | stop | default | stop vacuuming |
| Robot Vacuum Cleaner S1 | command | dock | default | return to charging dock |
| Robot Vacuum Cleaner S1 | command | PowLevel | {0-3} | set suction power level: 0 (Quiet), 1 (Standard), 2 (Strong), 3 (MAX) |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Robot Vacuum Cleaner S1 Plus | command | start | default | start vacuuming |
| Robot Vacuum Cleaner S1 Plus | command | stop | default | stop vacuuming |
| Robot Vacuum Cleaner S1 Plus | command | dock | default | return to charging dock |
| Robot Vacuum Cleaner S1 Plus | command | PowLevel | {0-3} | set suction power level: 0 (Quiet), 1 (Standard), 2 (Strong), 3 (MAX) |
| deviceType | commandType | Command | command parameter | Description |
|---|
| K10+ | command | start | default | start vacuuming |
| K10+ | command | stop | default | stop vacuuming |
| K10+ | command | dock | default | return to charging dock |
| K10+ | command | PowLevel | {0-3} | set suction power level: 0 (Quiet), 1 (Standard), 2 (Strong), 3 (MAX) |
| deviceType | commandType | Command | command parameter | Description |
|---|
| K10+ Pro | command | start | default | start vacuuming |
| K10+ Pro | command | stop | default | stop vacuuming |
| K10+ Pro | command | dock | default | return to charging dock |
| K10+ Pro | command | PowLevel | {0-3} | set suction power level: 0 (Quiet), 1 (Standard), 2 (Strong), 3 (MAX) |
| deviceType | commandType | Command | command parameter | Description |
|---|
| K20+ Pro | command | startClean | {"action": action_str, "param": {"fanLevel": fan_level_int, "times": clean_cycle_int}} | start cleaning.
action_str, the cleaning mode, sweep or mop.
fanLevel, the vacuum level, 1-4.
times, the number of cycles, 1-2639999, in theory. |
| K20+ Pro | command | pause | default | pause cleaning |
| K20+ Pro | command | dock | default | return to charging dock |
| K20+ Pro | command | setVolume | {0-100} | set the robot volume |
| K20+ Pro | 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. |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Robot Vacuum Cleaner K10+ Pro Combo | command | startClean | {"action": action_str, "param": {"fanLevel": fan_level_int, "times": clean_cycle_int}} | start cleaning.
action_str, the cleaning mode, sweep or mop.
fanLevel, the vacuum level, 1-4.
times, the number of cycles, 1-2639999, in theory. |
| Robot Vacuum Cleaner K10+ Pro Combo | command | pause | default | pause cleaning |
| Robot Vacuum Cleaner K10+ Pro Combo | command | dock | default | return to charging dock |
| Robot Vacuum Cleaner K10+ Pro Combo | command | setVolume | {0-100} | set the robot volume |
| 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. |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Floor Cleaning Robot S10 | command | startClean | {"action": clean_mode_str, "param": {"fanLevel": fan_level_int, "waterLevel": water_level_int, "times": clean_cycle_int}} | start cleaning.
action, the cleaning mode, sweep or sweep_mop.
fanLevel, the vacuum level, 1-4.
waterLevel, the mop moisture level, 1-2.
times, the number of cycles, 1-2639999, in theory. |
| Floor Cleaning Robot S10 | command | addWaterForHumi | default | refill the mind blowing Evaporative Humidifier (Auto-refill). |
| Floor Cleaning Robot S10 | command | pause | default | pause. |
| Floor Cleaning Robot S10 | command | dock | default | return to Auto-empty Station and charge. |
| Floor Cleaning Robot S10 | command | setVolume | 0-100 | set volume, 1-100 |
| Floor Cleaning Robot S10 | command | selfClean | 1 or 2 or 3 | mode 1, wash the mop.
mode 2, dry itself.
mode 3, terminate. |
| Floor Cleaning Robot S10 | command | changeParam | {"fanLevel": fan_level_int, "waterLevel": water_level_int, "times": clean_cycle_int} | fanLevel, the vacuum level, 1-4.
waterLevel, the mop moisture level, 1-2.
times, the number of cycles, 1-2639999, in theory. |
| deviceType | commandType | Command | command parameter | Description |
|---|
| S20 | command | startClean | {"action": clean_mode_str, "param": {"fanLevel": fan_level_int, "waterLevel": water_level_int, "times": clean_cycle_int}} | start cleaning.
action, the cleaning mode, sweep or sweep_mop.
fanLevel, the vacuum level, 1-4.
waterLevel, the mop moisture level, 1-2.
times, the number of cycles, 1-2639999, in theory. |
| S20 | command | addWaterForHumi | default | refill the mind blowing Evaporative Humidifier (Auto-refill). |
| S20 | command | pause | default | pause. |
| S20 | command | dock | default | return to Auto-empty Station and charge. |
| S20 | command | setVolume | 0-100 | set volume, 1-100 |
| S20 | command | selfClean | 1 or 2 or 3 | mode 1, wash the mop.
mode 2, dry itself.
mode 3, terminate. |
| S20 | command | changeParam | {"fanLevel": fan_level_int, "waterLevel": water_level_int, "times": clean_cycle_int} | fanLevel, the vacuum level, 1-4.
waterLevel, the mop moisture level, 1-2.
times, the number of cycles, 1-2639999, in theory. |
| deviceType | commandType | Command | command parameter | Description |
|---|
| K11+ | command | startClean | {"action": action_str, "param": {"fanLevel": fan_level_int, "times": clean_cycle_int}} | start cleaning.
action_str, the cleaning mode, sweep or mop.
fanLevel, the vacuum level, 1-4.
times, the number of cycles, 1-2639999, in theory. |
| K11+ | command | pause | default | pause. |
| K11+ | command | dock | default | return to Auto-empty Station and charge. |
| K11+ | command | setVolume | 0-100 | set volume, 1-100 |
| K11+ | command | changeParam | {"fanLevel": fan_level_int, "waterLevel": water_level_int, "times": clean_cycle_int} | fanLevel, the vacuum level, 1-4.
waterLevel, the mop moisture level, 1-2.
times, the number of cycles, 1-2639999, in theory. |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Ceiling Light | command | turnOn | default | set to ON state |
| Ceiling Light | command | turnOff | default | set to OFF state |
| Ceiling Light | command | toggle | default | toggle state |
| Ceiling Light | command | setBrightness | {1-100} | set brightness |
| Ceiling Light | command | setColorTemperature | {2700-6500} | set the color temperature |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Ceiling Light Pro | command | turnOn | default | set to ON state |
| Ceiling Light Pro | command | turnOff | default | set to OFF state |
| Ceiling Light Pro | command | toggle | default | toggle state |
| Ceiling Light Pro | command | setBrightness | {1-100} | set brightness |
| Ceiling Light Pro | command | setColorTemperature | {2700-6500} | set the color temperature |
| deviceType | commandType | Command | command parameter | Description |
|---|
| RGBICWW Strip Light | command | turnOn | default | set to ON state |
| RGBICWW Strip Light | command | turnOff | default | set to OFF state |
| RGBICWW Strip Light | command | toggle | default | toggle state |
| RGBICWW Strip Light | command | setBrightness | {0-100} | set brightness |
| RGBICWW Strip Light | command | setColorTemperature | {2700-6500} | set color temperature |
| RGBICWW Strip Light | command | setColor | "{0-255}:{0-255}:{0-255}" | set RGB color value |
| deviceType | commandType | Command | command parameter | Description |
|---|
| RGBICWW Floor Lamp | command | turnOn | default | set to ON state |
| RGBICWW Floor Lamp | command | turnOff | default | set to OFF state |
| RGBICWW Floor Lamp | command | toggle | default | toggle state |
| RGBICWW Floor Lamp | command | setBrightness | {0-100} | set brightness |
| RGBICWW Floor Lamp | command | setColorTemperature | {2700-6500} | set color temperature |
| RGBICWW Floor Lamp | command | setColor | "{0-255}:{0-255}:{0-255}" | set RGB color value |
| deviceType | commandType | Command | command parameter | Description |
|---|
| RGBIC Neon Wire Rope Light | command | turnOn | default | set to ON state |
| RGBIC Neon Wire Rope Light | command | turnOff | default | set to OFF state |
| RGBIC Neon Wire Rope Light | command | toggle | default | toggle state |
| RGBIC Neon Wire Rope Light | command | setBrightness | {0-100} | set brightness |
| RGBIC Neon Wire Rope Light | command | setColor | "{0-255}:{0-255}:{0-255}" | set RGB color value |
| deviceType | commandType | Command | command parameter | Description |
|---|
| RGBIC Neon Rope Light | command | turnOn | default | set to ON state |
| RGBIC Neon Rope Light | command | turnOff | default | set to OFF state |
| RGBIC Neon Rope Light | command | toggle | default | toggle state |
| RGBIC Neon Rope Light | command | setBrightness | {0-100} | set brightness |
| RGBIC Neon Rope Light | command | setColor | "{0-255}:{0-255}:{0-255}" | set RGB color value |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Smart Radiator Thermostat | command | turnOn | default | set to ON state |
| Smart Radiator Thermostat | command | turnOff | default | set to OFF state |
| Smart Radiator Thermostat | command | setMode | 0~5 | set the switch mode. 0,0, schedule mode; 1,manual mode; 2, power off mode; 3, energy saving mode; 4, comfort mode;5, quick heating mode |
| Smart Radiator Thermostat | command | setManualModeTemperature | 4~35 | set the radiator thermostat temperature. Temperature range: 4–35 °C (inclusive) |
The control commands for this product work differently than the other products. Due to security concerns, the passcodes are stored locally. This mechanism dramatically prolongs the time needed to successfully create a passcode and get the correct result through the Web API. Hence, the actual results of the following commands are returned from the SwitchBot server asynchronously and are delivered through a webhook.
You need to configure a webhook to receive the correct result. Refer to this product's webhook definition.
| deviceType | commandType | Command | command parameter | Description |
|---|
| Keypad | command | createKey | { "name": passcode _name_str, "type": passcode_type_str, "password": passcode_str, "startTime": valid_from_long, "endTime": valid_to_long } | create a new passcode |
| Keypad | command | deleteKey | { "id": passcode_id_int } | delete an existing passcode |
The following table describes the parameter object for createKey,
| Key Name | Value Type | Description |
|---|
| name | String | a unique name for the passcode. duplicates under the same device are not allowed. |
| type | String | type of the passcode. permanent, a permanent passcode. timeLimit, a temporary passcode. disposable, a one-time passcode. urgent, an emergency passcode. |
| password | String | a 6 to 12-digit passcode in plain text |
| startTime | Long | set the time the passcode becomes valid from, mandatory for one-time passcode and temporary passcode. a 10-digit timestamp. |
| endTime | Long | set the time the passcode becomes expired, mandatory for one-time passcode and temporary passcode. a 10-digit timestamp. |
The following table describes the parameter object for deleteKey,
| Key Name | Value Type | Description |
|---|
| id | String | the id of the passcode |
The control commands for this product work differently than the other products. Due to security concerns, the passcodes are stored locally. This mechanism dramatically prolongs the time needed to successfully create a passcode and get the correct result through the Web API. Hence, the actual results of the following commands are returned from the SwitchBot server asynchronously and are delivered through a webhook.
You need to configure a webhook to receive the correct result. Refer to this product's webhook definition.
| deviceType | commandType | Command | command parameter | Description |
|---|
| Keypad Touch | command | createKey | { "name": passcode _name_str, "type": passcode_type_str, "password": passcode_str, "startTime": valid_from_long, "endTime": valid_to_long } | create a new passcode |
| Keypad Touch | command | deleteKey | { "id": passcode_id_int } | delete an existing passcode |
The following table describes the parameter object for createKey,
| Key Name | Value Type | Description |
|---|
| name | String | a unique name for the passcode. duplicates under the same device are not allowed. |
| type | String | type of the passcode. permanent, a permanent passcode. timeLimit, a temporary passcode. disposable, a one-time passcode. urgent, an emergency passcode. |
| password | String | a 6 to 12-digit passcode in plain text |
| startTime | Long | set the time the passcode becomes valid from, mandatory for one-time passcode and temporary passcode. a 10-digit timestamp. |
| endTime | Long | set the time the passcode becomes expired, mandatory for one-time passcode and temporary passcode. a 10-digit timestamp. |
The following table describes the parameter object for deleteKey,
| Key Name | Value Type | Description |
|---|
| id | String | the id of the passcode |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Blind Tilt | command | setPosition | direction;position
e.g. up;60 | direction: up/down
position: 0~100 (0 means closed, 100 means open, it MUST be set to a multiple of 2. e.g. up;48 or up; 36) |
| Blind Tilt | command | fullyOpen | default | Set the position of Blind Tilt to open, equivalent to setting the position to up;100 or down;100 |
| Blind Tilt | command | closeUp | default | Set the position of Blind Tilt to closed up, equivalent to setting the position to up;0 |
| Blind Tilt | command | closeDown | default | Set the position of Blind Tilt to closed down, equivalent to setting the position to down;0 |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Roller Shade | command | setPosition | 0~100 | 0, open; 100, closed |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Battery Circulator Fan | command | turnOff | default | Set to OFF state |
| Battery Circulator Fan | command | turnOn | default | Set to ON state |
| Battery Circulator Fan | command | setNightLightMode | off, 1, or 2 | off, turn off nightlight,
1, bright
2, dim |
| Battery Circulator Fan | command | setWindMode | direct, natural, sleep, or baby | Set fan mode. direct: direct mode. natural: natural mode. sleep: sleep mode. baby: ultra quiet mode |
| Battery Circulator Fan | command | setWindSpeed | {1-100} e.g. 10 | Set fan speed.1~100 |
| Battery Circulator Fann | command | closeDelay | {1-36000} e.g. 10 | Set fan close time |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Circulator Fan | command | turnOff | default | Set to OFF state |
| Circulator Fan | command | turnOn | default | Set to ON state |
| Circulator Fan | command | setNightLightMode | off, 1, or 2 | off, turn off nightlight,
1, bright
2, dim |
| Circulator Fan | command | setWindMode | direct, natural, sleep, or baby | Set fan mode. direct: direct mode. natural: natural mode. sleep: sleep mode. baby: ultra quiet mode |
| Circulator Fan | command | setWindSpeed | {1-100} e.g. 10 | Set fan speed.1~100 |
| Circulator Fann | command | closeDelay | {1-36000} e.g. 10 | Set fan close time |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Standing Circulator Fan | command | turnOff | default | Set to OFF state |
| Standing Circulator Fan | command | turnOn | default | Set to ON state |
| Standing Circulator Fan | command | setNightLightMode | off, 1, or 2 | off, turn off nightlight,
1, bright
2, dim |
| Standing Circulator Fan | command | setWindMode | direct, natural, sleep, or baby | Set fan mode. direct: direct mode. natural: natural mode. sleep: sleep mode. baby: ultra quiet mode |
| Standing Circulator Fan | command | setWindSpeed | {1-100} e.g. 10 | Set fan speed.1~100 |
| Standing Circulator Fann | command | closeDelay | {1-36000} e.g. 10 | Set fan close time |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Candle Warmer Lamp | command | turnOn | default | set to ON state |
| Candle Warmer Lamp | command | turnOff | default | set to OFF state |
| Candle Warmer Lamp | command | toggle | default | toggle state |
| Candle Warmer Lamp | command | setBrightness | {0-100} | set brightness |
| deviceType | commandType | Command | command parameter | Description |
|---|
| AI Art Frame | command | next | default | Switch to the next image |
| AI Art Frame | command | previous | default | Switch to the previous image |
| AI Art Frame | command | uploadImage | {"imageUrl":"https://..."} OR {"imageBase64":"data:image/jpeg;base64,..."} | Upload an image (choose one of imageUrl / imageBase64) |
| deviceType | commandType | Command | command parameter | Description |
|---|
| Weather Station | command | customQuote | custom text, e.g. "Oh sea, you have so much water!" | Set a custom quote |
| Weather Station | command | cancelCustom | default | Cancel the custom quote and revert to default |
| Weather Station | command | customPage | custom text, e.g. "Oh, the ocean is so huge!" | Set a custom quote |
The table below describes all the available commands for virtual infrared remote devices,
| deviceType | commandType | Command | command parameter | Description |
|---|
| All home appliance types except Others | command | turnOn | default | every home appliance can be turned on by default |
| All home appliance types except Others | command | turnOff | default | every home appliance can be turned off by default |
| Others | customize | {user-defined button name} | default | all user-defined buttons must be configured with commandType=customize |
| Air Conditioner | command | setAll | {temperature},{mode},{fan speed},{power state}
e.g. 26,1,3,on | the unit of temperature is in celsius;
modes include 0/1 (auto), 2 (cool), 3 (dry), 4 (fan), 5 (heat);
fan speed includes 1 (auto), 2 (low), 3 (medium), 4 (high);
power state includes on and off |
| | | | |
| TV, IPTV/Streamer, Set Top Box | command | SetChannel | {channel number}, e.g. 15 | set the TV channel to switch to |
| command | volumeAdd | default | volume up |
| command | volumeSub | default | volume down |
| command | channelAdd | default | next channel |
| command | channelSub | default | previous channel |
| DVD, Speaker | command | setMute | default | mute/unmute |
| command | FastForward | default | fast forward |
| command | Rewind | default | rewind |
| command | Next | default | next track |
| command | Previous | default | last track |
| command | Pause | default | pause |
| command | Play | default | play/resume |
| command | Stop | default | stop |
| Speaker | command | volumeAdd | default | volume up |
| command | volumeSub | default | volume down |
| Fan | command | swing | default | swing |
| command | timer | default | set timer |
| command | lowSpeed | default | set fan speed to low |
| command | middleSpeed | default | set fan speed to medium |
| command | highSpeed | default | set fan speed to high |
| Light | command | brightnessUp | default | brightness up |
| command | brightnessDown | default | brightness down |
Note: Most of the devices support turnOn or turnOff, which are case-sensitive. For infrared remote devices, when you have created customized buttons, you must set commandType to customize, otherwise the command will not work. command needs to be set to the name of the customized button.
| Name | Type | Required | Description |
|---|
| deviceId | String | Yes | device ID |
| Name | Type | Required | Description |
|---|
| command | String | Yes | the name of the command |
| parameter | String | No | some commands require parameters, such as SetChannel |
| commandType | String | No | for customized buttons, this needs to be set to customzie |
lig
The response is basically a JSON object, which contains the following properties,
| Key Name | Value Type |
|---|
| statusCode | Integer |
| message | String |
| body | Object |
| Error code/message | Description |
|---|
| {"message": "Unauthorized"} | Http 401 Error. User permission is denied due to invalid token. |
| 151 | device type error |
| 152 | device not found |
| 160 | command is not supported |
| 161 | device offline |
| 171 | hub device is offline |
| 190 | Device internal error due to device states not synchronized with server. Or command format is invalid. |
Clean with vacuum mode
Request
POST https://api.switch-bot.com/v1.1/devices/F7538E1ABC23/commands
{
"commandType": "command",
"command": "startClean", // start cleaning
"parameter": {
"action": "sweep", // clean with vacuum mode
"param": {
"fanLevel": 1, // vacuum level set to 1
"waterLevel": 1, // mop moisture level set to 1
"times": 1 // number of cyclyes to clean set to 1
}
}
}
Response
{
"statusCode": 100,
"body": {
"commandId": "CMD166444044923602"
},
"message": "success"
}
Change the cleaning settings
Request
POST https://api.switch-bot.com/v1.1/devices/F7538E1ABC23/commands
{
"commandType": "command",
"command": "changeParam",
"parameter": {
"fanLevel": 2, // vacuum level set to 1
"waterLevel": 1, // mop moisture level set to 1
"times": 1 // number of times to clean set to 2
}
}
Response
{
"statusCode": 100,
"body": {
"commandId": "CMD166444044923602"
},
"message": "success"
}
Create a temporary passcode
Request
POST https://api.switch-bot.com/v1.1/devices/F7538E1ABCEB/commands
{
"commandType": "command",
"command": "createKey",
"parameter": {
"name": "Guest Code",
"type": "timeLimit",
"password": "12345678",
"startTime": 1664640056,
"endTime": 1665331432
}
}
Response
{
"statusCode": 100,
"body": {
"commandId": "CMD166444044923602"
},
"message": "success"
}
Turn a Bot on
Request
POST https://api.switch-bot.com/v1.1/devices/210/commands
{
"command": "turnOn",
"parameter": "default",
"commandType": "command"
}
Response
{
"statusCode": 100,
"body": {},
"message": "success"
}
Set the color value of a Color Bulb
Request
POST https://api.switch-bot.com/v1.1/devices/84F70353A411/commands
{
"command": "setColor",
"parameter": "122:80:20", // yellow
"commandType": "command"
}
Response
{
"statusCode": 100,
"body": {},
"message": "success"
}
Set an Air Conditioner
Request
POST https://api.switch-bot.com/v1.1/devices/02-202007201626-70/commands
{
"command": "setAll",
"parameter": "26,1,3,on",
"commandType": "command"
}
Response
{
"statusCode": 100,
"body": {},
"message": "success"
}
Trigger a customized button
Request
POST https://api.switch-bot.com/v1.1/devices/02-202007201626-10/commands
{
"command": "ボタン", // the name of the customized button
"parameter": "default",
"commandType": "customize"
}
Response
{
"statusCode": 100,
"body": {},
"message": "success"
}
The scenes API is used to access the smart scenes created by a user and to execute manual scenes.
GET /v1.1/scenes
Get a list of manual scenes created by the current user.
The response is basically a JSON object, which contains the following properties,
| Key Name | Value Type |
|---|
| statusCode | Integer |
| message | String |
| body | Object |
The body object contains a list of objects, which has the following properties,
| Key | Type | Description |
|---|
| sceneId | String | a scene's ID |
| sceneName | String | a scene's name |
| Error code/message | Description |
|---|
| {"message": "Unauthorized"} | Http 401 Error. User permission is denied due to invalid token. |
| 190 | Device internal error due to device states not synchronized with server |
Request
GET https://api.switch-bot.com/v1.1/scenes
Response
{
"statusCode": 100,
"body": [
{
"sceneId": "T02-20200804130110",
"sceneName": "Close Office Devices"
},
{
"sceneId": "T02-202009221414-48924101",
"sceneName": "Set Office AC to 25"
},
{
"sceneId": "T02-202011051830-39363561",
"sceneName": "Set Bedroom to 24"
},
{
"sceneId": "T02-202011051831-82928991",
"sceneName": "Turn off home devices"
},
{
"sceneId": "T02-202011062059-26364981",
"sceneName": "Set Bedroom to 26 degree"
}
],
"message": "success"
}
POST /v1.1/scenes/{sceneId}/execute
Sends a request to execute a manual scene.
| Name | Type | Required | Description |
|---|
| sceneId | String | Yes | scene ID |
The response is basically a JSON object, which contains the following properties,
| Key Name | Value Type |
|---|
| statusCode | Integer |
| message | String |
| body | Object |
| Error code/message | Description |
|---|
| {"message": "Unauthorized"} | Http 401 Error. User permission is denied due to invalid token. |
| 190 | Device internal error due to device states not synchronized with server |
Request
POST https://api.switch-bot.com/v1.1/scenes/T02-202009221414-48924101/execute
Response
{
"statusCode": 100,
"body": {},
"message": "success"
}
Configure the url that all the webhook events will be sent to
POST https://api.switch-bot.com/v1.1/webhook/setupWebhook
| Key Name | Value Type | Description |
|---|
| action | String | the type of actions |
| url | String | the url where all the events are sent to |
| deviceList | String | the list of device ids, currently only supports "ALL" |
Head
{
"Content-type":"application/json",
"Authorization":your_token // enter your API token
}
Body
{
"action":"setupWebhook",
"url":url1, // enter your url
"deviceList":"ALL"
}
Sample
{
"statusCode": 100,
"body": {},
"message": ""
}
Get the current configuration info of the webhook
POST https://api.switch-bot.com/v1.1/webhook/queryWebhook
| Key Name | Value Type | Description |
|---|
| action | String | the type of actions, currently supports "queryUrl", "queryDetails" |
| url | String | the url where all the events are sent to. you need to specify the url when using queryDetails |
Head
{
"Content-type":"application/json",
"Authorization":your_token // enter your API token
}
Body
{
"action": "queryUrl"
}
Head
{
"Content-type":"application/json",
"Authorization":your_token // enter your API token
}
Body
{
"action": "queryDetails",
"urls":[url1] // get infos of a url
}
{
"statusCode": 100,
"body": {
"urls": [url1] // the target url
},
"message": ""
}
{
"statusCode": 100,
"body": [
{
"url":url1,
"createTime":123456,
"lastUpdateTime":123456,
"deviceList": "ALL",
"enable":true
}
],
"message": ""
}
Update the configuration of the webhook
POST https://api.switch-bot.com/v1.1/webhook/updateWebhook
| Key Name | Value Type | Description |
|---|
| action | String | the type of actions |
| config | Object | the configuration details you want to update. you can change the current url or enable/disable the webhook. refer to the example below |
Head
{
"Content-type":"application/json",
"Authorization":your_token // enter your API token
}
Body
{
"action": "updateWebhook",
"config":{
"url":url1,
"enable":true
}
}
{
"statusCode": 100,
"body": {},
"message": ""
}
Delete the configuration of the webhook
POST https://api.switch-bot.com/v1.1/webhook/deleteWebhook
| Key Name | Value Type | Description |
|---|
| action | String | the type of actions |
| url | String | the url where all the events are sent to |
Head
{
"Content-type":"application/json",
"Authorization":your_token // enter your API token
}
Body
{
"action": "deleteWebhook",
"url":url1
}
{
"statusCode": 100,
"body": {},
"message": ""
}
When an event gets triggered, SwitchBot server will send a POST request to the url you have configured. Refer to the table below for a list of products that support webhook.
| Device Type | Product |
|---|
| WoHand | Bot |
| WoCurtain | Curtain |
| WoPresence | Motion Sensor |
| WoContact | Contact Sensor |
| WoLock | Lock |
| WoLockPro | Lock Pro |
| WoLock Pro Matter Enabled | Lock Pro Matter Enabled |
| WoCamera | Indoor Cam |
| WoPanTiltCam | Pan/Tilt Cam |
| WoBulb | Color Bulb |
| WoStrip | LED Strip Light |
| WoPlugUS | Plug Mini (US) |
| WoPlugJP | Plug Mini (JP) |
| WoPlugEU | Plug Mini (EU) |
| WoMeter | Meter |
| WoMeterPlus | Meter Plus |
| WoIOSensor | Outdoor Meter |
| WoSweeper | Robot Vacuum Cleaner S1 |
| WoSweeperPlus | Robot Vacuum Cleaner S1 Plus |
| WoCeiling | Ceiling Light |
| WoCeilingPro | Ceiling Light Pro |
| WoKeypad | Keypad |
| WoKeypadTouch | Keypad Touch |
| WoHub2 | Hub 2 |
| WoHub3 | Hub 3 |
| Robot Vacuum Cleaner S10 | Floor Cleaning Robot S10 |
| Water Detector | Water Leak Detector |
| MeterPro | Meter Pro |
| MeterPro(CO2) | Meter Pro CO2 Monitor |
| WoFan2 | Battery Circulator Fan or Circulator Fan |
| Humidifier2 | Evaporative Humidifier or Evaporative Humidifier (Auto-refill) |
| Robot Vacuum Cleaner K10+ Pro Combo | K10+ Pro Combo |
| Air Purifier VOC | Air Purifier VOC |
| Air Purifier Table VOC | Air Purifier Table VOC |
| Air Purifier PM2.5 | Air Purifier PM2.5 |
| Air Purifier Table PM2.5 | Air Purifier Table PM2.5 |
| WoRollerShade | Roller Shade |
| Relay Switch 1PM | Relay Switch 1PM |
| Relay Switch 1 | Relay Switch 1 |
| Relay Switch 2PM | Relay Switch 2PM |
| Garage Door Opener | Garage Door Opener |
| Floor Lamp | Floor Lamp |
| Lock Lite | Lock Lite |
| Video Doorbell | Video Doorbell |
| Keypad Vision | Keypad Vision |
| Keypad Vision Pro | Keypad Vision Pro |
| Lock Ultra | Lock Ultra |
| Lock Vision | Lock Vision |
| Lock Vision Pro | Lock Vision Pro |
| Strip Light 3 | Strip Light 3 |
| K20+ Pro | K20+ Pro |
| RGBICWW Strip Light | RGBICWW Strip Light |
| RGBICWW Floor Lamp | RGBICWW Floor Lamp |
| RGBIC Neon Rope Light | RGBIC Neon Rope Light |
| RGBIC Neon Wire Rope Light | RGBIC Neon Wire Rope Light |
| Smart Radiator Thermostat | Smart Radiator Thermostat |
| Standing Fan | Standing Circulator Fan |
| climate Panel | Home Climate Panel |
| AI Art Frame | AI Art Frame |
| Presence Sensor | Presence Sensor |
| Candle Warmer Lamp | Candle Warmer Lamp |
| WeatherStation | Weather Station |
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| power | String | the current state of the device. This state is only valid for Switch Mode, where "on" stands for on and "off" stands for off. It will return "on" or "off" in Press Mode or Customize Mode, but the returned value can be neglected. |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoHand",
"deviceMac": DEVICE_MAC_ADDR,
"power": "on",//"on"or"off"
"battery": 10,
"deviceMode": "pressMode",//pressMode,switchMode,customizeMode
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| calibrate | Boolean | determines if the open position and the close position of a device have been properly calibrated or not |
| group | Boolean | determines if a Curtain is paired with or grouped with another Curtain or not |
| slidePosition | Integer | the percentage of the distance between the calibrated open position and closed position that Curtain has traversed |
| battery | Integer | the battery level of a Curtain |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoCurtain",
"deviceMac": DEVICE_MAC_ADDR,
"calibrate":false,
"group":false,
"slidePosition":50, //0~100
"battery":100,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| calibrate | Boolean | determines if the open position and the close position of a device have been properly calibrated or not |
| group | Boolean | determines if a Curtain is paired with or grouped with another Curtain or not |
| slidePosition | Integer | the percentage of the distance between the calibrated open position and closed position that Curtain has traversed |
| battery | Integer | the battery level of a Curtain |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoCurtain3",
"deviceMac": DEVICE_MAC_ADDR,
"calibrate":false,
"group":false,
"slidePosition":50, //0~100
"battery":100,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| detectionState | String | the motion state of the device, "DETECTED" stands for motion is detected; "NOT_DETECTED" stands for motion has not been detected for some time |
| battery | Integer | the current battery level, 0-100 |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoPresence",
"deviceMac": DEVICE_MAC_ADDR,
"detectionState": "NOT_DETECTED",
"battery":100,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| detectionState | String | the motion state of the device, "DETECTED" stands for motion is detected; "NOT_DETECTED" stands for motion has not been detected for some time |
| doorMode | String | when the enter or exit mode gets triggered, "IN_DOOR" or "OUT_DOOR" is returned |
| brightness | String | the level of brightness, can be "bright" or "dim" |
| openState | String | the state of the contact sensor, can be "open" or "close" or "timeOutNotClose" |
| battery | Integer | the current battery level, 0-100 |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoContact",
"deviceMac": DEVICE_MAC_ADDR,
"detectionState": "NOT_DETECTED",
"doorMode":"OUT_DOOR",
"brightness": "dim",
"openState": "open",
"battery":100,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| detectionState | String | the motion state of the device, "DETECTED" stands for motion is detected; "NOT_DETECTED" stands for motion has not been detected for some time |
| battery | Integer | the current battery level, 0-100 |
| lightLevel | Integer | the level of illuminance of the ambience light, 1~20 |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoContact",
"deviceMac": DEVICE_MAC_ADDR,
"detectionState": "NOT_DETECTED",
"battery":100,
"lightLevel": 19,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| detectionState | Integer | 0, dry. 1, leak detected |
| battery | Integer | the current battery level, 0-100 |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Water Detector",
"deviceMac": DEVICE_MAC_ADDR,
"detectionState": 0,
"battery":100,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| temperature | Float | the current temperature reading |
| scale | String | the current temperature unit being used |
| humidity | Integer | the current humidity reading in percentage |
| battery | Integer | the current battery level, 0-100 |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoMeter",
"deviceMac": DEVICE_MAC_ADDR,
"temperature": 22.5,
"scale": "CELSIUS",
"humidity": 31,
"battery":100,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| temperature | Float | the current temperature reading |
| scale | String | the current temperature unit being used |
| humidity | Integer | the current humidity reading in percentage |
| battery | Integer | the current battery level, 0-100 |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoMeter",
"deviceMac": DEVICE_MAC_ADDR,
"temperature": 22.5,
"scale": "CELSIUS",
"humidity": 31,
"battery":100,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| temperature | Float | the current temperature reading |
| scale | String | the current temperature unit being used |
| humidity | Integer | the current humidity reading in percentage |
| battery | Integer | the current battery level, 0-100 |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoIOSensor",
"deviceMac": DEVICE_MAC_ADDR,
"temperature": 22.5,
"scale": "CELSIUS",
"humidity": 31,
"battery":100,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| temperature | Float | the current temperature reading |
| scale | String | the current temperature unit being used |
| humidity | Integer | the current humidity reading in percentage |
| battery | Integer | the current battery level, 0-100 |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WeatherStation",
"deviceMac": DEVICE_MAC_ADDR,
"temperature": 13,
"humidity": 18,
"scale": "CELSIUS",
"battery": 100,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| temperature | Float | the current temperature reading |
| scale | String | the current temperature unit being used |
| humidity | Integer | the current humidity reading in percentage |
| battery | Integer | the current battery level, 0-100 |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "MeterPro",
"deviceMac": DEVICE_MAC_ADDR,
"temperature": 22.5,
"scale": "CELSIUS",
"humidity": 31,
"battery":100,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| temperature | Float | the current temperature reading |
| scale | String | the current temperature unit being used |
| humidity | Integer | the current humidity reading in percentage |
| CO2 | Integer | CO2 ppm value, 0-9999 |
| battery | Integer | the current battery level, 0-100 |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "MeterPro(CO2)",
"deviceMac": DEVICE_MAC_ADDR,
"temperature": 22.5,
"scale": "CELSIUS",
"humidity": 31,
"CO2": 1203,
"battery":100,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| lockState | String | the state of the device, "LOCKED" stands for the motor is rotated to locking position; "UNLOCKED" stands for the motor is rotated to unlocking position; "JAMMED" stands for the motor is jammed while rotating |
| battery | Integer | the current battery level, 0-100 |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoLock",
"deviceMac": DEVICE_MAC_ADDR,
"lockState": "LOCKED",
"battery":100,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| lockState | String | the state of the device, "LOCKED" stands for the motor is rotated to locking position; "UNLOCKED" stands for the motor is rotated to unlocking position; "JAMMED" stands for the motor is jammed while rotating |
| battery | Integer | the current battery level, 0-100 |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoLockPro",
"deviceMac": DEVICE_MAC_ADDR,
"lockState": "LOCKED",
"battery":100,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| lockState | String | the state of the device, "LOCKED" stands for the motor is rotated to locking position; "UNLOCKED" stands for the motor is rotated to unlocking position; "JAMMED" stands for the motor is jammed while rotating |
| battery | Integer | the current battery level, 0-100 |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoLockProWifi",
"deviceMac": DEVICE_MAC_ADDR,
"lockState": "LOCKED",
"battery": 90,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| detectionState | String | the detection state of the device, "DETECTED" stands for motion is detected |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoCamera",
"deviceMac": DEVICE_MAC_ADDR,
"detectionState": "DETECTED",
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| detectionState | String | the detection state of the device, "DETECTED" stands for motion is detected |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoPanTiltCam",
"deviceMac": DEVICE_MAC_ADDR,
"detectionState": "DETECTED",
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| powerState | String | the current power state of the device, "ON" or "OFF" |
| brightness | Integer | the brightness value, range from 1 to 100 |
| color | String | the color value, in the format of RGB value, "255:255:255" |
| colorTemperature | Integer | the color temperature value, range from 2700 to 6500 |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoBulb",
"deviceMac": DEVICE_MAC_ADDR,
"powerState": "ON",
"brightness": 10,
"color":"255:245:235",
"colorTemperature":3500,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| powerState | String | the current power state of the device, "ON" or "OFF" |
| brightness | Integer | the brightness value, range from 1 to 100 |
| color | String | the color value, in the format of RGB value, "255:255:255" |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoStrip",
"deviceMac": DEVICE_MAC_ADDR,
"powerState": "ON",
"brightness": 10,
"color": "255:245:235",
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| powerState | String | the current power state of the device, "ON" or "OFF" |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoPlugUS",
"deviceMac": DEVICE_MAC_ADDR,
"powerState": "ON",
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| powerState | String | the current power state of the device, "ON" or "OFF" |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoPlugJP",
"deviceMac": DEVICE_MAC_ADDR,
"powerState": "ON",
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| online | Boolean | determines if the device is connected to the internet or disconnected |
| overTemperature | Boolean | determines if the working temperature is over 100 degree celcius or not |
| overload | Boolean | determines if the device is power overloaded or not |
| switchStatus | Integer | the switch state of the device. 1, on; 0, off |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Plug Mini (EU)",
"deviceMac": "94A990502B72",
"online": false,
"overTemperature": true,
"overload": true,
"switchStatus": 1
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | attributes of the context object. the type of the device |
| deviceMac | String | attributes of the context object. the MAC address of the device |
| workingStatus | String | attributes of the context object. the working status of the device. StandBy, Clearing, Paused, GotoChargeBase, Charging, ChargeDone, Dormant, InTrouble, InRemoteControl, or InDustCollecting |
| onlineStatus | String | attributes of the context object. the connection status of the device. online or offline |
| battery | Integer | attributes of the context object. the battery level, range from 0 to 100 |
| timeOfSample | Long | attributes of the context object. the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoSweeper",
"deviceMac": DEVICE_MAC_ADDR,
"workingStatus"："StandBy",
"onlineStatus": "online",
"battery": 100,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | attributes of the context object. the type of the device |
| deviceMac | String | attributes of the context object. the MAC address of the device |
| workingStatus | String | attributes of the context object. the working status of the device. StandBy, Clearing, Paused, GotoChargeBase, Charging, ChargeDone, Dormant, InTrouble, InRemoteControl, or InDustCollecting |
| onlineStatus | String | attributes of the context object. the connection status of the device. online or offline |
| battery | Integer | attributes of the context object. the battery level, range from 0 to 100 |
| timeOfSample | Long | attributes of the context object. the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoSweeperPlus",
"deviceMac": DEVICE_MAC_ADDR,
"workingStatus"："StandBy",
"onlineStatus": "online",
"battery": 100,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | attributes of the context object. the type of the device |
| deviceMac | String | attributes of the context object. the MAC address of the device |
| workingStatus | String | attributes of the context object. the working status of the device. StandBy, Clearing, Paused, GotoChargeBase, Charging, ChargeDone, Dormant, InTrouble, InRemoteControl, or InDustCollecting |
| onlineStatus | String | attributes of the context object. the connection status of the device. online or offline |
| battery | Integer | attributes of the context object. the battery level, range from 0 to 100 |
| timeOfSample | Long | attributes of the context object. the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoSweeperMini",
"deviceMac": DEVICE_MAC_ADDR,
"workingStatus"："StandBy",
"onlineStatus": "online",
"battery": 100,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | attributes of the context object. the type of the device |
| deviceMac | String | attributes of the context object. the MAC address of the device |
| workingStatus | String | attributes of the context object. the working status of the device. StandBy, Clearing, Paused, GotoChargeBase, Charging, ChargeDone, Dormant, InTrouble, InRemoteControl, or InDustCollecting |
| onlineStatus | String | attributes of the context object. the connection status of the device. online or offline |
| battery | Integer | attributes of the context object. the battery level, range from 0 to 100 |
| timeOfSample | Long | attributes of the context object. the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoSweeperMiniPro",
"deviceMac": DEVICE_MAC_ADDR,
"workingStatus"："StandBy",
"onlineStatus": "online",
"battery": 100,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | attributes of the context object. the type of the device |
| deviceMac | String | attributes of the context object. the MAC address of the device |
| workingStatus | String | attributes of the context object. the working status of the device. StandBy, Clearing, Paused, GotoChargeBase, Charging, ChargeDone, Dormant, InTrouble, InRemoteControl, or InDustCollecting |
| onlineStatus | String | attributes of the context object. the connection status of the device. online or offline |
| battery | Integer | attributes of the context object. the battery level, range from 0 to 100 |
| taskType | String | attributes of the context object. the current task in progress. standBy, explore, cleanAll, cleanArea, cleanRoom, backToCharge, collectDust, remoteControl, cleanWithExplorer |
| timeOfSample | Long | attributes of the context object. the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Robot Vacuum Cleaner K10+ Pro Combo",
"deviceMac": DEVICE_MAC_ADDR,
"workingStatus"："StandBy",
"onlineStatus": "online",
"battery": 100,
"taskType": "explore",
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | attributes of the context object. the type of the device |
| deviceMac | String | attributes of the context object. the MAC address of the device |
| workingStatus | String | attributes of the context object. the working status of the device. StandBy, Clearing, Paused, GotoChargeBase, Charging, ChargeDone, Dormant, InTrouble, InRemoteControl, or InDustCollecting |
| onlineStatus | String | attributes of the context object. the connection status of the device. online or offline |
| battery | Integer | attributes of the context object. the battery level, 0-100 |
| waterBaseBattery | Integer | the current battery level 0-100 |
| taskType | String | the current task in progress. standBy, explore, cleanAll, cleanArea, cleanRoom, fillWater, deepWashing, backToCharge, markingWaterBase, drying, collectDust, remoteControl, cleanWithExplorer, fillWaterForHumi, markingHumi |
| timeOfSample | Long | attributes of the context object. the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Robot Vacuum Cleaner S10",
"deviceMac": DEVICE_MAC_ADDR,
"workingStatus"："StandBy",
"onlineStatus": "online",
"battery": 100,// 0-100
"waterBaseBattery": 100,
"taskType": "explore",
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | attributes of the context object. the type of the device |
| deviceMac | String | attributes of the context object. the MAC address of the device |
| workingStatus | String | attributes of the context object. the working status of the device. StandBy, Clearing, Paused, GotoChargeBase, Charging, ChargeDone, Dormant, InTrouble, InRemoteControl, or InDustCollecting |
| onlineStatus | String | attributes of the context object. the connection status of the device. online or offline |
| battery | Integer | attributes of the context object. the battery level, 0-100 |
| waterBaseBattery | Integer | the current battery level 0-100 |
| taskType | String | the current task in progress. standBy, explore, cleanAll, cleanArea, cleanRoom, fillWater, deepWashing, backToCharge, markingWaterBase, drying, collectDust, remoteControl, cleanWithExplorer, fillWaterForHumi, markingHumi |
| timeOfSample | Long | attributes of the context object. the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Robot Vacuum Cleaner s20",
"deviceMac": DEVICE_MAC_ADDR,
"workingStatus"："StandBy",
"onlineStatus": "online",
"battery": 100,// 0-100
"waterBaseBattery": 100,
"taskType": "explore",
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | attributes of the context object. the type of the device |
| deviceMac | String | attributes of the context object. the MAC address of the device |
| workingStatus | String | attributes of the context object. the working status of the device. StandBy, Clearing, Paused, GotoChargeBase, Charging, ChargeDone, Dormant, InTrouble, InRemoteControl, or InDustCollecting |
| onlineStatus | String | attributes of the context object. the connection status of the device. online or offline |
| battery | Integer | attributes of the context object. the battery level, range from 0 to 100 |
| taskType | String | the current task in progress. standBy, explore, cleanAll, cleanArea, cleanRoom, fillWater, deepWashing, backToCharge, markingWaterBase, drying, collectDust, remoteControl, cleanWithExplorer, fillWaterForHumi, markingHumi |
| timeOfSample | Long | attributes of the context object. the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Robot Vacuum Cleaner K11 Plus",
"deviceMac": DEVICE_MAC_ADDR,
"workingStatus"："StandBy",
//StandBy,Clearing,Paused,GotoChargeBase,Charging,ChargeDone,Dormant,InTrouble,InRemoteControl,InDustCollecting
"onlineStatus": "online",//online,offline
"battery": 100,// 0-100
"taskType": "explore", // standBy,explore,cleanAll,cleanArea,cleanRoom,deepWashing,backToCharge,drying,collectDust,remoteControl,cleanWithExplorer
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | attributes of the context object. the type of the device |
| deviceMac | String | attributes of the context object. the MAC address of the device |
| powerState | String | attributes of the context object. ON/OFF state |
| brightness | Integer | attributes of the context object. the brightness value, range from 1 to 100 |
| colorTemperature | Integer | attributes of the context object. the color temperature value, range from 2700 to 6500 |
| timeOfSample | Long | attributes of the context object. the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoCeiling",
"deviceMac": DEVICE_MAC_ADDR,
"powerState": "ON",
"brightness": 10,
"colorTemperature": 3500,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | attributes of the context object. the type of the device |
| deviceMac | String | attributes of the context object. the MAC address of the device |
| powerState | String | attributes of the context object. ON/OFF state |
| brightness | Integer | attributes of the context object. the brightness value, range from 1 to 100 |
| colorTemperature | Integer | attributes of the context object. the color temperature value, range from 2700 to 6500 |
| timeOfSample | Long | attributes of the context object. the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoCeilingPro",
"deviceMac": DEVICE_MAC_ADDR,
"powerState": "ON",
"brightness": 10,
"colorTemperature": 3500,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | attributes of the context object. the type of the device |
| deviceMac | String | attributes of the context object. the MAC address of the device |
| powerState | String | attributes of the context object. ON/OFF state |
| brightness | Integer | attributes of the context object. the brightness value, range from 1 to 100 |
| color | String | the color value, in the format of RGB value, "255:255:255" |
| colorTemperature | Integer | attributes of the context object. the color temperature value, range from 2700 to 6500 |
| timeOfSample | Long | attributes of the context object. the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "RGBICWW Strip Light",
"deviceMac": DEVICE_MAC_ADDR,
"powerState": "ON",//"ON"or"OFF"
"brightness": 10,
"color": "255:255:0",
"colorTemperature": 3500,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | attributes of the context object. the type of the device |
| deviceMac | String | attributes of the context object. the MAC address of the device |
| powerState | String | attributes of the context object. ON/OFF state |
| brightness | Integer | attributes of the context object. the brightness value, range from 1 to 100 |
| color | String | the color value, in the format of RGB value, "255:255:255" |
| colorTemperature | Integer | attributes of the context object. the color temperature value, range from 2700 to 6500 |
| timeOfSample | Long | attributes of the context object. the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "RGBICWW Floor Lamp",
"deviceMac": DEVICE_MAC_ADDR,
"powerState": "ON",//"ON"or"OFF"
"brightness": 10,
"color": "255:255:0",
"colorTemperature": 3500,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | attributes of the context object. the type of the device |
| deviceMac | String | attributes of the context object. the MAC address of the device |
| powerState | String | attributes of the context object. ON/OFF state |
| brightness | Integer | attributes of the context object. the brightness value, range from 1 to 100 |
| color | String | the color value, in the format of RGB value, "255:255:255" |
| timeOfSample | Long | attributes of the context object. the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "RGBICWW Strip Light",
"deviceMac": DEVICE_MAC_ADDR,
"powerState": "ON",//"ON"or"OFF"
"brightness": 10,
"color": "255:255:0",
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | attributes of the context object. the type of the device |
| deviceMac | String | attributes of the context object. the MAC address of the device |
| powerState | String | attributes of the context object. ON/OFF state |
| brightness | Integer | attributes of the context object. the brightness value, range from 1 to 100 |
| color | String | the color value, in the format of RGB value, "255:255:255" |
| timeOfSample | Long | attributes of the context object. the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "RGBIC Neon Rope Light",
"deviceMac": DEVICE_MAC_ADDR,
"powerState": "ON",//"ON"or"OFF"
"brightness": 10,
"color": "255:255:0",
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | attributes of the context object. the type of the device |
| deviceMac | String | attributes of the context object. the MAC address of the device |
| mode | String | |
| battery | Integer | the battery level |
| timeOfSample | Long | attributes of the context object. the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Smart Radiator Thermostat",
"deviceMac": "94A990502B72",
"mode": 1,
"battery": 100,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | attributes of the context object. the type of the device |
| deviceMac | String | attributes of the context object. the MAC address of the device |
| eventName | String | attributes of the context object. the name of the command being sent |
| commandId | String | attributes of the context object. the command id |
| result | String | attributes of the context object. the result of the command. success, failed, or timeout. timeout duration is 1 minute |
| timeOfSample | Long | attributes of the context object. the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoKeypad",
"deviceMac": DEVICE_MAC_ADDR,
"eventName": "createKey",
"commandId": "CMD-1663558451952-01",
"result": "success",
"timeOfSample": 123456789
}
}
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoKeypad",
"deviceMac": DEVICE_MAC_ADDR,
"eventName": "deleteKey ",
"commandId": "CMD-1663558451952-01",
"result": "success",
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | attributes of the context object. the type of the device |
| deviceMac | String | attributes of the context object. the MAC address of the device |
| eventName | String | attributes of the context object. the name of the command being sent |
| commandId | String | attributes of the context object. the command id |
| result | String | attributes of the context object. the result of the command. success, failed, or timeout. timeout duration is 1 minute |
| timeOfSample | Long | attributes of the context object. the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoKeypadTouch",
"deviceMac": DEVICE_MAC_ADDR,
"eventName": "createKey",
"commandId": "CMD-1663558451952-01",
"result": "success",
"timeOfSample": 123456789
}
}
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoKeypadTouch",
"deviceMac": DEVICE_MAC_ADDR,
"eventName": "deleteKey ",
"commandId": "CMD-1663558451952-01",
"result": "success",
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | attributes of the context object. the type of the device |
| deviceMac | String | attributes of the context object. the MAC address of the device |
| temperature | Float | the current temperature reading |
| humidity | Integer | the current humidity reading in percentage |
| lightLevel | Integer | the level of illuminance of the ambience light, 1~20 |
| scale | String | the current temperature unit being used |
| timeOfSample | Long | attributes of the context object. the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoHub2",
"deviceMac": DEVICE_MAC_ADDR,
"temperature":13,
"humidity":18,
"lightLevel": 19,
"scale": "CELSIUS",
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| detectionState | String | the motion state of the device, "DETECTED" stands for motion is detected; "NOT_DETECTED" stands for motion has not been detected for some time |
| deviceMac | String | attributes of the context object. the MAC address of the device |
| deviceType | String | attributes of the context object. the type of the device |
| humidity | Integer | the current humidity reading in percentage |
| lightLevel | Integer | the level of illuminance of the ambience light, 1~10 |
| scale | String | the current temperature unit being used |
| temperature | Float | the current temperature reading |
| timeOfSample | Long | attributes of the context object. the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"detectionState": "DETECTED",
"deviceMac": "B0E9FE582974",
"deviceType": "Hub 3",
"humidity": 45,
"lightLevel": 10,
"scale": "CELSIUS",
"temperature": 30.3,
"timeOfSample": 1742807095763
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| mode | String | fan mode. direct mode: direct; natural mode: "natural"; sleep mode: "sleep"; ultra quiet mode: "baby" |
| version | String | the current firmware version, e.g. V4.2 |
| battery | Integer | the current battery level |
| powerState | String | ON/OFF state |
| nightStatus | Integer | 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 | Integer | fan speed. 1~100 |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoFan2",
"deviceMac": DEVICE_MAC_ADDR,
"mode": "direct",
"version": "V3.1",
"battery": 22,
"powerState": "ON",
"nightStatus": "off",
"oscillation": "on",
"verticalOscillation": "on",
"chargingStatus": "charging",
"fanSpeed": 3,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| mode | String | fan mode. direct mode: direct; natural mode: "natural"; sleep mode: "sleep"; ultra quiet mode: "baby" |
| version | String | the current firmware version, e.g. V4.2 |
| powerState | String | ON/OFF state |
| nightStatus | Integer | 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 |
| fanSpeed | Integer | fan speed. 1~100 |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoFan2",
"deviceMac": DEVICE_MAC_ADDR,
"mode": "direct",
"version": "V3.1",
"powerState": "ON",
"nightStatus": "off",
"oscillation": "on",
"verticalOscillation": "on",
"fanSpeed": 3,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| power | String | the power state of the device |
| 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 |
| drying | Boolean | determines if the device is drying its filter or not |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Humidifier2",
"deviceMac": DEVICE_MAC_ADDR,
"power": "on",
"mode": 1,
"drying": false,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| power | String | the power state of the device |
| 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 |
| drying | Boolean | determines if the device is drying its filter or not |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Humidifier2",
"deviceMac": DEVICE_MAC_ADDR,
"power": "on",
"mode": 1,
"drying": false,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| power | String | the power state of the device |
| mode | Integer | the current mode. 1, normal or fan mode; 2, auto mode; 3, sleep mode; 4, pet mode |
| childLock | Integer | child lock. 0, disabled; 1, enabled |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Air Purifier VOC",
"deviceMac": DEVICE_MAC_ADDR,
"power": "ON",
"mode": 4,
"childLock": 0,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| power | String | the power state of the device |
| mode | Integer | the current mode. 1, normal or fan mode; 2, auto mode; 3, sleep mode; 4, pet mode |
| childLock | Integer | child lock. 0, disabled; 1, enabled |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Air Purifier Table VOC",
"deviceMac": DEVICE_MAC_ADDR,
"power": "ON",
"mode": 4,
"childLock": 0,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| power | String | the power state of the device |
| mode | Integer | the current mode. 1, normal or fan mode; 2, auto mode; 3, sleep mode; 4, pet mode |
| childLock | Integer | child lock. 0, disabled; 1, enabled |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Air Purifier PM2.5",
"deviceMac": DEVICE_MAC_ADDR,
"power": "ON",
"mode": 4,
"childLock": 0,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| power | String | the power state of the device |
| mode | Integer | the current mode. 1, normal or fan mode; 2, auto mode; 3, sleep mode; 4, pet mode |
| childLock | Integer | child lock. 0, disabled; 1, enabled |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Air Purifier Table PM2.5",
"deviceMac": DEVICE_MAC_ADDR,
"power": "ON",
"mode": 4,
"childLock": 0,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| calibrate | Boolean | determines if the open position and the close position of a device have been properly calibrated or not |
| slidePosition | Integer | the percentage of the distance between the calibrated open position and closed position that the device has traversed |
| battery | Integer | the battery level |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoRollerShade",
"deviceMac": DEVICE_MAC_ADDR,
"calibrate":false,
"slidePosition":50, //0~100
"battery":100,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| online | Boolean | determines if the device is connected to the internet or disconnected |
| switchStatus | Integer | the switch state of the device. 1, on; 0, off |
| overload | Boolean | determines if the device is power overloaded or not |
| overTemperature | Boolean | determines if the working temperature is over 100 degree celcius or not |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Relay Switch 1PM",
"deviceMac": DEVICE_MAC_ADDR,
"online": false,
"overTemperature": true,
"overload": true,
"switchStatus": 1,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| online | Boolean | determines if the device is connected to the internet or disconnected |
| switchStatus | Integer | the switch state of the device. 1, on; 0, off |
| overTemperature | Boolean | determines if the working temperature is over 100 degree celcius or not |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Relay Switch 1",
"deviceMac": DEVICE_MAC_ADDR,
"online": false,
"overTemperature": true,
"switchStatus": 1,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| online | Boolean | determines if the device is connected to the internet or disconnected |
| switchStatus | Integer | the switch state of the device. 1, on; 0, off |
| overload | Boolean | determines if the device is power overloaded or not |
| calibrate | Boolean | determines if the open position and the close position of a device have been properly calibrated or not |
| position | Integer | determine the percentage of the device that is open or closed |
| isStuck | Boolean | determine if the device is stuck |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Relay Switch 2PM",
"deviceMac": "FFFFFFFFFFF",
"online": false,
"overTemperature": true,
"switch1Status": 1,
"switch2Status": 1,
"switch1Overload": true,
"switch2Overload": true,
"calibrate": true,
"position": 0,
"isStuck": true
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| doorStatus | Integer | he switch state of the device. 0, on; 1, off |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Garage Door Opener",
"deviceMac": "FFFFFFFFFFF",
"doorStatus": 1,
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| powerState | String | ON/OFF state |
| brightness | Integer | attributes of the context object. the brightness value, range from 1 to 100 |
| colorTemperature | Integer | attributes of the context object. the color temperature value, range from 2700 to 6500 |
| color | String | the color value, in the format of RGB value, "255:255:255" |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Floor Lamp",
"deviceMac": DEVICE_MAC_ADDR,
"powerState": "ON",
"brightness": 10,
"color": "255:255:0",
"colorTemperature": 3500,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| lockState | String | determines if locked or not |
| battery | Integer | the battery level |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "WoLockLite",
"deviceMac": DEVICE_MAC_ADDR,
"lockState": "LOCKED",
"battery": 90,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| battery | Integer | the battery level |
| detectionState | String | the motion state of the device, "DETECTED" stands for motion is detected; "NOT_DETECTED" stands for motion has not been detected for some time |
| timeOfSample | Long | the time stamp when the event is sent |
| press | Boolean | the Doorbell button was pressed |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Video Doorbell",
"deviceMac": DEVICE_MAC_ADDR,
"battery": 80,
"detectionState": "DETECTED",
"press": true,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| eventName | String | attributes of the context object. the name of the command being sent |
| commandId | String | attributes of the context object. the command id |
| result | String | attributes of the context object. the result of the command. success, failed, or timeout. timeout duration is 1 minute |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Keypad Vision",
"deviceMac": DEVICE_MAC_ADDR,
"eventName": "createKey",
"commandId": "CMD-1663558451952-01",
"result": "success",
"timeOfSample": 123456789
}
}
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Keypad Vision",
"deviceMac": DEVICE_MAC_ADDR,
"eventName": "deleteKey ",
"commandId": "CMD-1663558451952-01",
"result": "success",
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| eventName | String | attributes of the context object. the name of the command being sent |
| commandId | String | attributes of the context object. the command id |
| result | String | attributes of the context object. the result of the command. success, failed, or timeout. timeout duration is 1 minute |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Keypad Vision Pro",
"deviceMac": DEVICE_MAC_ADDR,
"eventName": "createKey",
"commandId": "CMD-1663558451952-01",
"result": "success",
"timeOfSample": 123456789
}
}
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Keypad Vision Pro",
"deviceMac": DEVICE_MAC_ADDR,
"eventName": "deleteKey ",
"commandId": "CMD-1663558451952-01",
"result": "success",
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| lockState | String | the state of the device, "LOCKED" stands for the motor is rotated to locking position; "UNLOCKED" stands for the motor is rotated to unlocking position; "JAMMED" stands for the motor is jammed while rotating |
| battery | Integer | the battery level |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Smart Lock Ultra",
"deviceMac": DEVICE_MAC_ADDR,
"lockState": "LOCKED",
"battery": 90,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| lockState | String | the state of the device, "LOCKED" stands for the motor is rotated to locking position; "UNLOCKED" stands for the motor is rotated to unlocking position; "JAMMED" stands for the motor is jammed while rotating |
| battery | Integer | the battery level |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "W1141000",
"deviceMac": DEVICE_MAC_ADDR,
"lockState": "LOCKED",
"battery": 90,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| lockState | String | the state of the device, "LOCKED" stands for the motor is rotated to locking position; "UNLOCKED" stands for the motor is rotated to unlocking position; "JAMMED" stands for the motor is jammed while rotating |
| battery | Integer | the battery level |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "W1141001",
"deviceMac": DEVICE_MAC_ADDR,
"lockState": "LOCKED",
"battery": 90,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| powerState | String | ON/OFF state |
| brightness | Integer | attributes of the context object. the brightness value, range from 1 to 100 |
| colorTemperature | Integer | attributes of the context object. the color temperature value, range from 2700 to 6500 |
| color | String | the color value, in the format of RGB value, "255:255:255" |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Strip Light 3",
"deviceMac": DEVICE_MAC_ADDR,
"powerState": "ON",//"ON"or"OFF"
"brightness": 10,
"color": "255:255:0",
"colorTemperature": 3500,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | attributes of the context object. the type of the device |
| deviceMac | String | attributes of the context object. the MAC address of the device |
| workingStatus | String | attributes of the context object. the working status of the device. StandBy, Clearing, Paused, GotoChargeBase, Charging, ChargeDone, Dormant, InTrouble, InRemoteControl, or InDustCollecting |
| onlineStatus | String | attributes of the context object. the connection status of the device. online or offline |
| battery | Integer | attributes of the context object. the battery level, range from 0 to 100 |
| taskType | String | attributes of the context object. the current task in progress. standBy, explore, cleanAll, cleanArea, cleanRoom, backToCharge, collectDust, remoteControl, cleanWithExplorer |
| timeOfSample | Long | attributes of the context object. the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Robot Vacuum Cleaner K20+ Pro",
"deviceMac": DEVICE_MAC_ADDR,
"workingStatus"："StandBy",
//StandBy,Clearing,Paused,GotoChargeBase,Charging,ChargeDone,Dormant,InTrouble,InRemoteControl,InDustCollecting
"onlineStatus": "online",//online,offline
"battery": 100,// 0-100
"taskType": "explore", // standBy,explore,cleanAll,cleanArea,cleanRoom,deepWashing,backToCharge,drying,collectDust,remoteControl,cleanWithExplorer
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| powerState | String | ON/OFF state |
| brightness | Integer | attributes of the context object. the brightness value, range from 1 to 100 |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"brightness": 100,
"deviceMac": "3C842777C07E",
"deviceType": "Candle Warmer Lamp",
"powerState": "ON",
"timeOfSample": 1759136920594
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| mode | String | fan mode. direct mode: direct; natural mode: "natural"; sleep mode: "sleep"; ultra quiet mode: "baby" |
| version | String | the current firmware version, e.g. V4.2 |
| powerState | String | ON/OFF state |
| nightStatus | String | 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 |
| fanSpeed | Integer | fan speed. 1~100 |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "Standing Fan",
"deviceMac": DEVICE_MAC_ADDR,
"mode":"direct" ,
"powerState": "ON",
"nightStatus":"off",
"oscillation":"on",
"verticalOscillation":"on",
"fanSpeed":3,
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| temperature | Float | the current temperature reading |
| humidity | Integer | the current humidity reading in percentage |
| scale | String | the current temperature unit being used |
| battery | Integer | the current battery level |
| detectionState | String | the motion state of the device, "DETECTED" stands for motion is detected; "NOT_DETECTED" stands for motion has not been detected for some time |
| brightness | String | the brightness level. "bright" or "dim" |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "climate Panel",
"deviceMac": DEVICE_MAC_ADDR,
"temperature":13,
"humidity":18,
"scale": "CELSIUS",
"battery":100,
"detectionState": "DETECTED",
"brightness":"bright" // bright,dim
"timeOfSample": 123456789
}
}
| Key Name | Value Type | Description |
|---|
| eventType | String | the type of events |
| eventVersion | String | the current event version |
| context | Object | the detail info of the event |
| deviceType | String | the type of the device |
| deviceMac | String | the MAC address of the device |
| displayMode | Integer | display mode: 0 = Static image; 1 = Slideshow |
| battery | Integer | the current battery level, 0-100 |
| timeOfSample | Long | the time stamp when the event is sent |
{
"eventType": "changeReport",
"eventVersion": "1",
"context": {
"deviceType": "AI Art Frame",
"deviceMac": "B0E9FEA5D7F0",
"displayMode": 1, // Display mode: 0 = Static image; 1 = Slideshow
"battery": 100,
"timeOfSample": 123456789
}
}