Skip to content

API Reference

Dennis Rathjen edited this page Jun 16, 2022 · 6 revisions

Set Screen

HTTP Endpoin

  POST /api/screen

MQTT Topic

  MasterTopic/setScreen

Text

{
    "text": {
        "textString": "Test It :D",
        "bigFont": false,
        "scrollText": "auto",
        "scrollTextDelay": 20,
        "centerText": false,
        "position": {
            "x": 8,
            "y": 1
        },
        "color": {
            "r": 255,
            "g": 255,
            "b": 255
        },
        "hexColor": "#FFFFFF"
    }
}
Parameter Type Values Description
textString String Required. Displayed Text
scrollText Boolean / String true / false / "auto" Default false Big ront
scrollTextDelay Integer 1 - 9999 Required (when scrollText is used)
centerText Boolean true / false Required
position JSON {"x":8, "y":1} Required
color JSON {"r":255, "g":255, "b":255}, Required (or hexColor)
hexColor String #FFFFFF since v0.3.2 Alternatively to color

Clone this wiki locally