-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathGet_device_list.html
651 lines (424 loc) · 17.3 KB
/
Get_device_list.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
<!DOCTYPE HTML>
<html lang="" >
<head>
<meta charset="UTF-8">
<title>Get device list · HonKit</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="description" content="">
<meta name="generator" content="HonKit 3.6.16">
<link rel="stylesheet" href="gitbook/style.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css">
<link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css">
<meta name="HandheldFriendly" content="true"/>
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black">
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png">
<link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon">
<link rel="next" href="Get_device_status.html" />
<link rel="prev" href="Standard_HTTP_Error_Codes.html" />
</head>
<body>
<div class="book honkit-cloak">
<div class="book-summary">
<div id="book-search-input" role="search">
<input type="text" placeholder="Type to search" />
</div>
<nav role="navigation">
<ul class="summary">
<li class="chapter " data-level="1.1" data-path="./">
<a href="./">
Introduction
</a>
<ul class="articles">
<li class="chapter " data-level="1.1.1" data-path="Authentication.html">
<a href="Authentication.html">
Authentication
</a>
</li>
<li class="chapter " data-level="1.1.2" data-path="API_Usage.html">
<a href="API_Usage.html">
API Usage
</a>
</li>
<li class="chapter " data-level="1.1.3" data-path="Standard_HTTP_Error_Codes.html">
<a href="Standard_HTTP_Error_Codes.html">
Standard HTTP Error Codes
</a>
</li>
</ul>
</li>
<li class="header">Devices</li>
<li class="chapter active" data-level="2.1" data-path="Get_device_list.html">
<a href="Get_device_list.html">
Get device list
</a>
</li>
<li class="chapter " data-level="2.2" data-path="Get_device_status.html">
<a href="Get_device_status.html">
Get device status
</a>
</li>
<li class="chapter " data-level="2.3" data-path="Send_device_control_commands.html">
<a href="Send_device_control_commands.html">
Send device control commands
</a>
</li>
<li class="header">Scenes</li>
<li class="chapter " data-level="3.1" data-path="Get_scene_list.html">
<a href="Get_scene_list.html">
Get scene list
</a>
</li>
<li class="chapter " data-level="3.2" data-path="Execute_manual_scenes.html">
<a href="Execute_manual_scenes.html">
Execute manual scenes
</a>
</li>
<li class="header">Support</li>
<li class="chapter " data-level="4.1" data-path="Support.html">
<a href="Support.html">
Support
</a>
</li>
<li class="divider"></li>
<li>
<a href="https://www.switch-bot.com" target="blank" class="gitbook-link">
www.switch-bot.com
</a>
</li>
</ul>
</nav>
</div>
<div class="book-body">
<div class="body-inner">
<div class="book-header" role="navigation">
<!-- Title -->
<h1>
<i class="fa fa-circle-o-notch fa-spin"></i>
<a href="." >Get device list</a>
</h1>
</div>
<div class="page-wrapper" tabindex="-1" role="main">
<div class="page-inner">
<div id="book-search-results">
<div class="search-noresults">
<section class="normal markdown-section">
<h3 id="get-device-list">Get device list</h3>
<pre><code class="lang-http">GET /v1.0/devices
</code></pre>
<h4 id="description">Description</h4>
<p>Get a list of devices, which include physical devices and virtual infrared remote devices that have been added to the current user's account.</p>
<p>Physical devices refer to the following SwitchBot products,</p>
<ul>
<li>Hub</li>
<li>Hub Plus</li>
<li>Hub Mini</li>
<li>Bot (MUST enable Cloud Service first)</li>
<li>Curtain (MUST enable Cloud Service first)</li>
<li>Plug</li>
<li>Meter</li>
<li>Humidifier</li>
<li>Smart Fan</li>
</ul>
<p>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 is required in order to be able to create these virtual devices within the app. The types of appliances supported include,</p>
<ul>
<li>Air Conditioner</li>
<li>TV</li>
<li>Light</li>
<li>IPTV/Streamer</li>
<li>Set Top Box</li>
<li>DVD</li>
<li>Fan</li>
<li>Projector</li>
<li>Camera</li>
<li>Air Purifier</li>
<li>Speaker</li>
<li>Water Heater</li>
<li>Vacuum Cleaner</li>
<li>Others</li>
</ul>
<h4 id="responses">Responses</h4>
<p>The response is basically a JSON object, which contains the following properties,</p>
<table>
<thead>
<tr>
<th>Key Name</th>
<th>Value Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>statusCode</td>
<td>Integer</td>
</tr>
<tr>
<td>message</td>
<td>String</td>
</tr>
<tr>
<td>body</td>
<td>Object<body></body></td>
</tr>
</tbody>
</table>
<p>The body object contains the following properties,</p>
<table>
<thead>
<tr>
<th>Key Name</th>
<th>Value Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>deviceList</td>
<td>Array<device></device></td>
<td>a list of physical devices</td>
</tr>
<tr>
<td>infraredRemoteList</td>
<td>Array<infraredremote></infraredremote></td>
<td>a list of virtual infrared remote devices</td>
</tr>
</tbody>
</table>
<p>The deviceList array contains a list of objects with the following key-value attributes,</p>
<table>
<thead>
<tr>
<th>Key</th>
<th>Value Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>deviceId</td>
<td>String</td>
<td>device ID</td>
</tr>
<tr>
<td>deviceName</td>
<td>String</td>
<td>device name</td>
</tr>
<tr>
<td>deviceType</td>
<td>String</td>
<td>device type</td>
</tr>
<tr>
<td>enableCloudService</td>
<td>Boolean</td>
<td>determines if Cloud Service is enabled or not for the current device</td>
</tr>
<tr>
<td>hubDeviceId</td>
<td>String</td>
<td>device's parent Hub ID</td>
</tr>
<tr>
<td>curtainDevicesIds</td>
<td>Array<deviceid></deviceid></td>
<td>only available for Curtain devices. a list of Curtain device IDs such that the Curtain devices are being paired or grouped</td>
</tr>
<tr>
<td>calibrate</td>
<td>Boolean</td>
<td>only available for Curtain devices. determines if the open position and the close position of a Curtain have been properly calibrated or not</td>
</tr>
<tr>
<td>group</td>
<td>Boolean</td>
<td>only available for Curtain devices. determines if a Curtain is paired with or grouped with another Curtain or not</td>
</tr>
<tr>
<td>master</td>
<td>Boolean</td>
<td>only available for Curtain devices. determines if a Curtain is the master device or not when paired with or grouped with another Curtain</td>
</tr>
<tr>
<td>openDirection</td>
<td>String</td>
<td>only available for Curtain devices. the opening direction of a Curtain</td>
</tr>
</tbody>
</table>
<p>The infraredRemoteList array contains a list of objects with the following key-value attributes,</p>
<table>
<thead>
<tr>
<th>Key</th>
<th>Value Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>deviceId</td>
<td>String</td>
<td>device ID</td>
</tr>
<tr>
<td>deviceName</td>
<td>String</td>
<td>device name</td>
</tr>
<tr>
<td>remoteType</td>
<td>String</td>
<td>device type</td>
</tr>
<tr>
<td>hubDeviceId</td>
<td>String</td>
<td>remote device's parent Hub ID</td>
</tr>
</tbody>
</table>
<p>The response may contain the following codes and messages,</p>
<table>
<thead>
<tr>
<th>Status Code</th>
<th>Body Content</th>
<th>Message</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>100</td>
<td>Device list object</td>
<td>success</td>
<td>Returns an object that contains two device lists</td>
</tr>
<tr>
<td>n/a</td>
<td>n/a</td>
<td>Unauthorized</td>
<td>Http 401 Error. User permission is denied due to invalid token.</td>
</tr>
<tr>
<td>190</td>
<td>n/a</td>
<td>System error</td>
<td>Device internal error due to device states not synchronized with server</td>
</tr>
</tbody>
</table>
<h4 id="sample">Sample</h4>
<h5 id="get-all-devices">Get all devices</h5>
<p>Request</p>
<pre><code class="lang-http">GET https://api.switch-bot.com/v1.0/devices
</code></pre>
<p>Response</p>
<pre><code class="lang-js">{
<span class="hljs-string">"statusCode"</span>: <span class="hljs-number">100</span>,
<span class="hljs-string">"body"</span>: {
<span class="hljs-string">"deviceList"</span>: [
{
<span class="hljs-string">"deviceId"</span>: <span class="hljs-string">"500291B269BE"</span>,
<span class="hljs-string">"deviceName"</span>: <span class="hljs-string">"Living Room Humidifier"</span>,
<span class="hljs-string">"deviceType"</span>: <span class="hljs-string">"Humidifier"</span>,
<span class="hljs-string">"enableCloudService"</span>: <span class="hljs-literal">true</span>,
<span class="hljs-string">"hubDeviceId"</span>: <span class="hljs-string">"000000000000"</span>
}
],
<span class="hljs-string">"infraredRemoteList"</span>: [
{
<span class="hljs-string">"deviceId"</span>: <span class="hljs-string">"02-202008110034-13"</span>,
<span class="hljs-string">"deviceName"</span>: <span class="hljs-string">"Living Room TV"</span>,
<span class="hljs-string">"remoteType"</span>: <span class="hljs-string">"TV"</span>,
<span class="hljs-string">"hubDeviceId"</span>: <span class="hljs-string">"FA7310762361"</span>
}
]
},
<span class="hljs-string">"message"</span>: <span class="hljs-string">"success"</span>
}
</code></pre>
</section>
</div>
<div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
</div>
</div>
</div>
<a href="Standard_HTTP_Error_Codes.html" class="navigation navigation-prev " aria-label="Previous page: Standard HTTP Error Codes">
<i class="fa fa-angle-left"></i>
</a>
<a href="Get_device_status.html" class="navigation navigation-next " aria-label="Next page: Get device status">
<i class="fa fa-angle-right"></i>
</a>
</div>
<script>
var gitbook = gitbook || [];
gitbook.push(function() {
gitbook.page.hasChanged({"page":{"title":"Get device list","level":"2.1","depth":1,"next":{"title":"Get device status","level":"2.2","depth":1,"path":"Get_device_status.md","ref":"Get_device_status.md","articles":[]},"previous":{"title":"Standard HTTP Error Codes","level":"1.1.3","depth":2,"path":"Standard_HTTP_Error_Codes.md","ref":"Standard_HTTP_Error_Codes.md","articles":[]},"dir":"ltr"},"config":{"gitbook":"*","theme":"default","variables":{},"plugins":["livereload"],"pluginsConfig":{"livereload":{},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56},"embedFonts":false},"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"}},"file":{"path":"Get_device_list.md","mtime":"2020-12-31T06:48:58.870Z","type":"markdown"},"gitbook":{"version":"3.6.16","time":"2020-12-31T07:09:06.191Z"},"basePath":".","book":{"language":""}});
});
</script>
</div>
<noscript>
<style>
.honkit-cloak {
display: block !important;
}
</style>
</noscript>
<script>
// Restore sidebar state as critical path for prevent layout shift
function __init__getSidebarState(defaultValue){
var baseKey = "";
var key = baseKey + ":sidebar";
try {
var value = localStorage[key];
if (value === undefined) {
return defaultValue;
}
var parsed = JSON.parse(value);
return parsed == null ? defaultValue : parsed;
} catch (e) {
return defaultValue;
}
}
function __init__restoreLastSidebarState() {
var isMobile = window.matchMedia("(max-width: 600px)").matches;
if (isMobile) {
// Init last state if not mobile
return;
}
var sidebarState = __init__getSidebarState(true);
var book = document.querySelector(".book");
// Show sidebar if it enabled
if (sidebarState && book) {
book.classList.add("without-animation", "with-summary");
}
}
try {
__init__restoreLastSidebarState();
} finally {
var book = document.querySelector(".book");
book.classList.remove("honkit-cloak");
}
</script>
<script src="gitbook/gitbook.js"></script>
<script src="gitbook/theme.js"></script>
<script src="gitbook/gitbook-plugin-livereload/plugin.js"></script>
<script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
<script src="gitbook/gitbook-plugin-search/search.js"></script>
<script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
<script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
<script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
</body>
</html>