forked from nougad/velux-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
346 lines (346 loc) · 9.13 KB
/
swagger.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
---
consumes:
- application/json
info:
title: Velux Active with Netatmo
version: 0.2.0
paths:
"/syncapi/v1/setstate":
post:
operationId: setState
parameters:
- name: body
in: body
required: true
schema:
"$ref": "#/definitions/setState"
responses:
403:
description: Forbidden
schema:
type: object
properties:
error:
type: object
properties:
code: { type: integer } # 3
message: { type: string }
200:
description: set state response
schema:
type: object
properties:
status:
type: string
time_server:
type: integer
security:
- OAuth2: []
"/syncapi/v1/homestatus":
post:
operationId: homeStatus
parameters:
- name: body
in: body
required: true
schema:
type: object
required: [home_id]
properties:
home_id:
type: string
responses:
403:
description: Forbidden
schema:
type: object
properties:
error:
type: object
properties:
code: { type: integer } # 3
message: { type: string }
200:
description: set state response
schema:
type: object
properties:
status:
type: string
time_server:
type: integer
body:
type: object
properties:
home:
$ref: "#/definitions/homeStatus"
security:
- OAuth2: []
"/api/homesdata":
post:
operationId: homesData
responses:
403:
description: Forbidden
schema:
type: object
properties:
error:
type: object
properties:
code: { type: integer } # 3
message: { type: string }
200:
description: get homes data
schema:
type: object
properties:
status:
type: string
time_exec:
type: number
time_server:
type: integer
body:
type: object
properties:
homes:
type: array
items:
$ref: "#/definitions/home"
user:
$ref: "#/definitions/user"
security:
- OAuth2: []
definitions:
homeStatus:
type: object
properties:
id: { type: string }
modules:
type: array
items:
$ref: "#/definitions/moduleStatus"
rooms:
type: array
items:
$ref: "#/definitions/roomStatus"
moduleStatus:
type: object
properties:
current_position: { type: integer }
firmware_revision: { type: integer }
id: { type: string }
manufacturer: { type: string }
mode: { type: string }
type: { type: string }
velux_type: { type: string }
bridge: { type: string }
last_seen: { type: integer }
target_position: { type: integer }
reachable: { type: boolean }
battery_state: { type: string }
battery_level: { type: integer }
battery_percent: { type: integer }
rf_strength: { type: integer }
wifi_strength: { type: integer }
algo_enabled: { type: boolean }
busy: { type: boolean }
calibrating: { type: boolean }
firmware_revision_netatmo: { type: integer }
firmware_revision_thirdparty: { type: string }
is_raining: { type: boolean }
locked: { type: boolean }
locking: { type: boolean }
name: { type: string }
pairing: { type: string }
secure: { type: boolean }
roomStatus:
type: object
properties:
algo_status: { type: integer }
auto_close_ts: { type: integer }
id: { type: string }
air_quality: { type: integer }
co2: { type: integer }
humidity: { type: integer }
lux: { type: integer }
max_comfort_co2: { type: integer }
max_comfort_humidity: { type: integer }
max_comfort_temperature: { type: integer }
min_comfort_humidity: { type: integer }
min_comfort_temperature: { type: integer }
temperature: { type: integer }
home:
type: object
properties:
id: { type: string }
name: { type: string }
altitude: { type: integer }
country: { type: string }
timezone: { type: string }
currency_code: { type: string }
nb_users: { type: number }
therm_absence_notification: { type: boolean }
therm_absence_autoaway: { type: boolean }
therm_setpoint_default_duration: { type: number }
anticipation: { type: boolean }
therm_heating_priority: { type: string }
gone_after: { type: number }
share_info: { type: boolean }
smart_notifs: { type: boolean }
events_ttl: { type: string }
therm_mode: { type: string }
coordinates:
type: array
items:
type: number
invitation_code:
type: array
items:
type: string
rooms:
type: array
items:
type: object
properties:
id: { type: string }
name: { type: string }
type: { type: string }
module_ids:
type: array
items:
type: string
modules:
type: array
items:
type: string
measure_offset_NAPlug_temperature: { type: integer }
measure_offset_NAPlug_estimated_temperature: { type: integer }
modules:
type: array
items:
type: object
properties:
id: { type: string }
type: { type: string }
name: { type: string }
subtype: { type: string }
setup_date: { type: integer }
reachable: { type: boolean }
pincode_enabled: { type: boolean }
room_id: { type: string }
bridge: { type: string }
schedule_limits:
type: array
items:
type: object
properties:
nb_zones: { type: integer }
nb_timeslots: { type: integer }
nb_items: { type: integer }
type: { type: string }
schedules:
type: array
items:
$ref: "#/definitions/schedule"
schedule:
type: object
properties:
timetable:
type: array
items:
type: object
properties:
zone_id: { type: integer }
m_offset: { type: integer }
zones:
type: array
items:
type: object
properties:
id: { type: integer }
rooms:
type: array
items:
type: object
properties:
id: { type: string }
mode: { type: string }
name: { type: string }
id: { type: string }
type: { type: string }
default: { type: boolean }
selected: { type: boolean }
timetable_sunrise:
type: array
items:
type: object
timetable_sunset:
type: array
items:
type: object
user:
type: object
properties:
email: { type: string }
language: { type: string }
locale: { type: string }
country: { type: string }
feel_like_algorithm: { type: integer }
unit_pressure: { type: integer }
unit_system: { type: integer }
unit_wind: { type: integer }
all_linked: { type: boolean }
type: { type: string }
id: { type: string }
fb_chatbot_available: { type: boolean }
app_telemetry: { type: boolean }
velux_type: { type: string }
group_id: { type: string }
modules_bridged:
type: array
items:
type: string
setState:
type: object
properties:
home:
type: object
required: [id, modules]
properties:
id:
type: string
modules:
type: array
items:
$ref: "#/definitions/modulePercentage"
modulePercentage:
type: object
properties:
bridge:
description: bridge id
type: string
id:
description: module id
type: string
target_position:
description: percentage open
type: integer
x-nullable: true
securityDefinitions:
OAuth2:
type: oauth2
flow: password
tokenUrl: https://app.velux-active.com/oauth2/token?user_prefix=velux
scopes:
all_scopes: all scopes
access_velux: access_velux
read_velux: read_velux
write_velux: write_velux
produces:
- application/json
schemes:
- https
host: api.netatmo.net
swagger: '2.0'