sbrl-github/Air-Quality-Web
1
0
Fork 0
mirror of https://github.com/ConnectedHumber/Air-Quality-Web synced 2024-11-25 06:53:00 +00:00
Code Issues Releases Wiki Activity

README: Document new device-data API action

Browse source
This commit is contained in:
Starbeamrainbowlabs 2019-01-19 21:19:06 +00:00
parent 39869afea0
commit 8bff9acbd8
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -106,6 +106,17 @@ https://example.com/path/to/api.php?action=device-data-bounds&device-id=18
https://example.com/path/to/api.php?action=device-data-bounds&device-id=11 https://example.com/path/to/api.php?action=device-data-bounds&device-id=11
``` ```
### device-data
> Gets data by device given a start and end time.
Parameter | Type | Meaning
--------------------|-----------|---------------------
`device-id` | int | The id of the device to get data for.
`reading-type` | string | The type of reading to obtain data for.
`start` | datetime | The starting datetime.
`end` | datetime | The ending datetime.
`average-seconds` | int | Optional. If specified, readings will be grouped into lumps of this many seconds and averaged. For example a value of 3600 (1 hour) will return 1 data point per hour, with the value of each point an average of all the readings for that hour.
## Notes ## Notes
- Readings are taken every 6 minutes as standard. - Readings are taken every 6 minutes as standard.