Benutzer:Edbert van Eimeren/Test2

Zweiter Entwurf zur Diskussion - 11.7.2000

von Edbert van Eimeren, Martin Ostermann, Matthias Trute

1 Einleitung

Die CRCF beschreiben einen Reihe von Dateien zur Konfiguration von Serverprozessen zur Steuerung von digitalen Modelleisenbahnen. Clientprozesse können auf diese Informationen über einen entsprechenden Auskunftsbefehl zugreifen.

Die in CRCF zu speichernden Informationen ergeben sich aus dem Bedarf des SRCP (Simple Railroad Command Protocol) wie von Torsten Vogt & anderen definiert. In diesem Sinne sind die CRCF eine Ergänzung zum SRCP.

Ziel ist es eine klare, auch vom Menschen lesbare Basis für die Fähigkeiten einer konkreten Serverimplementierung einerseits und eine Beschreibung der verwendeten Dekoder mit ihren spezifischen Eigenschaften andererseits zu schaffen.

Diese Fassung basiert auf SRCP Version 0.7.1.

1.1 Konventionen

Alle Informationen werden einzeilig mit variabler Länge gespeichert. Eine Zeile wird mit dem Zeichen '\n' (line feed, LF, #10) abgeschlossen. Ein vorangestelltes '\r' (carriage return, CR, #13) wird akzeptiert. Jede Informationszeile besteht aus Worten, die durch Whitespace (Leerzeichen, Tabulatoren) getrennt sind.

Die Worte der Informationszeilen können aus der Menge der Zeichen { '0', .., '9', '-', 'A', .., 'Z', 'a', .., 'z' } gebildet werden. Der Server wertet die Informationszeilen case-sensitive aus, d.h. zwischen Groß- und Kleinbuchstaben wird unterschieden.

Kommentarzeilen beginnen mit dem Zeichen '#' und enden mit dem Zeilenende. Sie werden ebenso ignoriert wie Leerzeilen (nur White Spaces und CR, LF). Sie dürfen alle druckbaren Zeichen des ASCII Zeichensatzes enthalten. Sie dienen ausschliesslich der besseren Lesbarkeit durch einen Menschen.

Einzelne Bereiche werden durch Überschriften getrennt. Diese beginnen (Zeilenanfang) mit '= ' und enden mit ' ='. Weiterer Text in der Überschriftzeile ist Kommentar und wird ignoriert.

Alle Informationszeilen beginnen mit einer Kennung aus vier Buchstaben, die die Art der Information kennzeichnet. Die weiteren Angaben sind je nach Art der Information unterschiedlich. Informationen über Protokolle enthalten eine weitere Angabe zur genauen Identifizierung (Protokoll/Modultyp). Informationen über Dekoder und Rückmelder enthalten zwei weitere Angaben zur genauen Identifizierung (Protokoll/Modultyp + Adresse/Portnummer). Für jede vom Server unterstützte Funktion / Eigenschaft gibt es eine Informationszeile. Für jeden dem Server bekannten Dekoder / Rückmelder gibt es eine Informationszeile.

Informationszeilen, die unvollständig oder offensichtlich falsch sind werden vom Server ignoriert. Eine (summarische) Fehlermeldung sollte in diesem Fall vom Server beim Start ausgegeben werden. In Protokoll- oder Trace-Dateien kann ggfs. jeder Fehler einzeln aufgeführt werden.

Die Informationen sind in Bereiche aufgeteilt. Jeder Bereich hat eine Überschrift. Alle Informationen aus einem Bereich müssen hinter dieser Überschrift stehen. Stehen sie an einer anderen Stelle, so werden sie als Fehler gewertet. Innerhalb eines Bereichs ist eine angemessene Ordnung sinnvoll (Name | Protokoll | Adresse | ...). Diese Ordnung ist für die bessere Lesbarkeit und daher nicht zwingend vorgeschrieben. Es steht im Ermessen des Erstellers, welche Ordnung, wenn überhaupt, er/sie benutzt.

An einigen Stellen sind Werte reserviert, die im SRCP noch nicht festgelegt sind, da es zur Zeit noch keine Server gibt, die das unterstützen. Diese Werte sind als Platzhalter zu betrachten, sie können sich noch ändern. Solche reservierten Werte sind mit kursiver Schrift markiert.

Änderungen gegenüber der vorherigen Version werden mit einem farbigen Strich am rechten Rand markiert. Dabei bedeutet rot Neues, grün wesentliche (inhaltliche) Änderungen, und blau Weglassungen. Alle geänderten Abschnitte sind grau hinterlegt. Dies gilt auch für Abschnitte mit textlichen Korrekturen, die keine extra Randmarkierung haben. Korrekturen von Tipfehlern werden nicht markiert.

2 Servereigenschaften

Hier werden die Eigenschaften beschrieben, die eine Serverimplementierung ausmachen, das heißt, welche Möglichkeiten ein Server seinen Clients zur Verfügung stellt.

2.1 Serverversion

Überschrift: '= Version =' Es gibt genau eine Zeile mit den Informationen über die Version des Servers, des verwendeten SRCP und CRCF. Format: VERS <name> <vers> SRCP <srcp> CRCF <crcf>
<name> <vers> <srcp>	Name des Servers Version des Servers Version des verwendeten SRCP
<crcf>	Version des verwendeten CRCF
Hinweis:	Die Versionsinformation sollte als erstes in einer Konfigurationsdatei stehen.

2.2 Übertragungskanäle

Welche Kanäle werden von einer Serverimplementierung zur Kommunikation mit Clients benutzt.
Dies ist durch das SRCP weitgehend festgelegt.

Überschrift: '= Ports ='

Format: PORT <port> <source>

<port>

COMMAND

FEEDBACK

INFO

Kommando Port

Befehle des Clients an den Server, direkte Antworten des Servers darauf.
Rückmelde Port
Statusänderungen von Rückmelde Modulen.
Info Port (Broadcast Kanal)
Statusänderungen von Lok- und Schaltdekodern, Modellzeit.

<source>

CLIENT
SERVER
BOTH

Unidirektional vom Client zum Server

Unidirektional vom Server zum Client
Bidirektional

2.3 Serverbefehle

Welche Befehle werden von einer Server zu seiner Steuerung akzeptiert. Dies ist durch das SRCP weitgehend festgelegt. Überschrift: '= Server Commands =' Format: SCMD <command>
<command>	LOGOUT RESET SHUTDOWN	Befehl zum Beenden der Verbindung zu einem Client. Befehl zur Neu-Initialisieung des Servers. Befehl zum Beenden des Servers.
	POWER VOLTAGE	Digitalstrom über SET POWER [ON/OFF] ein-/ausschalten Aktueller Befehl in SRCP (ab Version 0.???) Digitalstrom über STARTVOLTAGE/STOPVOLTAGE schalten Kompatibilität zu früheren Versionen des SRCP
	TIME	Server unterstützt Modellzeit

2.4 Allgemeine Befehle

Welche Befehle werden von einer Server zur Steuerung der Digitalanlage akzeptiert. Dies ist durch das SRCP weitgehend festgelegt. Überschrift: '= General Commands =' Format: GCMD <command> <group>
<command>	SET GET WAIT INIT TERM	Befehl zum Setzen eines Wertes. Befehl zum Ermitteln eines Wertes. Befehl zum Warten bis ein bestimmter Zustand erreicht wird. Befehl zum Initialisieren von Geräte(gruppen). Befehl zum Aufheben von mit INIT getroffenen Einstellungen.
	WRITE READ VERIFY CONFGET	Befehl zum Programmieren eines Wertes eines Dekoders. Befehl zum Lesen eines Wertes eines Dekoders. Befehl zum Überprüfen eines Wertes eines Dekoders. Befehl zum Ermitteln von Konfigurationsinformationen.
<group>	GL GA FB TIME POWER	Generic Loco (Lokdekoder) [SET, GET, WRITE, READ, VERIFY] Generic Acessory (Schaltdekoder) [SET, GET, WRITE, READ, VERIFY] Feedback (Rückmelder) [GET, WAIT, INIT] Zeitnormal (Modellzeit) [SET, GET, WAIT, INIT] Energieversorgung der Modellanlage [SET, GET]
	Beim Befehl CONFGET werden statt der Gerätegruppen die Konfigurationstypen als Argument verwendet. Siehe dazu den Abschnitt #5.1 Konfigurationstypen.
Eine Kombination Befehl - Argument, die nicht eingetragen ist, wird nicht unterstützt. Lediglich der Befehl SET ist zwingend vorgeschrieben, alle anderen können implementiert werden. Der Befehl GET wird meistens unterstützt, der Befehl WAIT falls Rückmelder oder Modellzeit unterstützt werden. Die Befehle WRITE, READ, VERIFY dienen dem Programmieren von Dekodern. Sie werden nur dann unterstützt, wenn ein Server diese Funktionalität bereitstellt. Der Befehl CONFGET wird natürlich nur dann unterstützt, wenn ein Server das CRCF für die zentrale Konfiguration benutzt.

2.5 Protokolle Lokdekoder

Welche Protokolle für Lokdekoder werden von einem Server akzeptiert. (Funktionsdekoder werden wie Lokdekoder behandelt.) Dies ist zwar durch das SRCP festgelegt, jedoch muss ein Server nicht alle in SRCP beschriebenen Protokolle unterstützen (z.B. Ansteuerung einer systemspezifischen Zentraleinheit). Weiter sind bereits Werte für noch nicht unterstützte Protokolle reserviert. Überschrift: '= Protocols Loco & Function =' Format: PRGL <prot> <addr_max> <step_max> <dir> <nro_f>
<prot>	M. N.	Protokolle nach den Märklin/Motorola Standards. Protokolle nach den NMRA-DCC Standards.
	PS	Protocol by Server: Der Server wählt ein geeignetes Protokoll aus.
	S. F. Z.	Protokolle nach den Trix Selectrix Standards. Protokolle nach den Fleischmann FMZ Standards. Protokolle nach den ZIMO Standards.
	Der Punkt ist durch geeignete Buchstaben/Ziffern zu ersetzen. Siehe dazu die aktuelle Spezifikation des SRCP. Die Werte für Selectrix, FMZ und ZIMO sind reserviert für zukünftige Entwicklungen (Intellibox, Twin-Box, ...).
<addr_max>	Höchste Adresse, die von diesem Protokoll unterstützt wird. Aktuelle Werte für den Adressbereich sind 80, 99, 256, 9999. Ein Adressbereich beginnt immer bei der Adresse 0.
<step_max>	Höchste Fahrstufen, die von diesem Protokoll unterstützt wird. Aktuelle Werte für die höchste Fahrstufe sind 14, 27, 28, 30, 128. Ein Fahrstufenbereich beginnt immer bei der Fahrstufe 0.
<dir>	abs rel	Absolute Fahrtrichtungsangabe. Relative Fahrtrichtungsangabe.
<nro_f>	Zahl der Zusatzfunktionen, die von diesem Protokoll unterstützt werden. Aktuelle Dekoder untertützen 0, 2, 4, 8 Zusatzfunktionen. Es wird implizit davon ausgegeangen, dass eine Standardfunktion immer implementiert ist.

2.6 Protokolle Schaltdekoder

Welche Protokolle für Schaltdekoder werden von einem Server akzeptiert. Dies ist zwar durch das SRCP festgelegt, jedoch muss ein Server nicht alle in SRCP beschriebenen Protokolle unterstützen (z.B. Ansteuerung einer systemspezifischen Zentraleinheit). Weiter sind bereits Werte für noch nicht unterstützte Protokolle reserviert. Überschrift: '= Protocols Accessory =' Format: PRGA <prot> <addr_max>
<prot>	M N	Protokoll nach den Märklin/Motorola Standards. Protokoll nach den NMRA-DCC Standards.
	S F Z	Protokoll nach den Trix Selectrix Standards. Protokoll nach den Fleischmann FMZ Standards. Protokoll nach den ZIMO Standards.
<addr_max>	Höchste Adresse, die von diesem Protokoll unterstützt wird. Aktuelle Werte für den Adressbereich sind ???, 4096. Ein Adressbereich beginnt bei der Adresse 1.

2.7 Protokolle Rückmelde Module

Welche Rückmelde Module und Anschlussarten werden von einem Server akzeptiert. Dies ist zwar durch das SRCP festgelegt, jedoch muss ein Server nicht alle in SRCP beschriebenen Module oder Arten unterstützen. Weiter sind bereits Werte für noch nicht definierte Protokolle reserviert. Überschrift: '= Feedback Types =' Format: PRFB <module-type> <port_max> <port_inc>
<module-type>	S88 I8255 M6051	Märklin s88-Bus am Parallelport des PC. i8255 Karte. Märklin s88-Bus via Interface 6051.
	LENZFB LOCOFB SELFB FMZFB ZIMOFB	Rückmelde-Module aus dem Lenz System. Rückmelde-Module aus dem Digitrax System (LocoNet). Rückmelde-Module aus dem Trix Selectrix System. Rückmelde-Module aus dem Fleischmann FMZ System. Rückmelde-Module aus dem ZIMO System.
	Hinweis:	Die letzten fünf sind reservierte Namen, die sich ggfs. noch ändern können.
<port_max>	Höchste Adresse, die für diesen Modultyp zulässig ist. Ein Nummerbereich beginnt mit (0 \| 1) ???.
<port_inc>	Anzahl der Ports, die in einem Modul dieses Typs zusammengefasst sind.

2.8 Sonstige Gerätetypen

Dies kann erst dann spezifiziert werden, wenn entsprechende Definitionen in SRCP vorliegen.

3 Geräte und Eigenschaften

Hier werden die Eigenschaften beschrieben, die ein tatsächliches Gerät (Lok-, Schaltdekoder, Rückmelde Modul) hat. Das heißt, welche Funktionen von einem Dekoder oder Modul tatsächlich realisiert werden. Dies kann ggfs. weniger sein, als das Protokoll erlaubt. Weiter gibt es einige Parameter, die nur für die Clients von Interesse sind (<d_type>, <name>, ...). Solche Parameter stehen am Ende der Parameterliste.

3.1 Lok- und Funktionsdekoder

Überschrift: '= Locomotive & Function =' Format: DCGL <prot> <addr> <step> <dir> <func> <prog> <ps_addr> <V_max> <d_type> <name>
<prot>	Wie im Abschnitt #2.5 Protokolle Lokdekoder definiert. Dekoder, die über mehrere Protokolle angesprochen werden können, haben für jedes Protokoll einen Eintrag. PS (Protocol by Server) ist hier nicht zulässig, da es sich um reale Dekoder handelt.
<addr>	Adresse dieses Dekoders unter dem gewählten Protokoll. Multiprotokoll-Dekoder dürfen für jedes Protokoll eine andere Adressen benutzen.
<step>	Höchste Fahrstufen, die von diesem Dekoder unterstützt wird. Für Funktionsdekoder ist dieser Wert ggfs. auf 0 zu setzen.
<dir>	abs rel	Absolute Fahrtrichtungsangabe. Relative Fahrtrichtungsangabe.
<func>	Die Funktionen werden durch ein Wort <func> beschrieben, das aus Zeichenpaaren aufgebaut ist: Das erste Zeichenpaar besteht aus zwei Ziffern und gibt die Zahl m der verfügbaren Funktionen inkl. der Standardfunktion an. Die Zeichenpaare 2 bis m+1 sind jeweils ein Kürzel für die Art der Verwendung der Funktionen F0 - Fn. [ m = n+1 ! ]. F0 ist dabei die Standardfunktion, F1 -Fn sind die Zusatzfunktionen. Das zweite Zeichenpaar bezeichnet also die Verwendung der Standardfunktion, das dritte der ersten Zusatzfunktion. Wird eine Funktion nicht benutzt so steht an der Stelle des Kürzels das Zeichenpaar '--'. Damit ist sowohl klar, wieviele Funktionen verfügbar sind, als auch, welche davon wirklich benutzt werden. Das minimale Wort für Funktion ist damit das Zeichenpaar '00' (keinerlei Funktion). Den Kürzeln wird in der Tabelle FTXT ein Langtext zugeordnet. Siehe dazu den Abschnitt #4.1 Langtexte.
<prog>	Der Wert von <prog> ist ein Wort mit 7 Buchstaben:
	1) 2) 3) 4)	Modus (P = Programmiergleis, F = on the Fly [im Betrieb]) WRITE- Befehl (W = unterstützt) READ- Befehl (R = unterstützt) VERIFY-Befehl (V = unterstützt)
	5) 6) 7)	REGISTER (R = unterstützt) VARIABLE (V = unterstützt) BIT (B = unterstützt)
	Wird eine Funktion nicht unterstützt, so ist statt dessen das Zeichen '-' (= none) zu setzen. Beispiele: "PW--R--" Nur Register auf dem Programmiergleis schreiben. "FWR-RV-" Register + Variablen im laufenden Betrieb lesen + schreiben. "-------" Nicht über Digitalbefehle programmierbar.
