-
Notifications
You must be signed in to change notification settings - Fork 1
/
oic.r.luminaire.raml
329 lines (297 loc) · 9.81 KB
/
oic.r.luminaire.raml
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
#%RAML 0.8
#RAML for OIC Collections.
# This is an initial version; has to be converted to a RAML resource type so that it can be used when defining resource that
# are collections. Also needs to use traits to have the same query parameters recognized for all the methods.
title: OCF Luminaire
version: 0.1
documentation:
- title: OCF Luminaire
content: |
Luminaire model using the composite collection resource design
- title: Introduction
content: |
Luminaire modeled after a common lighting capability set,
composed from standard OCF resource types
- title: Resource Design
content: |
The collection resource is specified as three Base URIs, one
for each interface which is supported by the collection
These three URIs are the same URI path, distinguished
by the different query parameter traits
schemas:
- sbaseline: !include schemas/oic.r.luminaire.schema-baseline.json
- sbatch: !include schemas/oic.r.luminaire.schema-b.json
- slinks: !include schemas/oic.r.luminaire.schema-ll.json
traits:
- interface-baseline:
queryParameters:
if:
enum: ["oic.if.baseline"]
- interface-b:
queryParameters:
if:
enum: ["oic.if.b"]
- interface-ll:
queryParameters:
if:
enum: ["oic.if.ll"]
/LuminaireBaselineInterfaceURI:
description: |
OCF Collection Resource Type contains properties and links.
The oic.if.baseline interface exposes a representation of
the links and the properties of the collection resource itself
displayName: OCF Luminaire
is: [ interface-baseline ]
get:
description: |
Retrieve on Baseline Interface
responses:
200:
body:
application/json:
schema: sbaseline
example: |
{
"rt": ["oic.wk.col", "oic.r.luminaire"],
"if": ["oic.if.baseline", "oic.if.b", "oic.if.ll"],
"rts": ["oic.r.binaryswitch", "oic.r.brightness" , "oic.r.colourcontrol", "oic.r.ramptime", "oic.r.actuation"],
"links": [
{
"href": "switch",
"ins": "switch",
"title": "On/Off Switch",
"rt": ["oic.r.binaryswitch"],
"if": ["oic.if.a", "oic.if.baseline"]
},
{
"href": "level",
"ins": "level",
"title": "Brightness Level",
"rt": ["oic.r.brightness"],
"if": ["oic.if.a", "oic.if.baseline"]
},
{
"href": "colorcontrol",
"ins": "colorcontrol",
"title": "Color Control",
"rt": ["oic.r.colourchroma"],
"if": ["oic.if.a", "oic.if.baseline"]
},
{
"href": "colortemperature",
"ins": "colortemperature",
"title": "Color Temperature",
"rt": ["oic.r.colourchroma"],
"if": ["oic.if.a", "oic.if.baseline"]
},
{
"href": "ramptime",
"ins": "ramptime",
"title": "Ramp Time",
"rt": ["oic.r.ramptime"],
"if": ["oic.if.a", "oic.if.baseline"]
},
{
"href": "actuation",
"rel": "actuator",
"ins": "actuation",
"title": "Actuation",
"rt": ["oic.r.actuation", "oic.r.binaryswitch", "oic.r.brightness", "oic.r.colourchroma", "oic.r.ramptime"],
"if": ["oic.if.a", "oic.if.baseline"]
}
]
}
post:
description: |
Update on Baseline Interface
body:
application/json:
schema: sbaseline
responses:
200:
body:
application/json:
schema: sbaseline
/LuminaireBatchInterfaceURI:
description: |
The oic.if.b interfacce exposes a composite representation of the
resources pointed to by the links
displayName: Batch Representation
is: [ interface-b ]
get:
description: |
Retrieve on Batch Interface
responses:
200:
description: "All targets returned OK status (HTTP 200 or CoAP 2.05 Content)"
body:
application/json:
schema: sbatch
example: |
[
{
"href": "switch",
"rep":
{
"value": true
}
},
{
"href": "level",
"rep":
{
"brightness": 77
}
}
]
404:
description: "One or more targets did not return an OK status, return a representation containing returned properties from the targets that returned OK"
body:
application/json:
schema: sbatch
example: |
[
{
"href": "switch",
"rep":
{
"value": false
}
}
]
post:
description: |
Update on Batch Interface
body:
application/json:
schema: sbatch
example: |
[
{
"href": "level",
"rep":
{
"brightness": 100
}
},
{
"href": "colortemperature",
"rep":
{
"ct": 4700
}
},
{
"href": "ramptime",
"rep":
{
"ramptime": 10
}
}
]
responses:
200:
description: "all targets returned OK status (HTTP 200 or CoAP 2.04 Changed) return a representation of the current state of all targets"
body:
application/json:
schema: sbatch
example: |
[
{
"href": "level",
"rep":
{
"brightness": 100
}
},
{
"href": "colortemperature",
"rep":
{
"ct": 4700
}
},
{
"href": "ramptime",
"rep":
{
"ramptime": 10
}
}
]
403:
description: "one or more targets did not return OK status; return a retrieve representation of the current state of all targets in the batch"
body:
application/json:
schema: sbatch
example: |
[
{
"href": "level",
"rep":
{
"brightness": 0
}
}
]
/LuminaireLinkListInterfaceURI:
description: |
The oic.if.ll interface exposes a representation of the links
displayName: Link List Representation
is: [ interface-ll ]
get:
description: |
Retrieve on Link List Interface
responses:
200:
body:
application/json:
schema: slinks
example: |
{
"links": [
{
"href": "switch",
"ins": "switch",
"title": "On/Off Switch",
"rt": ["oic.r.binaryswitch"],
"if": ["oic.if.a", "oic.if.baseline"]
},
{
"href": "level",
"ins": "level",
"title": "Brightness Level",
"rt": ["oic.r.brightness"],
"if": ["oic.if.a", "oic.if.baseline"]
},
{
"href": "colorcontrol",
"ins": "colorcontrol",
"title": "Color Control",
"rt": ["oic.r.colourchroma"],
"if": ["oic.if.a", "oic.if.baseline"]
},
{
"href": "colortemperature",
"ins": "colortemperature",
"title": "Color Temperature",
"rt": ["oic.r.colourchroma"],
"if": ["oic.if.a", "oic.if.baseline"]
},
{
"href": "ramptime",
"ins": "ramptime",
"title": "Ramp Time",
"rt": ["oic.r.ramptime"],
"if": ["oic.if.a", "oic.if.baseline"]
},
{
"href": "actuation",
"rel": "actuator",
"ins": "actuation",
"title": "Actuation",
"rt": ["oic.r.actuation", "oic.r.binaryswitch", "oic.r.brightness", "oic.r.colourchroma", "oic.r.ramptime"],
"if": ["oic.if.a", "oic.if.baseline"]
}
]
}