-
Notifications
You must be signed in to change notification settings - Fork 219
/
openapi.yaml
1235 lines (1197 loc) · 37.1 KB
/
openapi.yaml
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
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: ESP8266 MiLight Hub
description: Official documention for MiLight Hub's REST API.
contact:
email: [email protected]
license:
name: MIT
version: 1.0.0
servers:
- url: http://milight-hub
tags:
- name: System
description: >
Routes that return system information and allow you to control the device.
- name: Settings
description: Read and write settings
- name: Device Control
description: Control lighting devices
- name: Device Control by Alias
description: Control lighting devices using aliases rather than raw IDs
- name: Raw Packet Handling
description: Read and write raw Milight packets
- name: Transitions
description: Control transitions
x-tagGroups:
- name: Admin
tags:
- System
- Settings
- name: Aliases
tags:
- Aliases
- name: Devices
tags:
- Device Control
- Device Control by Alias
- Raw Packet Handling
- name: Transitions
tags:
- Transitions
paths:
/aliases:
post:
tags:
- Aliases
summary: Create a new alias
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Alias'
responses:
'201':
description: Alias created successfully
content:
application/json:
# will only respond with the created ID
schema:
type: object
properties:
id:
type: integer
get:
tags:
- Aliases
summary: Get all aliases
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
properties:
aliases:
type: array
items:
$ref: '#/components/schemas/Alias'
page:
type: integer
count:
type: integer
num_pages:
type: integer
/aliases/{id}:
put:
tags:
- Aliases
summary: Update an alias by ID
parameters:
- name: id
in: path
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Alias'
responses:
'200':
description: Alias updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/BooleanResponse'
delete:
tags:
- Aliases
summary: Delete an alias by ID
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Alias deleted successfully
content:
application/json:
schema:
$ref: '#/components/schemas/BooleanResponse'
/aliases.bin:
get:
tags:
- Aliases
summary: Download a backup of all aliases in a binary format
responses:
'200':
description: Successful operation
content:
application/octet-stream:
schema:
type: string
format: binary
post:
tags:
- Aliases
summary: Upload a backup of all aliases in CSV format
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
responses:
'201':
description: Backup uploaded and aliases restored successfully
content:
application/json:
schema:
$ref: '#/components/schemas/BooleanResponse'
/about:
get:
tags:
- System
summary: Get system information
responses:
200:
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/About'
/backup:
post:
tags:
- System
summary: Restore a backup
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
responses:
400:
description: error
content:
application/json:
schema:
$ref: '#/components/schemas/BooleanResponse'
201:
description: Backup uploaded and settings restored successfully
content:
application/json:
schema:
$ref: '#/components/schemas/BooleanResponse'
get:
tags:
- System
summary: Download a backup of all settings
responses:
200:
description: success
content:
application/octet-stream:
schema:
type: string
format: binary
/remote_configs:
get:
tags:
- System
summary: List supported remote types
responses:
200:
description: success
content:
applicaiton/json:
schema:
type: array
items:
type: string
example:
$ref: '#/components/schemas/RemoteType/enum'
/system:
post:
tags:
- System
summary: Send a system command
description: >
Send commands to the system. Supported commands:
1. `restart`. Restart the ESP8266.
1. `clear_wifi_config`. Clears on-board wifi information. ESP8266 will reboot and enter wifi config mode.
requestBody:
content:
application/json:
schema:
type: object
required:
- command
properties:
command:
type: string
enum:
- restart
- clear_wifi_config
responses:
200:
description: command handled successfully
content:
application/json:
schema:
$ref: '#/components/schemas/BooleanResponse'
400:
description: error
content:
application/json:
schema:
$ref: '#/components/schemas/BooleanResponse'
/settings:
get:
tags:
- Settings
summary: Get existing settings
responses:
200:
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/Settings'
put:
tags:
- Settings
summary: Patch existing settings
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Settings'
responses:
200:
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/BooleanResponse'
post:
tags:
- Settings
summary: Overwrite existing settings with a file
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Settings'
responses:
200:
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/BooleanResponse'
/gateway_traffic/{remote-type}:
get:
tags:
- Raw Packet Handling
summary: Read a packet from a specific remote
description:
Read a packet from the given remote type. Does not return a response until a packet is read.
If `remote-type` is unspecified, will read from all remote types simultaneously.
parameters:
- $ref: '#/components/parameters/RemoteType'
responses:
200:
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/ReadPacket'
/gateway_traffic:
get:
tags:
- Raw Packet Handling
summary: Read a packet from any remote
description:
Read a packet from any remote type. Does not return a response until a packet is read.
responses:
200:
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/ReadPacket'
/gateways/{device-id}/{remote-type}/{group-id}:
parameters:
- $ref: '#/components/parameters/DeviceId'
- $ref: '#/components/parameters/RemoteType'
- $ref: '#/components/parameters/GroupId'
get:
tags:
- Device Control
summary:
Get device state
description:
If `blockOnQueue` is provided, a response will not be returned until any unprocessed
packets in the command queue are finished sending.
parameters:
- $ref: '#/components/parameters/BlockOnQueue'
responses:
200:
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/GroupState'
put:
tags:
- Device Control
summary:
Patch device state
description:
Update state of the bulbs with the provided parameters. Existing parameters will be
unchanged.
if `blockOnQueue` is set to true, the response will not return until packets corresponding
to the commands sent are processed, and the updated `GroupState` will be returned. If
`blockOnQueue` is false or not provided, a simple response indicating success will be
returned.
parameters:
- $ref: '#/components/parameters/BlockOnQueue'
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/GroupState'
- $ref: '#/components/schemas/GroupStateCommands'
responses:
400:
description: error with request
content:
application/json:
schema:
$ref: '#/components/schemas/BooleanResponse'
200:
description: >
Success.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/BooleanResponse'
- $ref: '#/components/schemas/GroupState'
delete:
tags:
- Device Control
summary:
Delete kept state
description:
Usets all known values for state fields for the corresponding device. If MQTT is
configured, the retained state message corresponding to this device will also be
deleted.
responses:
200:
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/BooleanResponse'
/gateways/{device-alias}:
parameters:
- $ref: '#/components/parameters/DeviceAlias'
get:
tags:
- Device Control by Alias
summary: Get device state by alias
responses:
404:
description: provided device alias does not exist
200:
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/GroupState'
put:
tags:
- Device Control by Alias
summary: Patch device state by alias
parameters:
- $ref: '#/components/parameters/BlockOnQueue'
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/GroupState'
- $ref: '#/components/schemas/GroupStateCommands'
responses:
400:
description: error with request
content:
application/json:
schema:
$ref: '#/components/schemas/BooleanResponse'
200:
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/GroupState'
delete:
tags:
- Device Control by Alias
summary: Delete kept state for alias
description:
Usets all known values for state fields for the corresponding device. If MQTT is
configured, the retained state message corresponding to this device will also be
deleted.
responses:
200:
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/BooleanResponse'
/raw_commands/{remote-type}:
parameters:
- $ref: '#/components/parameters/RemoteType'
post:
tags:
- Raw Packet Handling
summary: Send a raw packet
requestBody:
content:
application/json:
schema:
type: object
properties:
packet:
type: string
pattern: "([A-Fa-f0-9]{2}[ ])+"
description: Raw packet to send
example: '01 02 03 04 05 06 07 08 09'
num_repeats:
type: integer
minimum: 1
description: Number of repeated packets to send
example: 50
responses:
200:
description: success
content:
applicaiton/json:
schema:
$ref: '#/components/schemas/BooleanResponse'
/transitions:
get:
tags:
- Transitions
summary: List all active transitions
responses:
200:
description: success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TransitionData'
post:
tags:
- Transitions
summary: Create a new transition
requestBody:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/TransitionData'
- $ref: '#/components/schemas/BulbId'
responses:
400:
description: error
content:
application/json:
schema:
$ref: '#/components/schemas/BooleanResponse'
200:
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/BooleanResponse'
/transitions/{id}:
parameters:
- name: id
in: path
description: ID of transition. This will be an auto-incrementing number reset after a restart.
schema:
type: integer
required: true
get:
tags:
- Transitions
summary: Get properties for a transition
responses:
404:
description: Provided transition ID not found
200:
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/TransitionData'
delete:
tags:
- Transitions
summary: Delete a transition
responses:
404:
description: Provided transition ID not found
content:
application/json:
schema:
$ref: '#/components/schemas/BooleanResponse'
200:
description: success
content:
application/json:
schema:
$ref: '#/components/schemas/BooleanResponse'
/firmware:
post:
tags:
- System
summary:
Update firmware
requestBody:
description: Firmware file
content:
multipart/form-data:
schema:
type: object
properties:
fileName:
type: string
format: binary
responses:
200:
description: success
500:
description: server error
components:
parameters:
DeviceAlias:
name: device-alias
in: path
description: Device alias saved in settings
schema:
type: string
required: true
BlockOnQueue:
name: blockOnQueue
in: query
description: If true, response will block on update packets being sent before returning
schema:
type: boolean
required: false
GroupId:
name: group-id
in: path
description: >
Group ID. Should be 0-8, depending on remote type. Group 0 is a "wildcard" group. All bulbs paired with the same device ID will respond to commands sent to Group 0.
schema:
type: integer
minimum: 0
maximum: 8
required: true
DeviceId:
name: device-id
in: path
description: 2-byte device ID. Can be decimal or hexadecimal.
schema:
oneOf:
- type: integer
minimum: 0
maximum: 65535
- type: string
pattern: '0x[a-fA-F0-9]+'
example: '0x1234'
required: true
RemoteType:
name: remote-type
in: path
description: Type of remote to read a packet from. If unspecified, will read packets from all remote types.
schema:
$ref: '#/components/schemas/RemoteType'
required: true
schemas:
Alias:
type: object
properties:
alias:
type: string
id:
type: integer
device_id:
type: integer
group_id:
type: integer
device_type:
type: string
State:
description: "On/Off state"
type: string
enum:
- On
- Off
example: On
GroupStateCommand:
type: string
enum:
- unpair
- pair
- set_white
- night_mode
- level_up
- level_down
- temperature_up
- temperature_down
- next_mode
- previous_mode
- mode_speed_down
- mode_speed_up
- toggle
example: pair
description: >
Commands that affect a given group. Descriptiosn follow:
* `pair`. Emulates the pairing process. Send this command right as you connect an unpaired bulb and it will pair with the device ID being used.
* `unpair`. Emulates the unpairing process. Send as you connect a paired bulb to have it disassociate with the device ID being used.
* `set_white`. Turns off RGB and enters WW/CW mode.
* `night_mode`. Most devices support a "night mode," which has LEDs turned to a very dim setting -- lower than brightness 0.
* `level_up`. Turns down the brightness. Not all dimmable bulbs support this command.
* `level_down`. Turns down the brightness. Not all dimmable bulbs support this command.
* `temperature_up`. Turns up the white temperature. Not all bulbs with adjustable white temperature support this command.
* `temperature_down`. Turns down the white temperature. Not all bulbs with adjustable white temperature support this command.
* `next_mode`. Cycles to the next "disco mode".
* `previous_mode`. Cycles to the previous disco mode.
* `mode_speed_up`. Turn transition speed for current mode up.
* `mode_speed_down`. Turn transition speed for current mode down.
* `toggle`. Toggle on/off state.
TransitionField:
type: string
enum:
- hue
- saturation
- brightness
- level
- kelvin
- color_temp
- color
- status
example: brightness
description: >
If transitioning `status`:
* If transitioning to `OFF`, will fade to 0 brightness and then turn off.
* If transitioning to `ON`, will turn on, set brightness to 0, and fade to brightness 100.
TransitionValue:
oneOf:
- type: integer
- type: string
pattern: '[0-9]{1,3},[0-9]{1,3},[0-9]{1,3}'
description: Either an int value or a color
TransitionArgs:
type: object
properties:
field:
$ref: '#/components/schemas/TransitionField'
start_value:
$ref: '#/components/schemas/TransitionValue'
end_value:
$ref: '#/components/schemas/TransitionValue'
duration:
type: number
format: float
description: Duration of transition, measured in seconds
period:
type: integer
description: Length of time between updates in a transition, measured in milliseconds
TransitionData:
allOf:
- $ref: '#/components/schemas/TransitionArgs'
- type: object
properties:
id:
readOnly: true
type: integer
last_sent:
readOnly: true
type: integer
description: Timestamp since last update was sent.
bulb:
readOnly: true
allOf:
- $ref: '#/components/schemas/BulbId'
type:
readOnly: true
description: >
Specifies whether this is a simple field transition, or a color transition.
type: string
enum:
- field
- color
current_value:
readOnly: true
allOf:
- $ref: '#/components/schemas/TransitionValue'
end_value:
readOnly: true
allOf:
- $ref: '#/components/schemas/TransitionValue'
BulbId:
type: object
properties:
device_id:
type: integer
minimum: 0
maximum: 65536
example: 1234
group_id:
type: integer
minimum: 0
maximum: 8
example: 1
device_type:
$ref: '#/components/schemas/RemoteType'
GroupStateCommands:
type: object
properties:
command:
oneOf:
- $ref: '#/components/schemas/GroupStateCommand'
- type: object
properties:
command:
type: string
enum:
- transition
args:
$ref: '#/components/schemas/TransitionArgs'
commands:
type: array
items:
$ref: '#/components/schemas/GroupStateCommand'
example:
- level_up
- temperature_up
GroupState:
type: object
description: Group state
properties:
state:
$ref: '#/components/schemas/State'
status:
$ref: '#/components/schemas/State'
hue:
type: integer
minimum: 0
maximum: 359
description: Color hue. Will change bulb to color mode.
saturation:
type: integer
minimum: 0
maximum: 100
description: Color saturation. Will normally change bulb to color mode.
kelvin:
type: integer
minimum: 0
maximum: 100
description: White temperature. 0 is coolest, 100 is warmest.
temperature:
type: integer
minimum: 0
maximum: 100
description: Alias for `kelvin`.
color_temp:
type: integer
minimum: 153
maximum: 370
description: White temperature measured in mireds. Lower values are cooler.
mode:
type: integer
description: Party mode ID. Actual effect depends on the bulb.
color:
oneOf:
- type: string
pattern: '[0-9]{1,3},[0-9]{1,3},[0-9]{1,3}'
example: '255,255,0'
- type: object
properties:
r:
type: integer
g:
type: integer
b:
type: integer
example:
r: 255
g: 255
b: 0
example:
'255,0,255'
level:
type: integer
minimum: 0
maximum: 100
description: Brightness on a 0-100 scale.
example: 50
brightness:
type: integer
minimum: 0
maximum: 255
description: Brightness on a 0-255 scale.
example: 170
effect:
type: string
enum:
- night_mode
- white_mode
transition:
type: number
description: >
Enables a transition from current state to the provided state.
example: 2.0
RemoteType:
type: string
enum:
- "rgbw"
- "cct"
- "rgb_cct"
- "rgb"
- "fut089"
- "fut091"
- "fut020"
example: rgb_cct
RF24Channel:
type: string
enum:
- LOW
- MID
- HIGH
LedMode:
type: string
enum:
- Off
- Slow toggle
- Fast toggle
- Slow blip
- Fast blip
- Flicker
- On
GroupStateField:
type: string
enum:
- state
- status
- brightness
- level
- hue
- saturation
- color
- mode
- kelvin
- color_temp
- bulb_mode
- computed_color
- effect
- device_id
- group_id
- device_type
- oh_color
- hex_color
description: >
Defines a field which is a part of state for a particular light device. Most fields are self-explanatory, but documentation for each follows:
* `state` / `status` - same value with different keys (useful if your platform expects one or the other).
* `brightness` / `level` - [0, 255] and [0, 100] scales of the same value.
* `kelvin / color_temp` - [0, 100] and [153, 370] scales for the same value. The later's unit is mireds.
* `bulb_mode` - what mode the bulb is in: white, rgb, etc.
* `color` / `computed_color` - behaves the same when bulb is in rgb mode. `computed_color` will send RGB = 255,255,255 when in white mode. This is useful for HomeAssistant where it always expects the color to be set.
* `oh_color` - same as `color` with a format compatible with [OpenHAB's colorRGB channel type](https://www.openhab.org/addons/bindings/mqtt.generic/#channel-type-colorrgb-colorhsb).
* `hex_color` - same as `color` except in hex color (e.g., `#FF0000` for red).
* `device_id` / `device_type` / `group_id` - this information is in the MQTT topic or REST route, but can be included in the payload in the case that processing the topic or route is more difficult.
DeviceId:
type: array
items: {}
example:
- 1234
- "rgb_cct"
- 1
Settings:
type: object
properties:
admin_username:
type: string
description: If spcified along with `admin_password`, HTTP basic auth will be enabled to access all REST endpoints.
default: ""
admin_password:
type: string
description: If spcified along with `admin_username`, HTTP basic auth will be enabled to access all REST endpoints.
default: ""
ce_pin:
type: integer
description: CE pin to use for SPI radio (nRF24, LT8900)
default: 4
csn_pin:
type: integer
description: CSN pin to use with nRF24
default: 15
reset_pin: