Application
src.awtrix_light_client.models.application.TextCase ¶
src.awtrix_light_client.models.application.PushIcon ¶
src.awtrix_light_client.models.application.Dp ¶
Bases: BaseModel
Draw a pixel
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x
|
Pixel x axis |
required | |
y
|
Pixel y axis |
required | |
cl
|
Pixel color |
required |
src.awtrix_light_client.models.application.Dl ¶
Bases: BaseModel
Draw a line
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x0
|
Start pixel x axis |
required | |
y0
|
Start pixel y axis |
required | |
x1
|
End pixel x axis |
required | |
y1
|
End pixel y axis |
required | |
cl
|
Line color |
required |
src.awtrix_light_client.models.application.Dr ¶
Bases: BaseModel
Draw a rectangle
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x
|
Top left corner pixel x axis |
required | |
y
|
Top left corner pixel y axis |
required | |
w
|
Width |
required | |
h
|
High |
required | |
cl
|
Line color |
required |
src.awtrix_light_client.models.application.Df ¶
Bases: BaseModel
Draw a filled rectangle
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x
|
Top left corner pixel x axis |
required | |
y
|
Top left corner pixel y axis |
required | |
w
|
Width |
required | |
h
|
High |
required | |
cl
|
Line color |
required |
src.awtrix_light_client.models.application.Dc ¶
Bases: BaseModel
Draw a circle
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x
|
Circle center x axis |
required | |
y
|
Circle center y axis |
required | |
r
|
Radius |
required | |
cl
|
Line color |
required |
src.awtrix_light_client.models.application.Dfc ¶
Bases: BaseModel
Draw a filled circle
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x
|
Circle center x axis |
required | |
y
|
Circle center y axis |
required | |
r
|
Radius |
required | |
cl
|
Line color |
required |
src.awtrix_light_client.models.application.Dt ¶
Bases: BaseModel
Draw text
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x
|
Text top left corner pixel x axis |
required | |
y
|
Text top left corner pixel y axis |
required | |
t
|
Text |
required | |
cl
|
Line color |
required |
src.awtrix_light_client.models.application.Dt ¶
Bases: BaseModel
Draw text
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x
|
Text top left corner pixel x axis |
required | |
y
|
Text top left corner pixel y axis |
required | |
t
|
Text |
required | |
cl
|
Line color |
required |
src.awtrix_light_client.models.application.Db ¶
Bases: BaseModel
Draws a RGB888 bitmap array
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x
|
Top left corner pixel x axis |
required | |
y
|
Top left corner pixel y axis |
required | |
w
|
Width |
required | |
h
|
High |
required | |
bmp
|
Bitmap array |
required |
src.awtrix_light_client.models.application.LifeTimeMode ¶
src.awtrix_light_client.models.application.Fragment ¶
Bases: BaseModel
A fragment of text
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
t
|
Text |
required | |
c
|
Color |
required |
src.awtrix_light_client.models.application.BaseApplication ¶
Bases: BaseModel
Base application class
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
text
|
The text to display. Keep in mind the font does not have a fixed size and I uses less space than W. This facts affects when text will start scrolling |
required | |
textCase
|
Changes the Uppercase setting. |
required | |
topText
|
Draw the text on top. |
required | |
textOffset
|
Sets an offset for the x position of a starting text. |
required | |
center
|
Centers a short, non-scrollable text. |
required | |
color
|
The text, bar or line color. |
required | |
gradient
|
Colorizes the text in a gradient of two given colors. |
required | |
blinkText
|
Blinks the text in an given interval, not compatible with gradient or rainbow. |
required | |
fadeText
|
Fades the text on and off in an given interval, not compatible with gradient or rainbow. |
required | |
background
|
Sets a background color. |
required | |
rainbow
|
Fades each letter in the text differently through the entire RGB spectrum. |
required | |
icon
|
The icon ID or filename (without extension) to display on the app. You can also send a 8x8 jpg as Base64 String |
required | |
pushIcon
|
Icon movement. |
required | |
repeat
|
Sets how many times the text should be scrolled through the matrix before the app ends. |
required | |
duration
|
Sets how long the app or notification should be displayed. |
required | |
bar
|
Draws a bargraph. Without icon maximum 16 values, with icon 11 values. |
required | |
line
|
Draws a linechart. Without icon maximum 16 values, with icon 11 values. |
required | |
autoscale
|
Enables or disables autoscaling for bar and linechart. |
required | |
progress
|
Shows a progress bar. Value can be 0-100. |
required | |
progressC
|
The color of the progress bar. |
required | |
progressBC
|
The color of the progress bar background. |
required | |
draw
|
Array of drawing instructions. Each object represents a drawing command. See the drawing instructions below. |
required | |
noScroll
|
Disables the text scrolling. |
required | |
scrollSpeed
|
Modifies the scroll speed. Enter a percentage value of the original scroll speed. |
required | |
effect
|
Shows an effect as background.The effect can be removed by sending an empty string for effect. |
required | |
effectSettings
|
Changes color and speed of the effect. |
required |
src.awtrix_light_client.models.application.CustomApplication ¶
Bases: BaseApplication
Custom application
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
pos
|
Defines the position of your custom page in the loop, starting at 0 for the first position. This will only apply with your first push. This function is experimental. |
required | |
lifetime
|
Removes the custom app when there is no update after the given time in seconds. |
required | |
lifetimeMode
|
0 = deletes the app, 1 = marks it as staled with a red rectangle around the app |
required | |
save
|
Saves your custom app into flash and reloads it after boot. Avoid this for custom apps with high update frequencies because the ESP's flash memory has limited write cycles. |
required |
src.awtrix_light_client.models.application.Notification ¶
Bases: BaseApplication
Notification
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
hold
|
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. |
required | |
sound
|
The filename of your RTTTL ringtone file placed in the MELODIES folder (without extension). |
required | |
rtttl
|
Allows to send the RTTTL sound string with the json. |
required | |
loopSound
|
Loops the sound or rtttl as long as the notification is running. |
required | |
stack
|
Defines if the notification will be stacked. false will immediately replace the current notification. |
required | |
wakeup
|
If the Matrix is off, the notification will wake it up for the time of the notification. |
required | |
clients
|
Allows forwarding a notification to other awtrix devices. Use the MQTT prefix for MQTT and IP addresses for HTTP. |
required |