projects/awtrix-light
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Stephan Mühl
2023-04-10 14:01:31 +02:00
parent 03baff6710
commit 1447547e42
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/api.md
View File

@@ -10,20 +10,23 @@ With HTTP, make GET request to `http://[IP]/api/stats`
| Topic | URL | Payload/Body | HTTP method | | Topic | URL | Payload/Body | HTTP method |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `[PREFIX]/power` | `http://[IP]/api/power` | `{"state":value}` | POST | | `[PREFIX]/power` | `http://[IP]/api/power` | `{"state":value}` | POST |
Valid values are: Valid values are:
- `0` => off - `0` => off
- `1` => on - `1` => on
## Show a colored indicator
## Colored indicators
A colored indicator is like a small notification sign wich will be shown on the upper right or lower right corner. A colored indicator is like a small notification sign wich will be shown on the upper right or lower right corner.
| Topic | URL | Payload/Body | HTTP method | | Topic | URL | Payload/Body | HTTP method |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `[PREFIX]/indicator1` | `http://[IP]/api/indicator1` | `{"color":[255,0,0]}` | POST | | `[PREFIX]/indicator1` | `http://[IP]/api/indicator1` | `{"color":[255,0,0]}` | POST |
| `[PREFIX]/indicator2` | `http://[IP]/api/indicator2` | `{"color":[0,255,0]}` | POST | | `[PREFIX]/indicator2` | `http://[IP]/api/indicator2` | `{"color":[0,255,0]}` | POST |
instead of a RGB array you can also sent HEX color strings like `{"color":"#32a852"}` Instead of a RGB array you can also sent HEX color strings like `{"color":"#32a852"}`
## Custom Apps and Notifications ## Custom Apps and Notifications
With AWTRIX Light, you can create custom apps or notifications to display your own text and icons. With AWTRIX Light, you can create custom apps or notifications to display your own text and icons.