-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathapiary.apib
630 lines (469 loc) · 24.5 KB
/
apiary.apib
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
FORMAT: 1A
HOST: http://www.google.com
# SensorDefinitionAPI (DRAFT)
An API for defining Sensors. We define both data about the physical sensor itself, and MetaData about the information the Sensor delivers
**This is a draft document. We welcome feedback, criticisms and suggestions. Currently the best place to do that is on the GitHub Page**
*You can view the definition in it's raw form on Github, or beautifully rendered by Apiary:*
- http://docs.sensordefinitionapi.apiary.io/
- https://github.com/relayr/SensorDefinitionAPI
This API is released under the [Creative Commons Attribution 4.0 International (CC BY 4.0)](http://creativecommons.org/licenses/by/4.0/)
# Group General
## Sensor Definitions Collection [/sensordefinitions]
The system contains a list of a number of sensor definitions.
This endpoint will return a list of the existing sensors,
add or delete sensors or modify a sensor within the list.
+ Model
+ Body
{
"_links": {
"self": {"href": "http://example.org/sensors"},
"first": { "href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456790" },
"last": { "href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456792" }
},
"count" : 4,
"_embedded": {
"sensors" : [
{
"_links": {
"self": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456789"},
"hardware": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456789/hardware"},
"firmware": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456789/firmware"},
"communication": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456789/communication"},
"readings": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456789/readings"},
"documentation" : {"href" : "http://example.org/documentation/wunderbar/sensors/temp-humidity"}
},
"id" : '550e8400-e29b-41d4-a716-446655456789',
"manufacturer" : relayr,
"name": 'Temperature / Humidity Sensor',
"productNumber" : "rWB001"
},{
"_links": {
"self": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456790"},
"hardware": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456790/hardware"},
"firmware": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456790/firmware"},
"communication": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456790/communication"},
"readings": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456790/readings"},
"documentation" : {"href" : "http://example.org/documentation/wunderbar/sensors/sound"}
},
"id" : '550e8400-e29b-41d4-a716-446655456790',
"manufacturer" : relayr,
"name": 'Sound Level Sensor',
"productNumber" : "rWB002"
},{
"_links": {
"self": { "href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456791"},
"hardware": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456791/hardware"},
"firmware": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456791/firmware"},
"communication": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456791/communication"},
"readings": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456791/readings"},
"documentation" : {"href" : "http://example.org/documentation/wunderbar/sensors/acc-gyro"}
},
"id" : '550e8400-e29b-41d4-a716-446655456791',
"manufacturer" : relayr,
"name": 'Accelerometer / Gyrosope',
"productNumber" : "rWB003"
},{
"_links": {
"self": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456792"},
"hardware": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456792/hardware"},
"firmware": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456792/firmware"},
"communication": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456792/communication"},
"readings": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456792/readings"},
"documentation" : {"href" : "http://example.org/documentation/wunderbar/sensors/light-color-prox"}
},
"id" : '550e8400-e29b-41d4-a716-446655456792',
"manufacturer" : relayr,
"name": 'Light / Color / Proximity Sensor',
"productNumber" : "rWB003"
}]
}
}
### Retreives a list of sensor definitions - for multiple sensors [GET]
+ Response 200 (application/hal+json)
[Sensor Definitions Collection][]
### Adds a sensor to the list [POST]
+ Request (application/json)
{
"manufacturer" : relayr,
"name": 'Light / Color / Proximity Sensor',
"productNumber" : "rWB003"
}
+ Response 201 (application/hal+json)
+ Body
{
"_links": {
"self": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456792"},
"hardware": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456792/hardware"},
"firmware": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456792/firmware"},
"communication": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456792/communication"},
"readings": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456792/readings"}
},
"id" : '550e8400-e29b-41d4-a716-446655456792'
"manufacturer" : relayr,
"name": 'Light / Color / Proximity Sensor',
"productNumber" : "rWB003"
}
## Sensor Definition [/sensordefinitions/{sensorID}]
+ Model
+ Body
{
"_links": {
"self": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456792"},
"hardware": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456792/hardware"},
"firmware": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456792/firmware"},
"communication": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456792/communication"},
"readings": {"href": "http://example.org/sensors/550e8400-e29b-41d4-a716-446655456792/readings"}
},
"id" : '550e8400-e29b-41d4-a716-446655456792'
"manufacturer" : relayr,
"name": 'Light / Color / Proximity Sensor',
"productNumber" : "rWB003"
}
### Returns a list of sensor definitions for a specific sensor [GET]
+ Response 200 (application/hal+json)
[Sensor Definition][]
### Modifies a specific sensor in the list [PATCH]
+ Parameters
+ sensorID (required, string, `550e8400-e29b-41d4-a716-446655456789`) ... String `id` of the Sensor
+ Request (application/json)
{
"name" : 'Temperature & Humidity Sensor'
}
+ Response 200 (application/hal+json)
[Sensor Definition][]
### Removes a sensor from the list [DELETE]
+ Parameters
+ sensorID (required, string, `550e8400-e29b-41d4-a716-446655456789`) ... String `id` of the Sensor
+ Response 204
# Group Hardware
Hardware related resource of the **Sensor Definition**
## Hardware Definition [/sensordefinitions/{sensorID}/hardware]
+ Parameters
+ sensorID (required, string, `550e8400-e29b-41d4-a716-446655456789`) ... String `id` of the Sensor
+ Model (application/hal+json)
+ Headers
Link: <http:/example.org/sensor/550e8400-e29b-41d4-a716-446655456789/description/hardware>;rel="self"
+ Body
{
"_links": {
"self": {
"href": "http://example.org/sensor/550e8400-e29b-41d4-a716-446655456789/description/hardware",
"datasheet": "http://example.org/sensor/550e8400-e29b-41d4-a716-446655456789/datasheet.pdf",
"parent" : {"href": "http://example.org/sensor/550e8400-e29b-41d4-a716-446655456789"}
}
}
"date": 1398512005,
"voltage-range": {min: 2700, max: 4900, unit: "mV"},
"power": "CR3032 coin-cell",
"IOconnectors": {
"usb": ["USB-2.0-microB"],
"audio": ["3.5mm-stereo-out", "3.5mm-mono-mic"],
"ethernet": ["RJ-45"],
"1.25mm-pin-header": {
"gpio": ["6pin"],
"bus": ["I2C", "UART"]
}
},
"onboard-sensors": {"gyro/accelerometer", "barometer"},
"program-debug": {“10-pin-1.25mm": "SWD"},
"wireless": {"BluetoothLE"]};
"release-notes": "lorem ipsum",
"output": {"video": ["HDMI"], "audio":["spdif", "analog"], digital: ["pwm", "gpio"]},
"dimensions": {width:23, height: 15, depth: 45, units: "mm"}
}
### Read current Hardware definition [GET]
+ Response 200 (application/hal+json)
[Hardware Definition][]
### Create current Hardware definition [POST]
+ Request
+ Body
{
date: 1398512005,
voltage: "3.3v",
release-notes: "lorem ipsum"
}
+ Response 201 (application/hal+json)
[Hardware Definition][]
### Update current Hardware definition [PATCH]
+ Request
+ Body
{
power: "CR3032 coin-cell",
release-notes: "lorem ipsum delor"
}
+ Response 200 (application/hal+json)
[Hardware Definition][]
### Delete current Hardware definition [DELETE]
+ Response 204
# Group Firmware
Firmware related resource of the **Sensor Definition**.
Manufacturers are notoriously slow at releasing firmware updates, often third party suppliers have a better update cycle.
The API expects to maintain a history of Firmare updates, that may include stable, latest and nighty builds.
A firmware update has the followng structure:
**version** *String* is used as a unique identifier for the specific piece of software
**date** *Timestamp* identifies the relase date of the firmware
**name** *String* if the release has a name
**supplier** *String* The name of the firmware update - as mentioned Manufacturer are not the only suppliers of firmware upgrades
**release-notes** *String* The relase notes for a release. Currently no Format is specified, however Mardown seems like a good choice
## Firmware [/sensordefinitions/{sensorID}/firmware]
+ Parameters
+ sensorID (required, string, `550e8400-e29b-41d4-a716-446655456789`) ... String `id` of the Sensor
+ Model (application/hal+json)
+ Headers
Link: <http:/example.org/sensor/550e8400-e29b-41d4-a716-446655456789/description/firmware>;rel="self"
+ Body
{
"_links": {
"self": {
"href": "http://example.org/sensor/550e8400-e29b-41d4-a716-446655456789/description/firmware"
}
"download": {"href": "http://example.org/downloads/550e8400-e29b-41d4-a716-446655456789_0.1.zip" },
"history" : {"href": "http://example.org/sensor/550e8400-e29b-41d4-a716-446655456789/description/firmware/history"},
"parent" : {"href": "http://example.org/sensor/550e8400-e29b-41d4-a716-446655456789"}
}
"version": "0.2",
"date": 1398512005,
"name": "RC1",
"supplier": "relayr",
"release-notes": "lorem ipsum"
}
### Read current Firmware release [GET]
To get the current recommended version of the firmware use this endpoint. For other relases use the history endpoint
+ Response 200 (application/hal+json)
[Firmware][]
### Set current Firmware release [POST]
To update the current firmware, you can post here.
If the firmware release is already in the history, you can provide just the version number.
If the release has not previously been uploaded, it will be automatically added to the firmware history.
+ Request
+ Body
{
"version": "0.01",
"date": 13985412005,
"name": "RC1",
"supplier": "relayr",
"release-notes": "lorem ipsum"
}
+ Response 201 (application/hal+json)
[Firmware][]
## Firmware History [/sensordefinitions/{sensorID}/firmware/history/{version}]
The Firmware History displays a list of firmware relases for the device.
This will include current firmware, as well as Release candidates, Nightlies and legacy releases.
+ Parameters
+ sensorID (required, string, `550e8400-e29b-41d4-a716-446655456789`) ... String `id` of the Sensor
+ Model (application/hal+json)
HAL+JSON representation of Gist Collection Resource. The Gist resources in collections are embedded. Note the embedded Gists resource are incomplete representations of the Gist in question. Use the respective Gist link to retrieve its full representation.
+ Headers
Link: <http://example.org/sensor/550e8400-e29b-41d4-a716-446655456789/description/firmware/history>;rel="self"
+ Body
{
"_links": {
"self": { "href": "/sensor/550e8400-e29b-41d4-a716-446655456789/description/firmware/history" }
"latest": { "href": "/sensor/550e8400-e29b-41d4-a716-446655456789/description/firmware" },
"stable": { "href": "/sensor/550e8400-e29b-41d4-a716-446655456789/description/firmware/history/0.1" },
"nightly": { "href": "/sensor/550e8400-e29b-41d4-a716-446655456789/description/firmware/history/0.1" },
},
"_embedded": {
"history": [
{
"_links" : {
"self": { "href": "/sensor/550e8400-e29b-41d4-a716-446655456789/description/firmware/history/0.1" },
"download": { "href": "http://example.org/downloads/550e8400-e29b-41d4-a716-446655456789_0.1.zip" },
"parent" : {"href": "http://example.org/sensor/550e8400-e29b-41d4-a716-446655456789"}
},
"version": "0.1",
"date": 1398512005,
"name": "RC1",
"supplier" : "relayr",
"release-notes": "lorem ipsum"
}
]
},
"total": 1
}
### Read Firmware History [GET]
Returns a full list of releases.
The Links component contains links to interesting relases.
+ Response 200 (application/hal+json)
[Firmware History][]
### Create a Firmware release to the history [POST]
+ Request
+ Body
{
"version": "0.01",
"date": 13985412005,
"name": "RC1",
"supplier": "relayr",
"release-notes": "lorem ipsum"
}
+ Response 201 (application/hal+json)
[Firmware][]
### Update a Firmware release [PATCH]
+ Parameters
+ sensorID (required, string, `550e8400-e29b-41d4-a716-446655456789`) ... String `id` of the Sensor
+ version (required, string, `0.1`) ... String `version number` of the Firmware release
+ Request
+ Body
{
"name": "RC1"
}
+ Response 200 (application/hal+json)
[Firmware][]
### Delete a Firmware release [DELETE]
+ Parameters
+ sensorID (required, string, `550e8400-e29b-41d4-a716-446655456789`) ... String `id` of the Sensor
+ version (required, string, `0.1`) ... String `version number` of the Firmware release
+ Response 204
# Group Communcation
Communication related resource of the **Sensor Definition**
## Communication Definition [/sensordefinitions/{sensorID}/communications]
+ Parameters
+ sensorID (required, string, `550e8400-e29b-41d4-a716-446655456789`) ... String `id` of the Sensor
+ Model (application/hal+json)
+ Headers
Link: <http:/example.org/sensor/550e8400-e29b-41d4-a716-446655456789/communication>;rel="self"
+ Body
{
"_links": {
"self": {
"href": "http://example.org/sensor/550e8400-e29b-41d4-a716-446655456789/communication",
"parent" : {"href": "http://example.org/sensor/550e8400-e29b-41d4-a716-446655456789"}
}
}
"protocol" : {"name":"MQTT", "version":"3.1", "transport": "tcp/ip"},
"encryption" : "TLS 1.2",
"physical": ["ethernet", "wifi"]
}
### Read current Communication definition [GET]
+ Response 200 (application/hal+json)
[Communication Definition][]
### Create current Communication definition [POST]
+ Request
+ Body
{
"protocol" : {"name":"MQTT"},
"encryption" : "TLS 1.2"
}
+ Response 201 (application/hal+json)
[Communication Definition][]
### Update current Communication definition [PATCH]
+ Request
+ Body
{
"protocol" : {"name":"MQTT", "verion":"3.1.1"},
"encryption" : "TLS 1.2"
}
+ Response 200 (application/hal+json)
[Communication Definition][]
### Delete current Communication definition [DELETE]
+ Response 204
# Group Readings
Sensors can deliver many differnet readings. For example the Wunderbar uses the Meas-Spec HPP828E031 for the Tempertaure / humidity sensor. It is a single chip which can provide both readings.
Typically the device sends the readings as a unitary value which must then be parsed. by the recevier of the data.
Values sent will typically be a `Number`with no additional Information. This makes it naturally difficult for a developer to interpret. To give meaning to the number we provide metadata about the reading.
Within Electrical Engineering the term `meaning`is used to explain waht is being measured, for instance "Temperature or Humidity"
Combining this with `units` gives the developer enough information to understand what the value is.
To evaluate the fitness of a reading for the intended purpose we provide three values `max` and `min` tell the developer which range of readings he can expect, and `precision`tell him which level of precision to expect from the sensor.
**id** *String*
**meaning** *String*
**minimum** *Number*
**maximum** *Number*
**units** *String*
**precision** *Number (float)*
## Sensor Reading Definitions [/sensordefinitions/{sensorID}/readings]
A SensorDefinition must be able to provide a list of the readings offered by the device it represents.
### Get list of reading definitions available from of a sensor [GET]
returns a list of readings as hal+json, with links to navigate the collection, as well as a total length, and the values stored in embedded
+ Parameters
+ sensorID (required, string, `550e8400-e29b-41d4-a716-446655456789`) ... String `id` of the Sensor
+ Response 200 (application/hal+json)
+ Body
{
"_links": {
"self": { "href": "/sensor/550e8400-e29b-41d4-a716-446655456789/description/readings" },
"first": { "href": "/sensor/550e8400-e29b-41d4-a716-446655456789/description/readings/550e8400-e29b-41d4-a716-446655456711" },
"last": { "href": "/sensor/550e8400-e29b-41d4-a716-446655456789/description/readings/550e8400-e29b-41d4-a716-446655456781" }
},
"_embedded": {
"readings" : [{
"_links" : {
"self": { "href": "/sensor/550e8400-e29b-41d4-a716-446655456789/description/readings/550e8400-e29b-41d4-a716-446655456711" },
"parent" : {"href": "http://example.org/sensor/550e8400-e29b-41d4-a716-446655456789"}
},
"id" : '550e8400-e29b-41d4-a716-446655456711',
"meaning" : 'temperature'
"minimum" : -100,
"maximum": 100,
"units" : "celsius",
"precision" : 0.01
},{
"_links" : {
"self": { "href": "/sensor/550e8400-e29b-41d4-a716-446655456711/description/readings/550e8400-e29b-41d4-a716-446655456781" },
"parent" : {"href": "http://example.org/sensor/550e8400-e29b-41d4-a716-446655456789"}
},
"id" : '550e8400-e29b-41d4-a716-446655456781',
"meaning" : 'humidity'
"minimum" : 0,
"maximum": 100,
"units" : "% Relative Humidity",
"precision" : 0.01
}]
},
"count": 2
}´
### Create a reading definition [POST]
Adds a Reading to the list
+ Request (application/json)
{
"meaning" : 'humidity'
"minimum" : 0,
"maximum": 100,
"units" : "% Relative Humidity",
"precision" : 0.01
}
+ Response 201 (application/hal+json)
+ Body
{
"_links" : {
"self": { "href": "/sensor/550e8400-e29b-41d4-a716-446655456789/readings/550e8400-e29b-41d4-a716-446655456781" },
"parent" : {"href": "http://example.org/sensor/550e8400-e29b-41d4-a716-446655456789"}
},
"id" : '550e8400-e29b-41d4-a716-446655456781',
"meaning" : 'humidity',
"minimum" : 0,
"maximum": 100,
"units" : "% Relative Humidity",
"precision" : 0.01
}
## Reading [/sensordefinitions/{sensorID}/readings/{readingID}]
+ Parameters
+ readingID (required, string, `550e8400-e29b-41d4-a716-446655456777`) ... String `id` of the Sensor
+ Model
+ Body
{
"_links" : {
"self": { "href": "/sensor/550e8400-e29b-41d4-a716-446655456789/description/readings/550e8400-e29b-41d4-a716-446655456777" },
"parent" : {"href": "http://example.org/sensor/550e8400-e29b-41d4-a716-446655456789"}
},
"id" : '550e8400-e29b-41d4-a716-446655456777',
"meaning" : 'temperature'
"minimum" : -100,
"maximum": 100,
"units" : "celsius",
"precision" : 0.01
}
### Get a reading definition from of a sensor [GET]
Get an individual reading
+ Response 200 (application/hal+json)
[Reading][]
### Update a reading definition [PATCH]
Modifies a reading
+ Request (application/json)
{
"maximum" : 120
}
+ Response 200 (application/hal+json)
[Reading][]
### Delete a reading definition [DELETE]
removes a reading from the list
+ Response 204