API LoDi-Rektor

Einführung

Im folgenden werden die vom LoDi-Rektor verstandenen Kommandos aufgelistet. Die Kommunikation zum Gerät wird im Abschnitt Allgemeine API erklärt.

Basis-Kommandos

GetVersion

Dieses Kommando liefert die Gerätekennung sowie die FW-Version des Geräts.

Pakettyp Kommando Paketnummer
 0x20 0x0F 0x00 .. 0xFF

Von Steuersoftware zu senden

Pakettyp Kommando Paketnummer Gerätetyp Major Minor Patch
 0x21 0x0F 0x00 .. 0xFF 0x03      

Antwort vom Gerät

Der Gerätetyp ist beim LoDi-Rektor immer 0x03.

Die Firmware-Version setzt sich aus den drei Komponenten Major, Minor und Patch zusammen. Sie wird im Format "v<Major>.<Minor>.<Patch>" angezeigt. Beispiel: "v01.03.01"

Die Major-Version ändert sich nur, wenn eine komplett neue Hardware mit geänderten Eigenschaften und Funktionsumfang herausgebracht wird.

Die Minor-Version ändert sich, wenn Ergänzungen an der API erfolgen. Diese können bei einzelnen Kommandos auch inkompatibel sein.

Die Patch-Version ändert sich bei allgemeinen Fehlerbehebungen, die nicht die API betreffen.

DeviceConfigGet

Dieses Kommando liest die Einstellungen des LoDi-Rektors.

Pakettyp Kommando Paketnummer
 0x20 0x99 0x00 .. 0xFF

Von Steuersoftware zu senden

Pakettyp Kommando Paketnummer Fehlerreaktion StartStop CDE
 0x21 0x99 0x00 .. 0xFF 0 .. 1 0 .. 1  

Antwort vom Gerät

Das Feld Fehlerreaktion definiert, was bei einem Fehler am CDE-Anschluss passiert.

  • 0: Die Fehlerleitung am CDE-Ausgang wird nicht verändert
  • 1: Der Fehler wird an den CDE-Ausgang durchgereicht. Dort angeschlossene Booster schalten ab.

Im Feld StartStop wird das Verhalten des beim Start/Stop am LoDi-Rektor festegelegt. Dies betrifft sowohl den Knopf als auch das Kommando über die API-Schnittstelle.

  • 0: Die Zustände der Booster ändern sich nicht.
  • 1: Die Booster werden mit dem Start/Stop-Signal geschaltet.

Der Eintrag CDE legt das Verhalten des CDE-Anschlusses fest.

  • 0: Der CDE-Anschluss ist abgeschaltet. Er ist elektrisch ohne Funktion
  • 2: Der CDE-Anschluss ist als Eingang geschaltet. Das Gleis-Signal kommt über den CDE-Anschluss von einer anderen Zentrale.
  • 3: Der CDE-Anschluss ist als Ausgang geschaltet. Das Gleis-Signal wird vom LoDi-Rektor generiert. Es können weitere Booster am CDE-Anschluss angeschlossen werden.

Watchdog

Wurde der Watchdog-Befehl einmal empfangen, erwartet der LoDi-Rektor spätestens alle 2 Sekunden diesen Befehl erneut. Bleibt er aus, werden die Booster abgeschaltet.

Pakettyp Kommando Paketnummer Status
 0x20 0x9A 0x00 .. 0xFF 0 .. 1

Von Steuersoftware zu senden

Das Feld Status schaltet die Watchdos-Überwachung ein oder aus.

  • 0: Die Überwachung wird abgeschaltet.
  • 1: Die Überwachung wird eingeschaltet.
Pakettyp Kommando Paketnummer
 0x21 0x9A 0x00 .. 0xFF

Antwort vom Gerät

Booster-Kommandos

BoosterNameGet

Liest den Namen eines µCon-Geräts am Bus. Die Namen werden anhand der µCon-Adresse im LoDi-Rektor gespeichert.