<ps_addr>	Adresse, unter der dieser Dekoder mit "Protocol by Server" angesprochen wird. Dekoder, die über mehrere Protokolle / Adressen angesprochen werden, sollen jeweils die selbe PS-Adresse verwenden. Durch <ps_addr> wird eine virtuelle Adresse definiert. Da im SRCP (ab 0.7.1) keine Beschränkung für die Größe einer Adresse besteht, kann man die in Deutschland ab Epoche IV übliche sechstellige Zahl für eine Lok verwenden. Dies völlig unabhängig davon, wieviel Adressen der Dekoder real unterstützt.
<V_max>	Virtuelle Höchstgeschwindigkeit: Dieser Wert wird in einem Server zusammen mit einem Wert V (<= V_Max) für die Soll-Geschwindigkeit dazu benutzt die reale Fahrstufe zu berechnen. Im SRCP wird keine Vorgabe über die Masseinheit dieses Wertes gemacht. Empfehlenswert ist eine Orientierung an der Vorbild-Geschwindigkeit, also in km/h. Hinweis: Wird dieser Wert auf 0 gesetzt, so verwendet der Server den Wert von V als reale Fahrstufe.
<d_type>	Kennung für den Dekodertype: Dekoder eines Typs erhalten die gleiche Kennung. Die Kennung muss ein Wort sein. Das heisst es darf kein Leerzeichen oder Tabultorzeichen enthalten. Zur optischen Gliederung ist ggfs. das Zeichen '-' einzusetzen. Sinnvollerweise hält man sich an die Bezeichnung des Hersteller. Soll keine Kennung angegeben werden, ist statt dessen das Wort "---" zu verwenden.
<name>	Eindeutiger Name für diesen Lok-/Funktions-Dekoder: Der Name muss ein Wort sein. Das heisst es darf kein Leerzeichen oder Tabultorzeichen enthalten. Zur optischen Gliederung ist ggfs. das Zeichen '-' einzusetzen. Beispiele: "V188-003", "Berghexe", "Zuckersusi". Soll keine Name angegeben werden, ist statt dessen das Wort "---" zu verwenden. Dekoder, die über mehrere Protokolle angesprochen werden können, dürfen den gleichen Namen verwenden.

