s3lph/spaceapi-server
1
0
Fork 0
Code Issues Pull requests Projects Releases 5 Packages 2 Wiki Activity Actions

Add input/output example to readme

Browse source
This commit is contained in:
s3lph 2019-12-02 22:27:30 +01:00
parent 138234c4a3
commit 45384b2a62
1 changed files with 54 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
README.md
View file

@ -28,6 +28,60 @@ currently open), you can replace parts of the JSON document (anything
except object keys) with [Jinja2 templates][jinja], from which you can except object keys) with [Jinja2 templates][jinja], from which you can
invoke custom plugins, which look up and return your dynamic content. invoke custom plugins, which look up and return your dynamic content.
<table>
<thead>
<tr>
<td>Input</td>
<td>Output</td>
</tr>
</thead>
<tbody>
<tr>
<td>
```json
{
"api": "0.13",
"space": "My Hackerspace",
"state": "{{ space_state() }}",
"sensors": {
"network_connections": "{{ network_connections() }}"
}
}
```
</td>
<td>
```json
{
"api": "0.13",
"state": {
"open": true,
"lastchange": 1575160777,
"message": "Visitors Welcome!"
},
"sensors": {
"network_connections": [
{
"value": 4,
"type": "wifi",
"name": "2.4 GHz"
},
{
"value": 7,
"type": "wifi",
"name": "5 GHz"
}
]
}
}
```
</td>
</tr>
</tbody>
</table>
## Usage ## Usage
### 0. Download ### 0. Download