Pakettyp Kommando Paketnummer Booster-Adresse
 0x20 0xA3 0x00 .. 0xFF 1..63

Von Steuersoftware zu senden

Booster-Adresse enthält die µCon-Adresse des zu lesenden Geräts.

Pakettyp Kommando Paketnummer Länge Zeichen 1 .. Zeichen 16
 0x21 0xA3 0x00 .. 0xFF 0 .. 16      

Antwort vom Gerät

Im Feld Länge wird die Anzahl der Zeichen im Namen übergeben.

Die Felder Zeichen 1 bis Zeichen 16 enthalten die Zeichen des Gerätenamens.

BoosterNameSet

Setzt den Namen eines µCon-Geräts. Die Namen werden anhand der µCon-Adresse im LoDi-Rektor gespeichert.

Pakettyp Kommando Paketnummer Adresse Länge Zeichen 1 .. Zeichen 16
 0x20 0xA2 0x00 .. 0xFF 1 .. 63 0 .. 16      

Von der Steuersoftware zu senden

Das Feld Adresse enthält die µCon-Adresse des Geräts.

Das Feld Länge bestimmt die Länge des zu setzenden Strings und damit auch die Länge des Pakets.

Die Einträge Zeichen 1 bis Zeichen 16 enthalten die einzelnen Zeichen des Strings. Der String wird nicht 0-terminiert.

BoosterOn

Dieses Kommando schaltet einen oder mehrere Booster ein.

Pakettyp Kommando Paketnummer Booster-Adresse Status A Status B
 0x20 0x90 0x00 .. 0xFF 1..63, 255 0x00 .. 0x01 0x00 .. 0x01

Von Steuersoftware zu senden

Über die Booster-Adresse kann entweder ein einzelner Booster (1 bis 63) oder alle Booster (255) angesprochen werden.

Die beiden Booster-Kanäle A und B werden über Status A und Status B geschaltet:

  • Status X = 0: Booster-Kanal aus
  • Status X = 1: Booster-Kanal ein

Das Gerät antwortet mit einem ACK-Paket, wenn das Kommando ausgeführt wurde oder mit einem NACK-Paket, wenn z.B. die angegebene Booster-Nummer nicht vorhanden ist.

BoosterStatus

Dieses Kommando erfragt den Status eines oder aller Booster.

Pakettyp Kommando Paketnummer Booster-Adresse Neu
 0x20 0x91 0x00 .. 0xFF 1..63, 255 0x00 .. 0x02

Von Steuersoftware zu senden

Über die Booster-Adresse kann entweder ein einzelner Booster (1 bis 63) oder alle Booster (255) angesprochen werden.

Das Feld Neu hat die folgenden Bedeutungen:

  • 0x00: alle Booster
  • 0x01: neue Booster
  • 0x02: nur Railspeed
Pakettyp Kommando Paketnummer Anzahl Booster-Adresse Status A Status B
 0x21 0x91 0x00 .. 0xFF   1..63 0x00 .. 0x01  0x00 .. 0x01

Antwort vom Gerät

Das Feld Anzahl gibt die Anzahl der gelesenen Booster zurück jeder Booster belegt im Paket jeweils drei Bytes.

Booster-Adresse entspricht der µCon-Adresse des gefundenen Boosters. Status A und Status B enthalten die Statusinformation der beiden Booster-Kanäle nach dem folgenden Muster:

  • Status X = 0: Booster-Kanal aus
  • Status X = 1: Booster-Kanal ein
  • Status X = 2: Booster-Kanal Kurzschluss

BoosterCurrent

Dieses Kommando fragt Informationen zur Spannung, zu der Stromstärke beider Kanäle und zur Temperatur ab.

Pakettyp Kommando Paketnummer Booster-Adresse
 0x20 0x92 0x00 .. 0xFF 1..63, 255

Von Steuersoftware zu senden

Über die Booster-Adresse kann entweder ein einzelner Booster (1 bis 63) oder alle Booster (255) angesprochen werden.

