Referenz
Die Referenz beschreibt Programme, Schnittstellen und Dateiformate vollständig. Einführungen und Abläufe stehen im Leitfaden.
Programme
Die Seiten zu den Programmen entstehen beim Bauen der Dokumentation aus deren Hilfetexten und passen so immer zum Quelltext.
| Programm | Aufgabe |
|---|---|
railit | Kommandozeile: Netze und Pläne prüfen, Szenarien, Journale, Bedienung von railitd, Installation pflegen |
railitd | Stellwerksdienst: Kerne, Feld und Betriebsführung im festen Zyklus; REST/JSON, gRPC, Bedienplatz |
railit-field | Feldrechner: simulierte Objektsteuerungen über EULYNX SCI und RaSTA mit Umschalter |
railit-node | Knoten des sicheren Rechners: Kern mit Kanälen, Voter und Watchdog über RaSTA |
Exit-Codes von railit: 0 Erfolg, 1 ungültig oder abgelehnt, 2 Bedien-, Lese- oder Verbindungsfehler. Mit --output json liefern alle Befehle JSON.
Schnittstellen und Formate
| Thema | Inhalt |
|---|---|
| REST-API und gRPC | Endpunkte, Anmeldung, Antworten des Kerns, Ereignisse, Metriken |
| Netzformat | rail-it-TOML: Topologie, Signale, Gleisfreimeldung, Stellbereiche |
| Fahrplan | Züge, Halte und Einsetzen in die Simulation |
| Szenarien | Kopf, Aktionen und Bedingungen |
| Benutzerdatei | Benutzer, Rollen, Token und Zertifikate |
| Journal | Betriebsjournal und Auditprotokoll: Zeilen, Hashkette, Siegel |
| Umgebungsvariablen | Alle Variablen der Programme, Installer und des Builds |