-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathPowerView.yaml
1059 lines (1059 loc) · 33 KB
/
PowerView.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.3
'
info:
title: 'Hunter Douglas PowerView® Hub API for Home Automation Integration'
version: '2.0.0'
servers:
- url: http://{hubAddress}
variables:
hubAddress:
description: 'The hostname or IP address of the PowerView hub'
default: 'PowerView-Hub'
paths:
/api/fwversion:
get:
summary: 'Get firmware version information'
operationId: getFirmwareVersionInformation
tags:
- Firmware Version
responses:
200:
description: 'Firmware version returned.'
content:
application/json:
schema:
$ref: '#/components/schemas/HubFirmware'
423:
description: 'Hub is temporarily busy for maintenance (Always returns UserData).'
500:
description: 'Internal server error.'
/api/homeautomation:
get:
summary: 'Retrieve home automation settings and current state'
operationId: getHomeAutomationSettings
tags:
- Home Automation
- Version 2 Hub Only
description: |
Version 2 Hub Only
- Returns enabled state.
- Returns a configuration number that the hub will increment any time one or more shades fail
position verification. Failure includes a final position that differs significantly from its target
position and a non-responding shade.
- Position verification occurs for all single shade position set and group position set commands
and all scene and scene collection executions.
- Returns time interval used by the hub to delay requesting positions after the hub issues a
PowerView® command to modify positions.
- When a position setting command is received by the hub, if enabled, the hub starts a countdown timer loaded with the value of the timeoutSec option. If the timer is still running
due to a previous position setting command then the timer will be restarted.
- When the countdown timer expires the hub will issue a position request to the shades. If a
single shade is affected then the request will be addressed specifically to this shade. If more
than one shade is affected then the request will be broadcast to all shades in the network. A
nominal four seconds is required to complete the transaction. Multiple attempts to retrieve
position are made, if necessary.
- Returns active as true while the countdown timer is running or the hub is actively requesting
position from the shades.
responses:
200:
description: 'Home automation status and configuration is returned.'
content:
application/json:
schema:
$ref: '#/components/schemas/HomeautoRespObj'
400:
description: 'Bad request.'
423:
description: 'Hub is temporarily busy for maintenance (Always returns UserData).'
500:
description: 'Internal server error.'
put:
summary: 'Configure home automation position verification options'
operationId: configureHomeAutomationPositionVerification
tags:
- Home Automation
- Version 2 Hub Only
description: |
Version 2 Hub Only
- Three parameters may be set: enabled, timeoutSec and configNum. Each parameter is optional.
Any parameter not included in the body of the message is left unchanged in the hub.
- Set enabled to true to configure the hub to verify final shade positions.
- Set configNum. This number defaults to zero from the factory. It is incremented whenever a
shade fails to verify to the correct position after a move. The value is saved in non-volatile
memory.
- Set timeoutSec in seconds. Valid range is between 15 and 300 seconds. This value should be set
to greater than the longest time it takes for any shade in the installation to move from a fully
closed to a fully opened position. Additional time should be allowed to account for a nearly
discharged battery.
requestBody:
description: 'Home automation configuration options'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/HomeautoReqObj'
responses:
200:
description: 'Home automation options successfully updated.'
content:
application/json:
schema:
$ref: '#/components/schemas/HomeautoRespObj'
400:
description: 'Bad request.'
423:
description: 'Hub is temporarily busy for maintenance (Always returns UserData).'
500:
description: 'Internal server error.'
/api/homeautomation/report:
get:
summary: 'Retrieve position information following last move'
operationId: getHomeAutomationReport
tags:
- Home Automation
- Version 2 Hub Only
description: |
Version 2 Hub Only
- Returns list of position data for shades involved in last move.
- For each shade, the last known position before the move, the target position and the reported
position are returned.
- If a shade failed to reach the target position, the state is returned as false. If the move was
successful, the state is returned true.
- If the shade failed to respond to repeated position requests, the timedOut parameter is set to
true.
- The returned list is valid when the homeautomation GET returns active as false.
responses:
200:
description: 'A report of the last move is returned.'
content:
application/json:
schema:
$ref: '#/components/schemas/HomeautomationReportObj'
400:
description: 'Bad request.'
423:
description: 'Hub is temporarily busy for maintenance (Always returns UserData).'
500:
description: 'Internal server error.'
/api/rooms:
get:
summary: 'Get all rooms'
operationId: 'getAllRooms'
tags:
- Rooms
description: |
- Gets a list of all room ids and the corresponding room data.
- The room data is return in the same order as the room ids.
- If no rooms exist, then empty arrays for room ids and room data are returned.
responses:
200:
description: 'Rooms returned.'
content:
application/json:
schema:
$ref: '#/components/schemas/RoomsResponse'
example: |
{
"roomData" : [ {
"colorId" : 18,
"iconId" : 24,
"id" : 7,
"name" : "TmFtZQ==",
"order" : 1,
"type" : 0
} ],
"roomIds" : [ 7 ]
}
400:
description: 'Bad request.'
423:
description: 'Hub is temporarily busy for maintenance (Always returns UserData).'
500:
description: 'Internal server error.'
post:
summary: 'Create a new room'
operationId: 'createNewRoom'
tags:
- Rooms
requestBody:
description: 'Room information. The id value is ignored and should be set to -1'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RoomObject'
example: |
{
"room" : {
"colorId" : 18,
"iconId" : 24,
"id" : -1,
"name" : "TmFtZQ==",
"order" : 1,
"type" : 0
}
}
responses:
201:
description: 'The room was created. id is set to the id of the new room.'
content:
application/json:
schema:
$ref: '#/components/schemas/RoomsResponse'
example: |
{
"room" : {
"colorId" : 18,
"iconId" : 24,
"id" : 7,
"name" : "TmFtZQ==",
"order" : 1,
"type" : 0
}
}
400:
description: 'Bad request.'
423:
description: 'Hub is temporarily busy for maintenance (Always returns UserData).'
500:
description: 'Internal server error.'
/api/rooms/{id}:
get:
summary: 'Get a room'
operationId: 'getARoom'
tags:
- Rooms
parameters:
- name: 'id'
in: path
required: true
schema:
type: integer
description: 'Unique id of the resource.'
responses:
200:
description: 'Room returned.'
content:
application/json:
schema:
$ref: '#/components/schemas/RoomObject'
example: |
{
"room" : {
"colorId" : 18,
"iconId" : 24,
"id" : 7,
"name" : "TmFtZQ==",
"order" : 1,
"type" : 0
}
}
400:
description: 'Bad request.'
404:
description: 'Resource not found.'
423:
description: 'Hub is temporarily busy for maintenance (Always returns UserData).'
500:
description: 'Internal server error.'
put:
summary: 'Update a room'
operationId: 'updateRoom'
tags:
- Rooms
parameters:
- name: 'id'
in: path
required: true
schema:
type: integer
description: 'Unique id of the resource.'
requestBody:
description: 'Updated room information. id must be the same as the value for id in the path.'
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RoomObject'
example: |
{
"room" : {
"colorId" : 18,
"iconId" : 24,
"id" : 7,
"name" : "TmFtZQ==",
"order" : 1,
"type" : 0
}
}
responses:
200:
description: 'The room was updated.'
content:
application/json:
schema:
$ref: '#/components/schemas/RoomsResponse'
example: |
{
"room" : {
"colorId" : 18,
"iconId" : 24,
"id" : 7,
"name" : "TmFtZQ==",
"order" : 1,
"type" : 0
}
}
400:
description: 'Bad request.'
423:
description: 'Hub is temporarily busy for maintenance (Always returns UserData).'
500:
description: 'Internal server error.'
delete:
summary: 'Delete a room'
operationId: 'deleteRoom'
tags:
- Rooms
parameters:
- name: 'id'
in: path
required: true
schema:
type: integer
description: 'Unique id of the resource.'
responses:
204:
description: 'The room was deleted.'
400:
description: 'Bad request.'
423:
description: 'Hub is temporarily busy for maintenance (Always returns UserData).'
500:
description: 'Internal server error.'
# /api/scenecollections:
# get:
/api/userdata:
get:
summary: 'Get user data'
operationId: 'getUserData'
tags:
- User Data
parameters:
- name: 'includeCounts'
in: query
required: false
schema:
type: boolean
description: 'Should counts of database objects, rooms,
shades, scenes, etc, be included in the returned
user data (This is an expensive operation that
should not normally be used).'
responses:
200:
description: User data returned.
content:
application/json:
schema:
$ref: '#/components/schemas/UserDataObject'
400:
description: Bad client request.
423:
description: Hub is temporarily busy for maintenance (Always returns UserData).
500:
description: Internal server error.
components:
schemas:
ActivatedScenes:
type: object
properties:
sceneIds:
description: 'List of activated scenes.'
type: array
items:
$ref: '#/components/schemas/UniqueId'
ActivatedShades:
type: object
properties:
shadeIds:
description: 'List of affected shades.'
type: array
items:
$ref: '#/components/schemas/UniqueId'
AutoBackup:
description: 'When true, backups will be sent periodically to the Hunter Douglas server. Otherwise, no automatic backups will occur.'
type: boolean
BatteryStatus:
description: ' 0 = No Status Available, 1 = Low, 2 = Medium, 3 = High, 4 = Plugged In'
type: number
enum:
- 0
- 1
- 2
- 3
- 4
BatteryStrength:
description: 'The current strength of the battery.'
type: integer
BlinkEnabled:
description: 'Enable repeater blinking.'
type: boolean
Color:
description: 'Specifies the colors of the LEDs.'
type: object
properties:
blue:
description: 'The intensity of the blue portion of the LED.'
type: number
minimum: 0
maximum: 255
example: 155
green:
description: 'The intensity of the green portion of the LED.'
type: integer
minimum: 0
maximum: 255
example: 107
red:
description: 'The intensity of the red portion of the LED.'
type: integer
minimum: 0
maximum: 255
example: 12
brightness:
description: 'The brightness of the LED, Range of 0 to 100%'
minimum: 0
maximum: 100
example: 50
required:
- blue
- green
- red
- brightness
ColorId:
description: 'Id of the resource display color.'
type: integer
format: int32
DeviceTypes:
description: 'Device type (0 = shade, 1 = repeater). If this field is missing, the scene member is assumed to be a shade.'
type: integer
enum:
- 0
- 1
Dns:
description: 'The DNS server IP address used by the hub.'
type: string
EditingEnabled:
description: 'Indicates whether or not the UI should "lock" editing (that is, only allow Scene activation and Shade movement within Rooms).'
type: boolean
EnableScheduledEvents:
description: 'When true, scheduled events should work as expected; when false, scheduled events should not
execute. Note that setting this field to true/false should not impact the "enabled" setting on
individual ScheduledEvents. It is a top-level override.'
type: boolean
Firmware:
properties:
build:
description: 'Patch firmware version number.'
type: integer
minimum: 0
maximum: 65535
example: 564
revision:
description: 'Major firmware version number.'
type: integer
minimum: 0
maximum: 255
example: 2
subRevision:
description: 'Minor firmware version number.'
type: integer
minimum: 0
maximum: 255
example: 0
required:
- build
- revision
- subRevision
Gateway:
description: 'The gateway IP address used by the hub.'
type: string
GroupId:
description: 'Unique id of the associated group.'
type: integer
HomeAutomationActive:
description: 'Returns true when the hub has sent a position set to a shade but the followup position request is not yet complete.'
type: boolean
HomeAutomationConfigNum:
description: 'Unique identified which is incremented whenever a shade fails to move to a position correctly.'
type: integer
HomeAutomationEnabled:
description: 'Position verification is enabled.'
type: boolean
HomeAutomationRequestTimeout:
description: 'Interval between a position set message to shade and a follow up position request.'
type: integer
HomeautoReqObj:
type: object
properties:
homeautomation:
$ref: '#/components/schemas/HomeautoReq'
required:
- homeautomation
HomeautoReq:
type: object
properties:
configNum:
$ref: '#/components/schemas/HomeAutomationConfigNum'
enabled:
$ref: '#/components/schemas/HomeAutomationEnabled'
timeoutSec:
$ref: '#/components/schemas/HomeAutomationRequestTimeout'
HomeautoRespObj:
type: object
properties:
homeautomation:
$ref: '#/components/schemas/HomeautoResp'
required:
- homeautomation
HomeautoResp:
type: object
properties:
active:
$ref: '#/components/schemas/HomeAutomationActive'
configNum:
$ref: '#/components/schemas/HomeAutomationConfigNum'
enabled:
$ref: '#/components/schemas/HomeAutomationEnabled'
timeoutSec:
$ref: '#/components/schemas/HomeAutomationRequestTimeout'
HomeautomationReport:
type: object
properties:
lastPos:
$ref: '#/components/schemas/ShadePosition'
reportedPos:
$ref: '#/components/schemas/ShadePosition'
shadeId:
$ref: '#/components/schemas/ShadeId'
state:
description: 'Returns true of the shade is at target position.'
type: boolean
example: true
targetPos:
$ref: '#/components/schemas/ShadePosition'
timedOut:
description: "Returns true if the shade failed to respond to a position request."
type: boolean
example: false
type:
$ref: '#/components/schemas/ShadeType'
HomeautomationReportObj:
type: object
properties:
report:
type: array
items:
$ref: '#/components/schemas/HomeautomationReport'
required:
- report
HubFirmware:
description: 'There are multiple processors in the hub (the primary processor and the Nordic chip for RF processing); the "mainProcessor" sub-key is intended to indicate that the firmware information being returned is for the main processor on the hub, not the Nordic.'
type: object
properties:
mainProcessor:
$ref: '#/components/schemas/MainProcessorFirmware'
radio:
$ref: '#/components/schemas/Firmware'
required:
- mainProcessor
- radio
HubName:
description: 'Base64-encoded hub name.'
type: string
format: byte
IconId:
description: 'Id of the resource display icon.'
type: integer
format: int32
IpAddress:
type: string
Latitude:
description: 'Latitude.'
type: number
LocalSunriseTimeInMinutes:
description: 'Number of minutes into the day that sunrise occurs (based on lat/long).'
type: integer
LocalSunsetTimeInMinutes:
description: 'Number of minutes into the day that sunset occurs (based on lat/long).'
type: integer
Longitude:
description: 'Longitude.'
type: number
MainProcessorFirmware:
allOf:
- $ref: '#/components/schemas/Firmware'
- properties:
name:
type: string
required:
- name
Mask:
description: 'The network mask used by the hub.'
type: string
Name:
description: 'Base64 encoded name.'
type: string
format: byte
NetworkNumber:
description: 'Unique scene index value loading into a shade.'
type: integer
Offset:
description: 'Number of seconds before or after UTC.'
type: integer
Order:
description: 'Display order of the resource.'
type: integer
format: int32
PositionKind1:
description: 'The type of position - 0 = None, 1 = Primary Rail, 2 = Secondary Rail, 3 = Vane Tilt, 4 = Error.'
type: integer
enum:
- 0
- 1
- 2
- 3
- 4
PositionKind2:
description: 'The type of position - 0 = None, 1 = Primary Rail, 2 = Secondary Rail, 3 = Vane Tilt, 4 = Error.'
type: integer
enum:
- 0
- 1
- 2
- 3
- 4
PositionValue1:
description: 'The value, with 0 = closed and 65535 = open.'
type: integer
minimum: 0
maximum: 65535
PositionValue2:
description: 'The value, with 0 = closed and 65535 = open.'
type: integer
minimum: 0
maximum: 65535
RepeaterId:
description: ' The repeater id associated to this member.'
type: integer
RfID:
description: 'The ID of the RF network on which the hub talks to shades, represented in hexadecimal. 0x1111 or 0xFFFF both mean "no network set.'
type: string
RfIDInt:
description: 'The integer value of the RF network ID on which the hub talks to shades. Values of 4369 or 65535 indicate that no network has been set.'
type: integer
RfStatus:
description: '0 means the hub is not busy; 1 means the hub is busy (discovering shades, joining a network, etc).'
type: integer
enum:
- 0
- 1
Room:
type: object
properties:
colorId:
$ref: '#/components/schemas/ColorId'
iconId:
$ref: '#/components/schemas/IconId'
id:
$ref: '#/components/schemas/UniqueId'
name:
$ref: '#/components/schemas/Name'
order:
$ref: '#/components/schemas/Order'
type:
$ref: '#/components/schemas/RoomType'
required:
- colorId
- iconId
- id
- name
- order
- type
RoomId:
description: 'Unique id of the associated room.'
type: integer
RoomObject:
type: object
properties:
room:
$ref: '#/components/schemas/Room'
required:
- room
RoomType:
description: 'Room type (0 = Regular room, 1 = Repeater Room, 2 = Default Room).'
type: integer
enum:
- 0
- 1
- 2
RoomsResponse:
type: object
properties:
roomData:
type: array
items:
$ref: '#/components/schemas/Room'
roomIds:
type: array
items:
$ref: '#/components/schemas/UniqueId'
required:
- roomData
- roomIds
Scene:
type: object
properties:
colorId:
$ref: '#/components/schemas/ColorId'
iconId:
$ref: '#/components/schemas/IconId'
id:
$ref: '#/components/schemas/UniqueId'
name:
$ref: '#/components/schemas/Name'
networkNumber:
$ref: '#/components/schemas/NetworkNumber'
order:
$ref: '#/components/schemas/Order'
roomId:
$ref: '#/components/schemas/RoomId'
required:
- colorId
- iconId
- id
- name
- networkNumber
- order
- roomId
SceneCollection:
type: object
properties:
colorId:
$ref: '#/components/schemas/ColorId'
iconId:
$ref: '#/components/schemas/IconId'
id:
$ref: '#/components/schemas/UniqueId'
name:
$ref: '#/components/schemas/Name'
order:
$ref: '#/components/schemas/Order'
required:
- colorId
- iconId
- id
- name
- order
SceneCollectionId:
description: 'The id of the scene collection to which this member belongs.'
type: integer
SceneCollectionObject:
type: object
properties:
sceneCollection:
$ref: '#/components/schemas/SceneCollection'
required:
- sceneCollection
SceneCollectionsResponse:
type: object
properties:
sceneCollectionData:
type: array
items:
$ref: '#/components/schemas/SceneCollection'
sceneCollectionIds:
type: array
items:
$ref: '#/components/schemas/UniqueId'
required:
- sceneCollectionData
- sceneCollectionIds
SceneObject:
type: object
properties:
scene:
$ref: '#/components/schemas/Scene'
required:
- scene
ScenesResponse:
type: object
properties:
sceneData:
description: 'Scene data for included scenes.'
type: array
items:
$ref: '#/components/schemas/Scene'
sceneIds:
description: 'Unique ids of all scenes.'
type: array
items:
$ref: '#/components/schemas/UniqueId'
required:
- sceneData
- sceneIds
SerialNumber:
description: 'The unique id/serial number of the hub or device.'
type: string
SetupComplete:
description: 'Indicates whether the initial setup of a hub has been completed.'
type: boolean
Shade:
type: object
properties:
batteryStatus:
$ref: '#/components/schemas/BatteryStatus'
batteryStrength:
$ref: '#/components/schemas/BatteryStrength'
firmware:
$ref: '#/components/schemas/ShadeFirmware'
groupId:
$ref: '#/components/schemas/GroupId'
id:
$ref: '#/components/schemas/UniqueId'
name:
$ref: '#/components/schemas/Name'
order:
$ref: '#/components/schemas/Order'
positions:
$ref: '#/components/schemas/ShadePosition'
roomId:
$ref: '#/components/schemas/RoomId'
secondaryName:
$ref: '#/components/schemas/ShadeSecondaryName'
type:
$ref: '#/components/schemas/ShadeType'
required:
- batteryStatus
- batteryStrength
- id
- type
ShadeData:
type: object
properties:
id:
$ref: '#/components/schemas/UniqueId'
type:
$ref: '#/components/schemas/ShadeType'
required:
- id
- type
ShadeFirmware:
allOf:
- $ref: '#/components/schemas/Firmware'
- properties:
index:
description: 'The index number.'
type: integer
example: 25
required:
- index
ShadeId:
description: 'The id of the associated shade.'
type: integer
ShadeObject:
type: object
properties:
shade:
$ref: '#/components/schemas/Shade'
required:
- shade
ShadePosition:
description: |
Specifies the position of the shade. Top-down shades are in the same coordinate space as bottom-up
shades. Shade position values for top-down shades would be reversed for bottom-up shades. For
example, since 65535 is the open value for a bottom-up shade, it is the closed value for a top-down
shade. The top-down/bottom-up shade is different in that instead of the top and bottom rail
operating in one coordinate space like the top-down and the bottom-up, it operates in two where
the top (middle) rail closed value is 0 and the bottom (primary) rail closed position is also 0 and
fully open for both is 65535.
type: object
properties:
posKind1:
$ref: '#/components/schemas/PositionKind1'
posKind2:
$ref: '#/components/schemas/PositionKind2'
position1:
$ref: '#/components/schemas/PositionValue1'
position2:
$ref: '#/components/schemas/PositionValue2'
required:
- posKind1
- position1
ShadeRequest:
allOf:
- $ref: '#/components/schemas/Shade'
- properties:
timedOut:
description: 'Did the shade not respond to the request.'
type: boolean
example: true
required:
- timedOut
ShadeRequestObject:
type: object
properties:
shade:
$ref: '#/components/schemas/ShadeRequest'
required:
- shade
ShadeSecondaryName:
description: The secondary name of the shade base64 encoded. Used by the Apple Home application as the secondary service name to control shades with blackout blinds or a top rail movement.'
type: string
format: byte
ShadeType:
description: 'The shade type.'
type: integer
ShadeUpdate:
type: object
properties:
motion:
description: 'The motion operation to perform on a shade or group.'
type: string
enum:
- down
- heart
- jog
- leftTilt
- rightTilt
- stop
- up
example: 'jog'
positions:
$ref: '#/components/schemas/ShadePosition'
ShadesResponse:
type: object
properties:
shadeData:
description: 'Shade data for the included shades.'
type: array
items:
$ref: '#/components/schemas/Shade'
shadeIds:
description: 'Unique ids of all shades.'
type: array
items:
$ref: '#/components/schemas/UniqueId'
required:
- shadeData
- shadeIds
StaticIp:
description: 'True, if a static IP is assigned to the hub. False, if DHCP was used for IP address assignment.'
type: boolean
Times:
properties:
currentOffset:
$ref: '#/components/schemas/Offset'
latitude:
$ref: '#/components/schemas/Latitude'
localSunriseTimeInMinutes:
$ref: '#/components/schemas/LocalSunriseTimeInMinutes'
localSunsetTimeInMinutes:
$ref: '#/components/schemas/LocalSunsetTimeInMinutes'
longitude:
$ref: '#/components/schemas/Longitude'
timezone:
$ref: '#/components/schemas/Timezone'
required:
- currentOffset
- timezone
Timezone:
description: 'Timezone name.'
type: string
UniqueId:
description: 'Unique resource identifier.'
type: integer
UserData:
type: object
properties:
autoBackup:
$ref: '#/components/schemas/AutoBackup'
color:
description: 'Specifies the color of the repeater LEDs.'
$ref: '#/components/schemas/Color'
dns:
$ref: '#/components/schemas/Dns'
editingEnabled:
$ref: '#/components/schemas/EditingEnabled'
enableScheduledEvents:
$ref: '#/components/schemas/EnableScheduledEvents'
firmware:
$ref: '#/components/schemas/HubFirmware'
gateway:
$ref: '#/components/schemas/Gateway'
hubName:
$ref: '#/components/schemas/HubName'
ip:
$ref: '#/components/schemas/IpAddress'
localTimeDataSet:
description: 'Whether or not time has been by the app or RemoteConnect.'
type: boolean
macAddress: