AWTRIX STREAM – Dokumentation

Hinweis: Die Dokumentation befindet sich noch im Aufbau. Im ersten Schritt liste ich hier erstmal die möglichen Einstellmöglichkeiten, die seit Version 1.1.0 via MQTT zur Verfügung stehen.

MQTT

Ist ein MQTT Broker während der Einrichtung angegeben worden, verbindet sich AWTRIX STREAM beim Start mit diesem. Wenn nicht anders konfiguriert lauscht sie dabei auf das Topic awtrixstream.

Befehle

Topic: awtrixstream/erase
Beschreibung: Löscht sämtliche Einstellungen der AWTRIX STREAM und löst einen Neustart aus
Payload: leeres JSON, {}

Topic: awtrixstream/reboot
Beschreibung: Neustart der AWTRIX STREAM
Payload: leeres JSON, {}

Topic: awtrixstream/display
Beschreibung: Display ein-/ausschalten
Payload: JSON, z.B: {"on": true}

Parameter	Wert	Typ	Funktion
on	true	bool	Display ein
on	false	bool	Display aus

Topic: awtrixstream/setting
Beschreibung: Einstellungen der AWTRIX STREAM ändern. Änderungen werden erst nach einem Neustart aktiv.
Payload: JSON, z.B: {"awtrixHostname": "192.168.2.3"}

Parameter	Wert	Typ	Funktion
hostname	z.B. „awtrixstream“	string	Name der AWTRIX STREAM, z.B. um sie im Netzwerk/der FritzBox wiederzufinden
awtrixHostname	z.B. „192.168.178.234“	string	Die IP-Adresse der AWTRIX in deinem Netzwerk, von der das Bild abgegriffen werden soll
awtrixAuthUser	z.B. „meinNutzer“	string	Nutzt die Host AWTRIX Authentifizierung, kann hiermit der Nutzername gesetzt werden
awtrixAuthPass	z.B. „meinPasswort“	string	Nutzt die Host AWTRIX Authentifizierung, kann hiermit das Passwort gesetzt werden
mqttBroker	z.b. „mein-broker.local“	string	Soll die AWTRIX STREAM sich mit einem MQTT Broker verbinden, kann dieser hier gesetzt werden
mqttPort	z.B. „1833“	string	Der Port des MQTT Brokers
mqttUsername	z.B. „mqttUser“	string	Optional: MQTT Nutzername
mqttPassword	z.B. „mqttPasswort“	string	Optional: MQTT Passwort
mqttTopic	z.B. „awtrixstream“	string	Das Topic, auf dem diese Befehle empfangen werden können