3.2 Schaltdekoder

Überschrift: '= Accessory =' Format: DCGA <prot> <addr_min> <addr_max> <d_type> <name>
<prot>	Wie im Abschnitt #2.6 Protokolle Schaltdekoder angegeben.
<addr_min>	Adresse des ersten verwendeten Ausgang dieses Dekoders.
<addr_max>	Adresse des letzten verwendeten Ausgang dieses Dekoders.
<d_type>	Kennung für den Dekodertype: Dekoder eines Typs erhalten die gleiche Kennung. Die Kennung muss ein Wort sein. Das heisst es darf kein Leerzeichen oder Tabultorzeichen enthalten. Zur optischen Gliederung ist ggfs. das Zeichen '-' einzusetzen. Sinnvollerweise hält man sich an die Bezeichnung des Hersteller. Soll keine Kennung angegeben werden, ist statt dessen das Wort "---" zu verwenden.
<name>	Eindeutiger Name für diesen Schaltdekoder: Der Name muss ein Wort sein. Das heisst es darf kein Leerzeichen oder Tabultorzeichen enthalten. Zur optischen Gliederung ist ggfs. das Zeichen '-' einzusetzen . Beispiele: "Bahnhof-Links", "Gleis-1-2", "Abzweig-Abc". Soll keine Name angegeben werden, ist statt dessen das Wort "---" zu verwenden.
Hinweis:	Für einen Einzeldekoder gilt <addr_min> = <addr_max> Auf diese Art kann je nach Wunsch eine Gruppendefiniton aller Ausgänge des Schaltdekoders oder eine Einzeldefinition eines Ausgangs erfolgen.

