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

Merge branch 'main' of https://github.com/Elfish/awtrix-light

Browse Source
This commit is contained in:
Elfish
2023-04-03 12:15:45 +02:00
parent 1c74e5f693 e864c82465
commit 8cb116605b
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/api.md
View File

@@ -9,16 +9,17 @@ With HTTP, make GET request to `http://[IP]/api/stats`
## Update ## Update
Awtrix searches for an update every 1 Hour. If a new one is found it will be published to HA and in the stats. Awtrix searches for an update every 1 Hour. If a new one is found it will be published to HA and in the stats.
You can start the update with update button in HA or: You can start the update with update button in HA or:
| Topic | URL | Payload/Body | HTTP Header | HTTP method |
| --- | --- | --- |--- |--- | | Topic | URL | Payload/Body | HTTP Header | HTTP method |
| `[PREFIX]/doupdate` |`http://[IP]/api/doupdate` | JSON | empty payload/body | POST | | --- | --- | --- | --- | --- |
| `[PREFIX]/doupdate` |`http://[IP]/api/doupdate` | JSON | empty payload/body | POST |
## Add custom app ## Add custom app
create custom apps or notifications to display your own text and icons. create custom apps or notifications to display your own text and icons.
Have a look at [this section](custom?id=custom-apps-and-notifications) Have a look at [this section](custom?id=custom-apps-and-notifications)
| Topic | URL | Payload/Body | HTTP Header | HTTP method | | Topic | URL | Payload/Body | Query parameters | HTTP method |
| --- | --- | --- |--- |--- | | --- | --- | --- | --- | --- |
| `[PREFIX]/custom/[appname]` |`http://[IP]/api/custom` | JSON | name = [appname] | POST | | `[PREFIX]/custom/[appname]` |`http://[IP]/api/custom` | JSON | name = [appname] | POST |
## Dismiss Notification ## Dismiss Notification
@@ -184,6 +185,6 @@ Here's an example JSON object to start a timer for 1 hour, 30 minutes, and 10 se
"minutes": 30, "minutes": 30,
"seconds": 10, "seconds": 10,
"sound": "friends" "sound": "friends"
} }
``` ```