Pakettyp Kommando Paketnummer Anzahl Booster-Adresse Spannung Strom A Strom B Temp.
 0x21 0x92 0x00 .. 0xFF   1..63 0..255  0..255 0..255 0..255

Antwort vom Gerät

Das Feld Anzahl gibt die Anzahl der gelesenen Booster zurück jeder Booster belegt im Paket jeweils fünf Bytes.

Booster-Adresse entspricht der µCon-Adresse des gefundenen Boosters.

Das Feld Spannung enthält die am Booster gemessene Ausgangsspannung. Sie lässt sich nach der folgenden Formel ermitteln: Spannung*17.0/146.0.

Die Felder Strom A und Strom B enthalten den am jeweiligen Booster-Kanal gemessenen Strom. Er lässt sich nach der folgenden Formel ermitteln: Strom*2.5/127.0.

Das Feld Temperatur wird zur Zeit nicht verwendet und ist immer 0.

BoosterGetConfig

Dieses Kommando liest die Einstellungen eines Boosters.

Pakettyp Kommando Paketnummer Booster-Adresse
 0x20 0x93 0x00 .. 0xFF 1 .. 63

Von Steuersoftware zu senden

Die Booster-Adresse gibt den zu lesenden Booster (1 bis 63) an.

Pakettyp Kommando Paketnummer Booster-Adresse Empfindlichkeit Ausschaltzeit Startmodus Railcom
 0x21 0x93 0x00 .. 0xFF 1 .. 63 10 .. 50  0 .. 15 0 .. 1 0 .. 1

Antwort vom Gerät

Die Booster-Adresse gibt den Booster an, dessen Einstellungen gelesen wurden.

Die Empfindlichkeit stellt die Zeitdauer ein, bis ein Kurzschluss ausgelöst wird. Die folgenden Einstellungen sind möglich:

  • 10: 50ms "sehr schnell"
  • 20: 100ms "schnell"
  • 30: 300ms "normal"
  • 40: 500ms "langsam"
  • 50: 700ms "sehr langsam"

Die Ausschaltzeit gibt an, wie lange der Booster nach einem Kurzschluss ausgeschaltet bleiben soll, bevor er automatisch wieder einschaltet. Dieser Wert wird in Sekunden angegeben.

Mit dem Startmodus wird das Verhalten nach einem Kurzschluss eingestellt.

  • 0: Nach einem Kurzschluss wird der Booster nach Ablauf der in Empfindlichkeit eingestellten Zeit wieder eingeschaltet.
  • 1: Der Booster bleibt nach einem Kurzschluss ausgeschaltet.

Das Feld Railcom gibt an, ob der Booster einen Railcom-Cutout generiert.

  • 0: Der Booster generiert keinen Railcom-Cutout.
  • 1: Der Booster generiert einen Railcom-Cutout.

BoosterGetBus

Dieses Kommando liest den gesamten µCon-Bus aus.

Pakettyp Kommando Paketnummer
 0x20 0xA0 0x00 .. 0xFF

Von Steuersoftware zu senden

Pakettyp Kommando Paketnummer Anzahl Typ0 .. Typ63
 0x21 0xA0 0x00 .. 0xFF 64      

Antwort vom Gerät

Die 64 Typ-Felder sind aufsteigend mit allen µCon-Adressen beginnend mit 0 gefüllt. Die Werte entsprechen den Typen der vorhandenen Geräte.

  • 0: Kein Gerät auf Adresse vorhanden
  • 1: µCon-Booster
  • 2: Railspeed
  • 3: LoDi-Booster
  • 4: CDE-Anschluss

Railspeed-Kommandos

RailspeedConfigGet

Liest die Einstellungen eines Railspeed-Sensors.

Pakettyp Kommando Paketnummer Adresse
 0x20 0x9E 0x00 .. 0xFF 1 .. 63

Von Steuersoftware zu senden

Das Feld Adresse enthält die µCon-Adresse des einzustellenden Railspeed-Sensors.