3.3 Rückmelde Module

Überschrift: '= Feedback Units =' Format: DCGA <modul-type> <port_min> <port_max> <d_type> <name>
<modul-type>	Wie im Abschnitt #2.7 Protokolle Rückmelde Module definiert.
<port_min>	Portnummer des ersten verwendeten Eingang dieses Modules.
<port_max>	Portnummer des letzten verwendeten Eingang dieses Modules.
<d_type>	Kennung für den konkreten Typ eines Rückmelde Modules: Hier dient sie hauptsächlich zur Unterscheidung verschiedener Lieferanten eines Modultyps. Rückmelder eines Typs erhalten die gleiche Kennung. Die Kennung muss ein Wort sein. Das heisst es darf kein Leerzeichen oder Tabultorzeichen enthalten. Zur optischen Gliederung ist ggfs. das Zeichen '-' einzusetzen. Sinnvollerweise hält man sich an die Bezeichnung des Hersteller. Soll keine Kennung angegeben werden, ist statt dessen das Wort "---" zu verwenden.
<name>	Eindeutiger Name für dieses Rückmelde Modul: Der Name muss ein Wort sein. Das heisst es darf kein Leerzeichen oder Tabultorzeichen enthalten. Zur optischen Gliederung ist ggfs. das Zeichen '-' einzusetzen. Beispiele: "GBM-Bonn", "GBM-Strecke", "Weichen-Bhf". Soll keine Name angegeben werden, ist statt dessen das Wort "---" zu verwenden.
Hinweis:	Mit <port_min> = <port_max> kann man ggfs. auch jeden Port einzeln definieren.

