-
Notifications
You must be signed in to change notification settings - Fork 3
/
API.txt
61 lines (37 loc) · 1.82 KB
/
API.txt
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
PUT http://wlokalu.hswro.org/api/v1/person/<nick>
DELETE http://wlokalu.hswro.org/api/v1/person/<nick>
Person <nick> entered or left premises. PUT can be also replaced with POST
(just for convenience, as normally POST should carry some content).
GET http://wlokalu.hswro.org/api/v1/person
["<nick>", ...]
GET http://wlokalu.hswro.org/api/v1/person/<nick>
{"present": true, "since": 1234567890, "nick": "<nick>"}
{"present": false, "since": null, "nick": "<nick>"}
List presence of people.
NOTE: "since" value for absent person might change to a number.
POST http://wlokalu.hswro.org/api/v1/sensor/<id>
{"state": "<state>"}
Sensor <id> is in state <state>. (simple sensor)
POST http://wlokalu.hswro.org/api/v1/sensor/<id>
{"state": ["<subid>", ...]}
Sensor <id> has following entries: <subid>, ... (complex sensor)
DELETE http://wlokalu.hswro.org/api/v1/sensor/<id>
Delete sensor <id> altogether.
GET http://wlokalu.hswro.org/api/v1/sensor
GET http://wlokalu.hswro.org/api/v1/sensor?simple
GET http://wlokalu.hswro.org/api/v1/sensor?complex
["<id>", ...]
List known sensors, both simple and complex, just simple or just complex.
GET http://wlokalu.hswro.org/api/v1/sensor/<id>
{"state": "<state>", "since": 1234567890, "sensor_id": "<id>"}
["<subid>", ...]
{"state": null, "since": null, "sensor_id": "<id>"}
List sensor's state (simple sensor) or sensor's fields (complex sensor).
Unknown sensors are reported with "state" set to null.
GET http://wlokalu.hswro.org/api/v1/sensor/<id>/<subid>
{"present": true, "since": 1234567890, "sensor_id": "<id>", "field": "<subid>"}
{"present": false, "since": null, "sensor_id": "<id>", "field": "<subid>"}
List state of a field in complex sensor.
NOTE: "since" value for absent field might change to a number.
TODO:
* history (over specific range)