From 11f54d1bd57a77c768ee717c6ff41b151fa9bbc3 Mon Sep 17 00:00:00 2001 From: Starbeamrainbowlabs Date: Fri, 18 Jan 2019 21:51:40 +0000 Subject: [PATCH] README: Document new API action --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index e764c5e..2f2a220 100644 --- a/README.md +++ b/README.md @@ -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.