sbrl-github
/
Air-Quality-Web
mirror of https://github.com/ConnectedHumber/Air-Quality-Web
1
0
Fork 0
Code Issues Releases Wiki Activity

README: Document new API action

This commit is contained in:
Starbeamrainbowlabs 2019-01-18 21:51:40 +00:00
parent 575a6b1dd6
commit 11f54d1bd5
Signed by: sbrl
GPG Key ID: 1BE5172E637709C2
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -75,6 +75,20 @@ https://example.com/path/to/api.php?action=list-devices
https://example.com/path/to/api.php?action=list-devices&only-with-location=yes
```
### device-info
> Gets (lots of) information about a single device.
Parameter | Type | Meaning
--------------------|-----------|---------------------
`device-id` | int | Required. The id of the device to get extended information for. See the `list-device` action for how to get a hold of one.
Examples:
```
https://example.com/path/to/api.php?action=device-info&device-id=10
https://example.com/path/to/api.php?action=device-info&device-id=18
```
## Notes
- Readings are taken every 6 minutes as standard.