Pakettyp Kommando Paketnummer Adresse ScaleHigh ScaleLow Sprache LenAktiv TolAktiv
 0x21 0x9E 0x00 .. 0xFF 1 .. 63     0 .. 1 0 .. 1 0 .. 1

Von Steuersoftware zu senden

Das Feld Adresse enthält die µCon-Adresse des einzustellenden Railspeed-Sensors.

Die beiden Feldern ScaleHigh und ScaleLow den Maßstab 1:n für die Messung an. Wobei sich n wie folgt berechnet: n = (ScaleHigh*256 + ScaleLow) / 10.

Das Feld Sprache legt die Sprache für das Display des Railspeed-Sensors fest.

  • 0: Deutsch
  • 1: Englisch

Die Einstellung LenAktiv aktiviert die Längenmessung.

  • 0: Längenmessung inaktiv
  • 1: Längenmessung aktiv

Mit TolAktiv wird die Toleranzmessung aktiviert.

  • 0: Die Toleranzmessung der Geschwindigkeit ist inaktiv
  • 1: Die Toleranzmessung der Geschwindigkeit ist aktiv.

RailspeedConfigSet

Setzt die Einstellungen eines angeschlossenen Railspeed-Sensors.

Pakettyp Kommando Paketnummer Adresse ScaleHigh ScaleLow Sprache LenAktiv TolAktiv
 0x20 0x9B 0x00 .. 0xFF 1 .. 63     0 .. 1 0 .. 1 0 .. 1

Von Steuersoftware zu senden

Das Feld Adresse enthält die µCon-Adresse des einzustellenden Railspeed-Sensors.

In den beiden Feldern ScaleHigh und ScaleLow wird der Maßstab 1:n für die Messung eingestellt. Wobei sich n wie folgt berechnet: n = (ScaleHigh*256 + ScaleLow) / 10. Für den Maßstab H0 (n=87) ist also ScaleHigh auf 3 und ScaleLow auf 102 zu setzen.

Das Feld Sprache legt die Sprache für das Display des Railspeed-Sensors fest.

  • 0: Deutsch
  • 1: Englisch

Die Einstellung LenAktiv aktiviert die Längenmessung.

  • 0: Längenmessung inaktiv
  • 1: Längenmessung aktiv

Mit TolAktiv wird die Toleranzmessung aktiviert.

  • 0: Die Toleranzmessung der Geschwindigkeit ist inaktiv
  • 1: Die Toleranzmessung der Geschwindigkeit ist aktiv.
Pakettyp Kommando Paketnummer
 0x21 0x9B 0x00 .. 0xFF

Antwort vom Gerät

RailspeedTextSet

Ändert den im Railspeed-Sensor angezeigten Text.

Pakettyp Kommando Paketnummer Adresse Länge Zeichen 1 .. Zeichen 16
 0x20 0x9F 0x00 .. 0xFF 1 .. 63 0 .. 16      

Von der Steuersoftware zu senden

Das Feld Adresse enthält die µCon-Adresse des Railspeed-Sensors.

Das Feld Länge bestimmt die Länge des anzuzeigenden Strings und damit auch die Länge des Pakets.

Die Einträge Zeichen 1 bis Zeichen 16 enthalten die einzelnen Zeichen des Strings. Der String wird nicht 0-terminiert.

RailspeedActiveSet

Aktiviert und deaktiviert die Events von Railspeed-Sensoren.

Pakettyp Kommando Paketnummer Adresse Aktiv
 0x20 0x9C 0x00 .. 0xFF 1 .. 63, 255 0 .. 1

Von der Steuersoftware zu senden

Das Feld Adresse enthält die µCon-Adresse des zu aktivierenden Railspeed-Sensors. Wird 255 angegeben, werden die Events aller am Bus vorhandenen Railspeed-Sensoren aktiviert oder deaktiviert.

Der Eintrag Aktiv gibt an, ob die Events des Sensor aktiviert oder deaktiviert werden sollen.

  • 0: Events deaktivieren
  • 1: Events aktivieren

RailspeedEvent

