diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 6 |
1 files changed, 6 insertions, 0 deletions
| @@ -24,6 +24,7 @@ services: | |||
| 24 | - ./logs:/logs | 24 | - ./logs:/logs |
| 25 | network_mode: host | 25 | network_mode: host |
| 26 | ``` | 26 | ``` |
| 27 | # Usage | ||
| 27 | ## Register Device | 28 | ## Register Device |
| 28 | A device is registered with a PUT request to the server with a JSON representation of the device as payload. | 29 | A device is registered with a PUT request to the server with a JSON representation of the device as payload. |
| 29 | | field | description | example | | 30 | | field | description | example | |
| @@ -59,3 +60,8 @@ curl -X PUT http://<server-ip>/device \ | |||
| 59 | "ip": "<device-ip>" | 60 | "ip": "<device-ip>" |
| 60 | }' | 61 | }' |
| 61 | ``` | 62 | ``` |
| 63 | ## Start Device | ||
| 64 | The easiest way to start a device is using a GET request with its id: | ||
| 65 | ```sh | ||
| 66 | curl http://<server-ip>/start/<device-id> | ||
| 67 | ``` \ No newline at end of file | ||