Files
awtrix-light/docs/custom.md
Stephan Mühl c51c769cb5 v0.42
- App transistion is now inacitve if there is only 1 app
- Adds bargraph to notify and customapps
- Every awtrix now gets a unique id for AP, MQTT and HA
- Adds firmware as HA sensor
- Adds wifi strength as HA sensor
- Adds ram usage as HA sensor
- Adds version as HA sensor
- Adds uptime as ISO 8601 as HA sensot
- HA discorvery now gets correct device classes
- fixes bug where date formats are not saved

closes #24
closes #23
closes #21
2023-03-29 00:24:38 +02:00

2.4 KiB

Custom Apps & Notifications

With AWTRIX Light, you can create custom apps or notifications to display your own text and icons. Simply send a JSON object to the topic "awtrixlight/custom/[page]" where [page] is a the name of your page (without spaces).

JSON Properties

The JSON object has the following properties:

Key Type Description Default
pos number defines the position of your custompage in the loop, starting at 1 for the first position. This will only apply with your first push. You cant change the position afterwards. For that you need to delete it and add it again. At the end of the loop
text string The text to display on the page.
icon string The icon ID or filename (without extension) to display on the page.
repeat number Sets how many times the text should be scrolled through the matrix before the display ends. 1
rainbow boolean Fades each letter in the text differently through the entire RGB spectrum. false
duration number Sets how long the page should be displayed. 5
color string A color hex string for the text color. "#FFFFFF"
hold boolean Set it to true, to hold your notification on top until you press the middle button or dismiss it via HomeAssistant. This key only belongs to notification. false
sound string The filename of your RTTTL ringtone file (without extension).
pushIcon number 0 = Icon doesn't move. 1 = Icon moves with text and will not appear again. 2 = Icon moves with text but appears again when the text starts to scroll again. 0
bar array of integers draws a bargraph. Without icon maximum 16 values, with icon 11 values

All keys are optional, so you can send just the properties you want to use.

To update a custom page, simply send a modified JSON object to the same topic. The display will be updated immediately.

You can also send a one-time notification with the same JSON format. Simply send your JSON object to "awtrixlight/notify".

Example

Here's an example JSON object to display the text "Hello, AWTRIX Light!" with the icon ID "1", in rainbow colors, for 10 seconds:

{
  "text": "Hello, AWTRIX Light!",
  "icon": "1",
  "rainbow": true,
  "duration": 10
}

Delete a custom page

To delelte a custom page simply send a empty payload to the same topic