ITQC/gls_docs
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Docu

Browse Source
This commit is contained in:
Fabian Märki
2015-08-21 10:28:42 +02:00
parent 9a6b9de4d9
commit cbe2bef4c0
1 changed files with 121 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

124
Readme.md
View File

@ -48,7 +48,7 @@ POST http://<host>:<port>/channels
### Example ### Example
``` ```bash
curl -H "Content-Type: application/json" -X POST -d '{"regex": "TRFCA|TRFCB"}' http://sf-nube-14.psi.ch:8080/channels curl -H "Content-Type: application/json" -X POST -d '{"regex": "TRFCA|TRFCB"}' http://sf-nube-14.psi.ch:8080/channels
``` ```
@ -83,7 +83,7 @@ There exist following fields:
### Example ### Example
``` ```bash
curl -H "Content-Type: application/json" -X POST -d '{"channels":["channel1","channel2"],"startPulseId":0,"endPulseId":4}' http://sf-nube-14.psi.ch:8080/query curl -H "Content-Type: application/json" -X POST -d '{"channels":["channel1","channel2"],"startPulseId":0,"endPulseId":4}' http://sf-nube-14.psi.ch:8080/query
``` ```
@ -148,4 +148,122 @@ The response is in JSON.
### Example JSON Queries ### Example JSON Queries
**TODO:** Following examples build on this data:
```
[
{
"channel":"Channel_01",
"data":[
{
"iocMillis":0,
"iocNanos":0,
"pulseId":0,
"globalMillis":0,
"globalNanos":0,
"shape":[
4
],
"value":[
1,
2,
3,
4
]
},
{
"iocMillis":10,
"iocNanos":0,
"pulseId":1,
"globalMillis":10,
"globalNanos":0,
"shape":[
4
],
"value":[
2,
3,
4,
5
]
},
{
"iocMillis":20,
"iocNanos":0,
"pulseId":2,
"globalMillis":20,
"globalNanos":0,
"shape":[
4
],
"value":[
3,
4,
5,
6
]
},
{
"iocMillis":30,
"iocNanos":0,
"pulseId":3,
"globalMillis":30,
"globalNanos":0,
"shape":[
4
],
"value":[
4,
5,
6,
7
]
}
]
}
]
```
Visualized as:
![Visualized data][doc/images/Data_Visualization.png]
#### Query by Pulse-Id
```
{
"startPulseId":0,
"endPulseId":3,
"channels":[
"Channel_01"
]
}
```
#### Query by Time
```
{
"startMillis":0,
"startNanos":0,
"endMillis":30,
"endNanos":999999,
"channels":[
"Channel_01"
]
}
```
#### Query by Date
```
{
"startDate":"1970/01/01 01:00:00.000",
"startNanos":0,
"endDate":"1970/01/01 01:00:00.030",
"endNanos":999999,
"channels":[
"Channel_01"
]
}
```