Dieser Event wird automatisch vom Gerät gesendet, wenn Railspeed-Events eingeschaltet sind.

Pakettyp Kommando Paketnummer Adresse Typ WertHi WertLo Status Valid SensorL SensorR
 0x22 0x9D 0x00 .. 0xFF 1 .. 63 1, 2, 4     0 .. 1 0 .. 1 0 .. 1 0 .. 1

Event vom Gerät

Das Feld Adresse enthält die µCon-Adresse des auslösenden Railspeed-Sensors.

Typ bestimmt, die Art des Events.

  • 1: Geschwindigkeitsmessung
  • 2: Längenmessung
  • 3: Toleranz der Geschwindigkeit

Die Einträge WertHi und WertLo geben den Messwert an. Bei Geschwindigkeits- und Toleranzmessung ist die Einheit mm/s, bei Längenmessung mm. Sind WertHi und WertLo 0, so ist die Messung ungültig.

Der Messwert wird dabei wie folgt ermittelt: Wert = WertHi*256 + Wert Low.

Das Feld Status zeigt an, ob die Messung beendet ist.

  • 0: Messung beendet, bereit für nächste Messung
  • 1: Messung läuft noch

Valid gibt an, ob der in WertHi und WertLo angezeigt Wert gültig ist.

  • 0: WertLo und WertHi sind ungültig.
  • 1: WertLo und WertHi sind gültig.

Die Einträge SensorL und SensorR zeigen die aktuelle Verdeckung des linken und rechten Sensors an.

  • 0: Sensor frei
  • 1: Sensor verdeckt

Generator

Der Generator kann DCC- und Motorola-Gleissignale erzeugen. Er ist nur aktiv, wenn der CDE-Anschluss entweder abgeschaltet ist oder auf Ausgang steht.

GeneratorActivate

Aktiviert oder deaktiviert den Generator. Mit der Aktvierung des Generators wird ein Idle-Signal auf dem Gleis erzeugt.

Pakettyp Kommando Paketnummer Protokoll
 0x20 0x80 0x00 .. 0xFF 0 .. 2

Von der Steuersoftware zu senden

Protokoll definiert, ob der Generator aktiv ist und welches Protokoll im Leerlauf verwendet werden soll.

  • 0: Generator deaktiviert
  • 1: DCC
  • 2: Motorola

GeneratorProtokollGet

Liest das Default-Protokoll des Generators.

Pakettyp Kommando Paketnummer
 0x20 0x81 0x00 .. 0xFF

Von der Steuersoftware zu senden

Pakettyp Kommando Paketnummer Protokoll
 0x21 0x81 0x00 .. 0xFF 1 .. 2

Antwort vom Gerät

Das Feld Protokoll enthält das aktive Default-Protokoll des Generators.

  • 1: DCC
  • 2: Motorola

GeneratorMessage

Schickt neue DCC- oder Motorola-Daten an den Generator.

Pakettyp Kommando Paketnummer Info Data 0 .. Data n
 0x20 0x82 0x00 .. 0xFF        

Von der Steuersoftware zu senden

Das Feld Info hat eine Doppelfunktion und ist wie folgt aufgeteilt:

  • Bit 0 bis 5: Länge der Daten
  • Bit 6 und 7: Protokoll
    • 1: DCC
    • 2: Motorola

Die Einträge Daten 0 bis Daten n enthalten das DCC- bzw. Motorola-Paket ohne Prüfsumme. Diese wird vom Generator selbst errechnet.

Ein UDP-Paket  kann mehrere solcher DCC- oder Motorola-Pakete enthalten.

Pakettyp Kommando Paketnummer Hinzugefügt Idle-Zähler
 0x21 0x82 0x00 .. 0xFF    

Antwort vom Gerät

Das Feld Hinzugefügt enthält die Anzahl der DCC- bzw. Motorola-Pakete, die in den Puffer aufgenommen wurden.

Der Idle-Zähler enthält die Anzahl der gesendeten Idle-Pakete seit der letzten Nachricht.