Zum Inhalt

MQTT

Cockpit-XP veröffentlicht Renn-, Audio- und Add-on-Ereignisse per MQTT für externe Anwendungen. MQTT wird ab Cockpit-XP Version 3.7 unterstützt und gemeinsam mit der Cockpit-XP-REST-API aktiviert.

Aktivierung

  1. Cockpit-XP starten und das ConfigCenter öffnen.
  2. Basis-Einstellungen → Erweitert aufrufen.
  3. Zum Reiter API wechseln.
  4. Cockpit-XP API/MQTT aktivieren auf Ja setzen.
  5. Cockpit-XP neu starten.

Der Standardport der REST-API ist 8080; MQTT verwendet standardmäßig Port 1883. Ein separater MQTT-Schalter ist nicht erforderlich.

MQTT-Grundlagen

Cockpit-XP veröffentlicht Events auf Topics (publish). Externe Anwendungen können diese Topics abonnieren (subscribe) und die Ereignisse empfangen. Die Topics werden durch Ereignisse in Cockpit-XP ausgelöst.

Das Payload-Format hängt vom Event ab und kann JSON, leer oder numerisch sein. Mit einem MQTT-Client wie dem MQTT Explorer kannst du die Payloads der verwendeten Topics beobachten.

Zum Testen empfehlen wir den MQTT Explorer.

Add-on-Konfiguration

Ein Add-on kann mit dem Befehl cpSetConfig(String) das Topic freehand/espconfig verwenden.

Audio-Events

Diese Topics werden parallel zu den entsprechenden Audio-Events von Cockpit-XP ausgelöst, zum Beispiel für Sound oder Sprachausgabe:

  • audio/AuStart
  • audio/AuRundensound
  • audio/AuSiegerImZiel
  • audio/AuSiegerEinfachRennen
  • audio/Au1MinVorEnde
  • audio/Au30SekVorEnde
  • audio/Au5RdVorEnde
  • audio/Au2RdVorEnde
  • audio/Au1RdVorEnde
  • audio/AuReporter
  • audio/AuBahnrekord
  • audio/AuPersRundenrekord
  • audio/AuPersRundenrekordFz
  • audio/AuSchnellsteRunde
  • audio/AuSchnellsteRundeVonAllen
  • audio/AuSlotrekord
  • audio/AuPersSlotrekord
  • audio/AuPersSlotrekordFz
  • audio/AuTankreserve
  • audio/AuTankistleer
  • audio/AuTankistvoll
  • audio/AuTankenEinfahrt
  • audio/AuTankenAusfahrt
  • audio/AuRennenStart
  • audio/AuRennenPause
  • audio/AuRennenWeiter
  • audio/AuRennenEnde
  • audio/AuFruehstart
  • audio/AuAmpel1
  • audio/AuAmpel2
  • audio/AuAmpel3
  • audio/AuAmpel4
  • audio/AuAmpel5

Add-on-Events

Diese Topics sind für Erweiterungen, Telemetrie und Steuerung vorgesehen:

  • addon/evStartZiel
  • addon/evRealTimeStatus
  • addon/evStartZielSichTime
  • addon/evTankenEinfahrt
  • addon/evTankenAusfahrt
  • addon/evTopSpeedStart
  • addon/evTopSpeedStop
  • addon/evRundenrekord
  • addon/evSlotrekord
  • addon/evBahnrekord
  • addon/evSchnellsteRunde
  • addon/evDigInputEvent
  • addon/evStartRealTime
  • addon/evChangeScreen
  • addon/evKeyDownEvent
  • addon/evBestrafungAktiviert
  • addon/evCUSensorGruppe
  • addon/evBeforeClose
  • addon/evStartampel
  • addon/evApiCall

Logging und offene Details

Cockpit-XP protokolliert MQTT zusammen mit dem API-Logging in LOgOnline.txt. Der Speicherort hängt von der Installation ab.

Weiterführende Informationen