4 Sonstiges

Dies ist der Platz für Festlegungen, die übergreifend sind.
Als erstes wird ein Bereich für die Zuordnung von Kurzformen zu Langtexten definiert.
Weitere übergreifende Funktionen folgen nach Bedarf.

4.1 Langtexte

Im Laufe der Diskussion um das CRCF hat sich gezeigt, dass es notwendig ist sowohl Kurzformen (=Abkürzungen), als auch Langformen (=Text) für bestimmte Informationen zur Verfügung zu stellen. Mit den Tabellen in diesem Abschnitt wird eine Zuordnung zwischen Abkürzungen und zugehörigen Text hergestellt. Je nach Art der Information kann diese Tabelle zwingend sein, das heißt nur Werte in der Tabelle sind zulässig, oder optional, das heißt es können auch Abkürzungen verwendet werden, die nicht in der Tabelle enthalten sind. Überschrift: '= Messages =' Format: <TEXT-TYPE> <short> <lang> <freetext>
<TEXT-TYPE>	Kennung für die Art der Zuordnung. Für den Befehl CONFGET ist dies ein Konfigurationstyp. (Siehe #5.1 Konfigurationstypen)
<short>	Abkürzung,
<lang>	Sprache (z.B. de := deutsch, en := englisch). Für <lang> werden die im Internet üblichen zwei Zeichen Abkürzungen verwendet.
	Alle weiteren Worte in dieser Zeile sind dann der Meldungstext. Die Reihenfolge innerhalb einer Tabelle ist ohne Bedeutung. Sinnvollerweise wird man jedoch die Einträge für eine Sprache zusammenhalten und alphabetisch nach den Kürzeln sortieren.
Bisher sind die folgenden Zuordnungstabellen definiert.
	FTXT <short> <lang> <freetext> (Funktionen in Lokdekodern) ITXT <short> <lang> <freetext> (INFO liefert eine Zahl zurück) LTXT <short> <lang> <freetext> (Zuordnung der Sprachen) FTXT ist eine optionale Tabelle, insbesondere werden in verschiedenen Sprachen unterschiedliche Abkürzungen verwendet. ITXT und LTXT sollen vollständig sein.
Einige Beispiele mögen zur Verdeutlichung dienen.
	FTXT <short> <lang> <freetext> (Funktionen in Lokdekodern) FTXT Da de Dampf FTXT Sl de Spitzlicht FTXT Pf de Pfeife FTXT Gl de Glocke FTXT Tl de Triebwerksbeleuchtung FTXT Lu de Lüfter FTXT Sa de Stromabnehmer ... FTXT ST en Steam (Dampf) FTXT Hl en Headlight (Spitzlicht) FTXT Wh en Whistle (Pfeife) FTXT Bl en Bell (Glocke) FTXT Nb en Numberboard (Nummerntafel) ... ITXT <short> <lang> <freetext> (INFO liefert eine Zahl zurück) ITXT -1 de nicht unterstützt ITXT -2 de keine Daten ITXT -3 de Zeitlimit überschritten ITXT -1 en unsupported ITXT -2 en no data ITXT -3 en timeout LTXT <short> <lang> <freetext> (Zuordnung der Sprachen) LTXT de de deutsch LTXT en de englisch LTXT fr de franzoesisch LTXT en en english LTXT fr en french LTXT de en german LTXT en fr anglais LTXT fr fr francais LTXT de fr allemand

5 Abfrage der Konfiguration

Der Befehl CONFGET dient dazu, Clients die Möglichkeit zu geben beim Server nachzufragen, welche Fähigkeiten er hat (Siehe #2 Servereigenschaften). Diese Angaben sind verbindlich.

Als zweites kann mit diesem Befehl abgefragt werden, welche Lok-, Funktions-, Schalt-Dekoder und Rückmelde Module dem Server bekannt sind. (Siehe #3 Geräte und Eigenschaften) Diese Information dient (mehreren) Clients dazu einen gleichen Informationsstand zu haben. Diese Informationen sind jedoch nicht verbindlich.

Die Informationen müssen nicht vollständig sein.
Nicht alle bekannten Loks müssen sich auf einer Anlage befinden.
Es können sich "Fremdloks" auf der Anlage befinden, die natürlich nicht in der Konfigurationsdatei beschrieben sind.

Informationen zu Schaltdekodern und Rückmeldern als ortsfeste Bauteile hingegen sollten (in der Regel) korrekt und vollständig sein.

Anmerkungen:

Die Spezifikation des Befehl CONFGET gehört eigentlich in das SRCP (Simple Railroad Command Protocol). Da der Befehl CONFGET jedoch unmittelbar von den Festlegungen im CRCF abhängt, wird er vorerst hier beschrieben. Der Befehl CONFGET hat nur dann Sinn, wenn die Konfigurations Dateien existieren und nach dem CRCF gestaltet sind.

Ein Befehl CONFSET zum Setzen von Konfigurations Informationen ist zur Zeit nicht definiert. Es ist nicht klar, ob dafür ein Bedarf existiert. Wie auch immer, sinnvoll wäre ein solcher Befehl nur für die Informationen zu Lokdekodern wie sie in #3.1 Lok- und Funktionsdekoder festgelegt sind. Die Servereigenschaften (siehe #2 Servereigenschaften) ändern sich nicht, solange ein Server läuft. Auch die Angaben zu einer (zukünftigen) Beschreibung des Anlagenlayouts ändern sich nicht während des laufenden Betriebs. Ein Lok jedoch kann ohne weiteres hinzugefügt, entfernt oder umprogrammiert werden.

5.1 Konfigurationstypen

Zur Zeit sind folgende Konfigurationstypen definiert. Sie sind hier zusammen mit ihren Parametern aufgelistet. Parameter, die zur genaueren Identifikation dienen, sind unterstrichen.
	VERS PORT SCMD	<name> <vers> SRCP <srcp> CRCF <crcf> <port> <source> <command>
	GCMD	<command> <group>
	PRGL PRGA PRFB	<prot> <addr_max> <step_max> <dir> <nro_f> <prot> <addr_max> <module-type> <port_max> <port_inc>
	DCGL DCGA DCFB	<prot> <addr> <step> <dir> <func> <prog> <ps_addr> <V_max> <d_type> <name> <prot> <addr_min> <addr_max> <d_type> <name> <module-type> <port_min> <port_max> <d_type> <name>
	FTXT ITXT LTXT	<short> <lang> <freetext> <short> <lang> <freetext> <short> <lang> <freetext>
Dabei haben die ersten drei [Servereigenschaften] keine weitere Identifikation. GCMD [allgemeine Befehle] hat Befehl und Gerätegruppe als genauere Identifikation. Die nächsten drei [Protokolle] haben Protokoll/Modultyp als genauere Identifikation. Die folgenden drei [Dekoder/Rückmelder] haben Protokoll/Modultyp + Adresse/Portnummer als genauere Identifikation. Die letzten drei [Textzuordnung] haben Kürzel und Sprache als genauere Identifikation.

5.2 Befehl CONFGET

Das generelle Format des Befehls ist:
	CONFGET <conf-type> [<spec_1>] [<spec_2>]
Der Wert von <conf-type> ist der Typ der Information der angefordert wird (vier Zeichen Code). Dahinter steht jeweils, was zur genaueren Identifikation benutzt wird :
	VERS, PORT, SCMD, PRGL, PRGA, PRFB, GCMD DCGL, DCGA, DCFB, FTXT, ITXT, LTXT	Servereigenschaften unterstützte Protokolle [Protokoll/Modultyp] unterstützte Befehle [Befehl] [Gerätegruppe] Dekoder, Rückmelder [Protokoll/Modultyp] [Adresse/Portnummer] Zuordnung Langtext [Kürzel] [Sprache]
[<spec_1>] und [<spec_2>] dienen zur genaueren Identifikationen von Befehlen, Langtext, Protokollen, Dekodern und Rückmeldern :
	Protokoll/Modultyp Befehl + Gerätegruppe Protokoll + Adresse Protokoll + Portnummer Modultyp + Portnummer Kürzel + Sprache	für Protokolle, (PRGL, PRGA, PRFB) für allgemeine Befehle, (GCMD) für Lokdekoder, (DCGL) für Schaltdekoder, (DCGA) für Rückmelder. (DCFB) für Langtext, (FTXT, ITXT, LTXT)
	Für die anderen Informationenstypen sind sie ohne Belang.
Hinweis: Für [<spec_1>], [<spec_2>] kann ein '' als Wildcard verwendet werden. Als Beispiel liefert "CONFGET GCMD FB" alle Befehle zurück, mit denen Rückmelder angesprochen werden. Bei VERS, PORT und SCMD werden grundsätzlich alle zugehörigen Infozeilen zurück geliefert.

5.3 Antwort auf CONFGET

Das generelle Format der Antwort ist:
	*INFO CONF <conf-type> [<spec_1>] [<spec_2>] [.]** [.*] steht dabei für alle weiteren Angaben entsprechend dem Konfigurationstyp.
Wird der Befehl CONFGET nicht unterstützt, lautet die Antwort: INFO -1 Sind keine Daten zu <conf-type> oder [<spec_x>] vorhanden, ist die Antwort: INFO -2
Hinweise: [<conf-type>] ist wie im Abschnitt #5.1 Konfigurationstypen definiert. [<spec_1>] und [<spec_2>] sind wie im Abschnitt #5.2 Befehl CONFGET definiert. Die Antwort auf einen Befehl CONFGET kann mehrere Zeilen "INFO CONF ..." umfassen. Ein Client muss darauf vorbereitet sein, diese sinnvoll zu verarbeiten.

6 Zukünftige Entwicklungen

Auf der Basis des SRCP sind ja schon viele Entwicklungen angedacht. Hier ist der Platz um ihr Informationsbedürfnis festzulegen. Denkbar sind z.B Beschreibung einer Anlage und ihrer logischen Struktur (Blöcke, Fahrstrassen, Besetztmelder, ...) oder Informationen für den Fahrplanbetrieb (Züge, Fahrstrecke, Fahrzeittrassen, ...) und vieles andere.

7 Einige Anmerkungen

Hier will ich kurz Erklärungen zu einigen von mir vorgeschlagenen Punkten geben.

7.1 Hintergrund

In der Diskussion um das SRCP wurde mehrfach der Wunsch nach einer Datei für die Konfiguration geäussert. Dies ist für eine einzige Serverimplementierung sicher nicht zwingend. Werden jedoch unterschiedliche Server angeboten, so ist es für alle weiteren Programme (Clients, Middleware, ...) sinnvoll, die Eigenschaften eines Servers ermitteln zu können.

Weiter wurde angeregt eine gemeinsame Datenbasis für alle Clients bezüglich Lokdekoder, Schaltdekoder und Rückmelder zu haben. Diese Datenbasis, soll ebenso wie die Informationen über die Eigenschaften des Servers über einen SRCP-konformen Befehl abgefragt werden können.

Diesen Wünschen soll mit dieser Definition Rechnung getragen werden.

7.2 Aufteilung

Bisher ist nichts zur Aufteilung der Konfigurationsdaten auf Dateien gesagt worden. Dieser Punkt ist bewusst offengelassen, da ich dafür keinen Vorschlag machen will. Sinnvoll ist sicherlich eine Aufteilung in eine Datei für die Servereigenschaften (siehe #2 Servereigenschaften) und eine Datei für die Dekoder und Rückmelder (siehe #3 Geräte und Eigenschaften). Sollte eines Tages Informationen über das Layout einer Modellbahn Anlage definiert werden, so ist dafür ebenso eine weitere Datei sinnvoll.

Ob eine weitere Aufteilung wünschenswert ist soll die Diskussion zeigen.
Um Namensvorschläge wird gebeten!

7.3 Namen und Typen

Für die Definition der Dekoder und Rückmelder sind Namen eingeführt worden. Dies ist ein Konzept, dass im SRCP bisher nicht existiert und dort auch nicht notwendig ist. Es dient dazu, dass alle Clients Dekoder und Rückmelder mit gleichen Namen darstellen können.
Namen wie "V188-003" oder "Abzweig-Valkenburg" sind für einen Mensch als Benutzer der Clients sicherlich einfacher zuzuordnen als M3-17 oder N-327.

Ebenso sind Typen zur Klassifizierung verschiedener Dekoder- / Rückmeldertypen eingeführt worden. Auch diese sind in SRCP weder definiert noch notwendig. Sie dienen hauptsächlich der Dokumentation. Inwieweit ein Client diese Information verwendet bleibt ihm überlassen.

7.4 Englische Begriffe

Genauso wie im SRCP werden in der formalen Definition englische Begriffe bzw. Abkürzungen davon verwendet. Dies wurde in SRCP in Hinblick auf eine mögliche internationale Verbreitung so beschlossen. Ich schliesse mich diesem Vorgehen an.

8 Änderungsprotokoll

Änderungen von CRCF 0.1 nach CRCF 0.2.0

#2 Servereigenschaften , #3 Geräte und Eigenschaften :
Einige Parameternamen geändert: Das Zeichen '-' durch '_' ersetzt, sowie in einigen Parameternamen das Zeichen '_' eingefügt. Die Abschnitte #5.1 Konfigurationstypen und #5.2 Befehl CONFGET wurden entsprechend angepasst.

#2.1 Serverversion :
Angabe der verwendeten CRCF Version hinzugefügt

#2.3 Serverbefehle :
TIME (= Unterstützung einer Modellzeit) hinzugefügt

#2.4 Allgemeine Befehle :
Argument <group> hinzugefügt. Damit können Befehle und die Gerätegruppen auf die sie angewendet werden definiert werden. Die Abschnitte #5.1 Konfigurationstypen und #5.2 Befehl CONFGET wurden entsprechend angepasst.

#2.5 Protokolle Lokdekoder :
Das Protokoll PS (Protocol by Server) hinzugefügt.

#3.1 Lok- und Funktionsdekoder , #3.2 Schaltdekoder , #3.3 Rückmelde Module :
Parameter <name> an das Ende der Liste gerückt.
Soll kein Name angegeben werden, so ist das Wort "---" statt des Zeichens '-' zu verwenden.
Der Parameter <d_type> ist nicht mehr optional.
Soll keine Typkennung angegeben werden, so ist jetzt das Wort "---" zu verwenden.

#3.1 Lok- und Funktionsdekoder :
Beim Parameter <prog> wird nun das Zeichen '-' statt 'N' für eine nicht vorhandene Funktion verwendet. (besser zu erkennen)
Parameter <ps_addr> als Adresse für das "Protocol by Server" eingeführt. (Vorschlag Martin Ostermann)
Parameter <V_max> für eine virtuelle Höchstgeschwindigkeit eingeführt.
Die Funktionen werden jetzt im Parameter <func> detailiert beschrieben, (Vorschlag Martin Ostermann und Matthias Trute)

#4.1 Langtexte :
Dieser Abschnitt ist neu. Er definiert, was in Version 0.1 als Idee vorgeschlagen wurde.
Ziel ist eine Zuordnung zwischen Abkürzungen und Langtext einzuführen. Dies ist als Ergänzung zur Definition der Funktionen aus Abschnitt #3.1 Lok- und Funktionsdekoder notwendig geworden. Bei dieser Gelegenheit wurden gleich Definition für INFO und Sprache mit eingeführt. Die Abschnitte #5.1 Konfigurationstypen und #5.2 Befehl CONFGET wurden entsprechend angepasst.

#5.1 Konfigurationstypen , #5.2 Befehl CONFGET :
Diese Abschnitte wurden an die Änderungen in den Abschnitten #2 Servereigenschaften (Parameternamen, TIME, neue Parameter, neues Protokoll, ...), #3 Dekoder und Eigenschaften (Parameternamen, neue Parameter, Änderung von Parametern, neues Protokoll, ...), #4 Sonstiges (Zuordnung von Langtexten) angepasst.

Vieles an der internen Struktur vereinfacht, so dass dies Dokument jetzt etwas kleiner ist und damit schneller zu laden und darzustellen ist.