API Reference

Set Screen

HTTP Endpoin

  POST /api/screen

MQTT Topic

  MasterTopic/setScreen

Example calls

Calling the internal clock with a fade animation:

{
    "switchAnimation": {
        "aktiv": true,
        "animation": "fade"
    },
    "clock": {
        "show": true,
        "switchAktiv": true,
        "withSeconds": false,
        "switchSec": 6,
        "hexColor": "#1E00FF"
    }
}

Call fade animation, image and text:

{
    "switchAnimation": {
        "aktiv": true,
        "animation": "fade"
    },
    "bitmap": {
        "data": [
                 0,0,0,21855,0,0,0,0,0,0,0,21855,0,0,0,0,0,0,21855,21855,21855,0,0,0,0,0,
                 21855,21855,21855,0,0,0,0,693,1055,1055,65535,44735,0,0,0,693,1055,65535,
                 65535,44735,0,0,0,693,1055,1055,65535,21855,0,0,0,0,693,1055,21855,0,0,0
                ],
    "position": {
            "x": 0,
            "y": 0
        },
        "size": {
            "width": 8,
            "height": 8
        }
    },
    "text": {
        "textString": "59%",
        "bigFont": false,
        "scrollText": false,
        "scrollTextDelay": 0,
        "centerText": true,
        "position": {
            "x": 7,
            "y": 1
        },
        "hexColor": "#1E00FF"
    }
}

Text

since v0.3.2 the following special drawings are possible € ← ↑ → ↓ ★ 📁 ♥ ↧ 🚗 😀

{
    "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"	Required Big front
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

Clock

{
    "clock": {
        "show": true, 
        "switchAktiv": true,
        "switchSec": 5,
        "withSeconds": true,
        "drawWeekDays": true,
        "color": {
            "r": 255,
            "g": 255,
            "b": 255
        },       
        "hexColor": "#FFFFFF"
    }
}

Parameter	Type	Values	Description
show	Boolean	true / false	Required
switchAktiv	Boolean	true / false	Switch clock/date
switchSec	Integer	1 - 9999	Required (when Switch clock/date is used) Switch clock/date in seconds
drawWeekDays	Boolean	true / false	since v1.1.0 Draw weekdays
color	JSON	{"r":255, "g":255, "b":255},	Color of Clock (or hexColor)
hexColor	String	#FFFFFF	since v0.3.2 Alternatively to color