Quelltext der Seite CRCF - Common Railroad Configuration Files 0.1

Erster Entwurf zur Diskussion

''' von Edbert van Eimeren '''


== 1. Einleitung ==

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" |
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 [http://www.der-moba.de/old/Digital/srcp-0.7.0/srcp.html  SRCP Version 0.7.0].
|
| bgcolor="#666666" |
|}

=== 1.1 Konventionen ===

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" |
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/Modultype). Informationen über Dekoder und Rückmelder enthalten zwei weitere Angaben zur genauen Identifizierung (Protokoll/Modultype + 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. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" |
Änderungen gegenüber der vorherigen Version werden mit einem farbigen Strich am rechten Rand markiert. Dabei bedeutet <font color="#FF0000"> '''rot'''</font> Neues oder wesentliche (inhaltliche) Änderungen, <font color="#00FF00">'''grün'''</font> kleinere (textliche) Änderungen, und <font color="#0000FF">'''blau'''</font> Weglassungen. Unveränderte Abschnitte haben eine <font color="#666666">'''graue'''</font> Markierung. Korrekturen von Tipfehlern werden nicht markiert. <br /> Da diese Version komplett neu ist, sind alle Abschnitte grau markiert. Die rote Markierung dieses Abschnittes, ebenso wie die grüne Markierung des [http://www.der-moba.de/old/Digital/crcf-0.1.0/crcf.html#8 Abschnitts 8] dient ledigich als Beispiel.
|
| bgcolor="#FF0000" |
|}

== 2. Servereigenschaften ==

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" | Hier werden die Eigenschaften beschrieben, die eine Serverimplementierung ausmachen, das heißt, welche Möglichkeiten ein Server seinen Clients zur Verfügung stellt.
|
| bgcolor="#666666" |
|}

=== 2.1 Serverversion ===

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" |
'''Überschrift: '= Version =' '''

Es gibt genau eine Zeile mit der Information über die Version des Servers und des verwendeten SRCP.
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | '''VERS <name> <vers> SRCP <srcp>'''<br />
|
| bgcolor="#666666" |
|- valign="Top"
|
| <name>
| Name des Servers
|
| bgcolor="#666666" |
|- valign="Top"
|
| <vers>
| Version des Servers
|
| bgcolor="#666666" |
|- valign="Top"
|
| <srcp>
| Version des verwendeten SRCP <br />
|
| bgcolor="#666666" |
|- valign="Top"
|
| Hinweis:
| nowrap="NOWRAP" | Die Versionsinformation sollte als erstes in einer Konfigurationsdatei stehen.
|
| bgcolor="#666666" |
|}

=== 2.2 Übertragungskanäle ===

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" |
Welche Kanäle werden von einer Serverimplementierung zur Kommunikation mit Clients benutzt. Dies ist durch das SRCP weitgehend festgelegt.

'''Überschrift: '= Ports =''''

Für jeden Kanal gibt es eine Zeile des Formats:
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | '''PORT <port> <direction> '''<br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Werte für '''<port>''' sind:
|
| bgcolor="#666666" |
|- valign="Top"
|
| COMMAND
| nowrap="NOWRAP" | Kommando Port <br /> Befehle des Clients an den Server, direkte Antworten des Servers darauf.
|
| bgcolor="#666666" |
|- valign="Top"
|
| FEEDBACK
| Rückmelde Port <br /> Statusänderungen von Rückmelde Modulen.
|
| bgcolor="#666666" |
|- valign="Top"
|
| INFO
| Info Port (Broadcast Kanal) <br /> Statusänderungen von Lok- und Schaltdekodern, Modellzeit. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Werte für '''<direction>''' sind:
|
| bgcolor="#666666" |
|- valign="Top"
|
| CLIENT
| Unidirektional vom Client zum Server
|
| bgcolor="#666666" |
|- valign="Top"
|
| SERVER
| Unidirektional vom Server zum Client
|
| bgcolor="#666666" |
|- valign="Top"
|
| BOTH
| Bidirektional
|
| bgcolor="#666666" |
|}

=== 2.3 Serverbefehle ===

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" |
Welche Befehle werden von einer Server zu seiner Steuerung akzeptiert. Dies ist durch das SRCP weitgehend festgelegt.

'''Überschrift: '= Server Commands =''''

Für jeden Befehl gibt es eine Zeile des Formats:
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | '''SCMD <command> '''<br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Werte für '''<command>''' sind:
|
| bgcolor="#666666" |
|- valign="Top"
|
| LOGOUT
| Befehl zum Beenden der Verbindung zu einem Client.
|
| bgcolor="#666666" |
|- valign="Top"
|
| RESET
| Befehl zur Neu-Initialisieung des Servers.
|
| bgcolor="#666666" |
|- valign="Top"
|
| SHUTDOWN
| Befehl zum Beenden des Servers.
|
| bgcolor="#666666" |
|- valign="Top"
|
| VOLTAGE
| nowrap="NOWRAP" | Ein-/Ausschalten des Digitalstroms über STARTVOLTAGE/STOPVOLTAGE <br /> Kompatibilität zu früheren Versionen des SRCP
|
| bgcolor="#666666" |
|- valign="Top"
|
| POWER
| Ein-/Ausschalten des Digitalstroms über SET POWER [ON/OFF] <br /> Aktueller Befehl in SRCP (ab Version 0.???)
|
| bgcolor="#666666" |
|}

=== 2.4 Allgemeine Befehle ===

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" |
Welche Befehle werden von einer Server zu seiner Steuerung akzeptiert. Dies ist durch das SRCP weitgehend festgelegt.

'''Überschrift: '= General Commands =''''

Für jeden Befehl gibt es eine Zeile des Formats:
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | '''GCMD <command> '''<br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Werte für '''<command>''' sind:
|
| bgcolor="#666666" |
|- valign="Top"
|
| SET
| Befehl zum Setzen eines Wertes.
|
| bgcolor="#666666" |
|- valign="Top"
|
| GET
| Befehl zum Ermitteln eines Wertes.
|
| bgcolor="#666666" |
|- valign="Top"
|
| WAIT
| Befehl zum Warten bis ein bestimmter Zustand erreicht wird.
|
| bgcolor="#666666" |
|- valign="Top"
|
| INIT
| Befehl zum Initialisieren von Geräte(gruppen).
|
| bgcolor="#666666" |
|- valign="Top"
|
| TERM
| nowrap="NOWRAP" | Befehl zum Aufheben von mit INIT getroffenen Einstellungen. <br />
|
| bgcolor="#666666" |
|- valign="Top"
|
| WRITE
| Befehl zum Programmieren eines Wertes eines Dekoders.
|
| bgcolor="#666666" |
|- valign="Top"
|
| READ
| Befehl zum Lesen eines Wertes eines Dekoders.
|
| bgcolor="#666666" |
|- valign="Top"
|
| VERIFY
| Befehl zum Überprüfen eines Wertes eines Dekoders. <br />
|
| bgcolor="#666666" |
|- valign="Top"
|
| CONFGET
| Befehl zum Ermitteln von Konfigurationsinformationen. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Ein Befehl, der nicht eingetragen ist, wird nicht unterstützt. Lediglich der Befehl SET ist zwingend vorgeschrieben, alle anderen können implementiert werden. <br /> 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.
|
| bgcolor="#666666" |
|}

=== 2.5 Protokolle Lokdekoder ===

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" |
Welche Protokolle für Lokdekoder werden von einem Server akzeptiert. Funktionsdekoder werden wie Lokdekoder behandelt. <br /> 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 =''''

Für jedes unterstützte Protokoll gibt es eine Zeile des Formats:
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | '''PRGL <prot> <addrmax> <speedmax> <dir> <n-func>'''<br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Werte für '''<prot>''' sind:
|
| bgcolor="#666666" |
|- valign="Top"
|
| M.
| nowrap="NOWRAP" | Protokolle nach den Märklin/Motorola Standards.
|
| bgcolor="#666666" |
|- valign="Top"
|
| N.
| Protokolle nach den NMRA-DCC Standards. <br />
|
| bgcolor="#666666" |
|- valign="Top"
|
| ''S.''
| ''Protokolle nach den Trix Selectrix Standards.''
|
| bgcolor="#666666" |
|- valign="Top"
|
| ''F.''
| ''Protokolle nach den Fleischmann FMZ Standards.''
|
| bgcolor="#666666" |
|- valign="Top"
|
| ''Z.''
| ''Protokolle nach den ZIMO Standards.''<br />
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" |
Der Punkt ist durch geeignete Buchstaben/Ziffern zu ersetzen. Siehe dazu die aktuelle Spezifikation des SRCP. <br /> Die Werte für Selectrix, FMZ und ZIMO sind reserviert für zukünftige Entwicklungen (Intellibox, Twin-Box, ...).

PS (= Protocol by Server) ist hier nicht aufgeführt, da es kein reales Protokoll ist, sondern eine Anweisung an den Server, selbständig ein geeignetes Protokoll zu wählen.
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Wert für '''<addrmax>'''<nowiki>: </nowiki>
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Der Wert für <addrmax> gibt die höchste Adresse an, 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. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Wert für '''<speedmax>'''<nowiki>: </nowiki>
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Der Wert für <speedmax> gibt die höchste Fahrstufen an, die von diesem Protokoll unterstützt wird. Aktuelle Werte für die höchste Fahrstufe sind 14, 27, 28, 128. Ein Fahrstufenbereich beginnt immer bei der Fahrstufe 0. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Werte für '''<dir>''' sind:
|
| bgcolor="#666666" |
|- valign="Top"
|
| abs
| Absolute Fahrtrichtungsangabe.
|
| bgcolor="#666666" |
|- valign="Top"
|
| rel
| Relative Fahrtrichtungsangabe. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Wert für '''<n-func>'''<nowiki>: </nowiki>
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Der Wert für <n-func> gibt an wieviele Zusatzfunktionen 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.
|
| bgcolor="#666666" |
|}

=== 2.6 Protokolle Schaltdekoder ===

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" |
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 =''''

Für jedes unterstützte Protokoll gibt es eine Zeile des Formats: <br />
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | '''PRGA <prot> <addrmax>'''<br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Werte für '''<prot>''' sind:
|
| bgcolor="#666666" |
|- valign="Top"
|
| N
| nowrap="NOWRAP" | Protokoll nach den Märklin/Motorola Standards.
|
| bgcolor="#666666" |
|- valign="Top"
|
| M
| Protokoll nach den NMRA-DCC Standards. <br />
|
| bgcolor="#666666" |
|- valign="Top"
|
| ''S''
| ''Protokoll nach den Trix Selectrix Standards.''
|
| bgcolor="#666666" |
|- valign="Top"
|
| ''F''
| ''Protokoll nach den Fleischmann FMZ Standards.''
|
| bgcolor="#666666" |
|- valign="Top"
|
| ''Z''
| ''Protokoll nach den ZIMO Standards.''<br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Wert für '''<addrmax>'''<nowiki>: </nowiki>
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Der Wert für <addrmax> gibt die höchste Adresse an, die von diesem Protokoll unterstützt wird. Aktuelle Werte für den Adressbereich sind ???, 4096. Ein Adressbereich beginnt bei der Adresse 1.
|
| bgcolor="#666666" |
|}

=== 2.7 Protokolle Rückmelde Module ===

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" |
Welche Rückmelde Module und Anschlussarten werden von einem Server akzeptiert. <br /> 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 =' '''

Für jeden unterstützten Modultyp gibt es eine Zeile des Formats:
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | '''PRFB <module-type> <port-max> <port-inc>'''<br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Werte für '''<module-type>''' sind:
|
| bgcolor="#666666" |
|- valign="Top"
|
| S88
| Märklin s88-Bus am Parallelport des PC.
|
| bgcolor="#666666" |
|- valign="Top"
|
| I8255
| i8255 Karte.
|
| bgcolor="#666666" |
|- valign="Top"
|
| M6051
| Märklin s88-Bus via Interface 6051. <br />
|
| bgcolor="#666666" |
|- valign="Top"
|
| ''LENZFB''
| ''Rückmelde-Module aus dem Lenz System.''
|
| bgcolor="#666666" |
|- valign="Top"
|
| ''DTFB''
| nowrap="NOWRAP" | ''Rückmelde-Module aus dem Digitrax System (LocoNet).''
|
| bgcolor="#666666" |
|- valign="Top"
|
| ''SELFB''
| ''Rückmelde-Module aus dem Trix Selectrix System.''
|
| bgcolor="#666666" |
|- valign="Top"
|
| ''FMZFB''
| ''Rückmelde-Module aus dem Fleischmann FMZ System.''
|
| bgcolor="#666666" |
|- valign="Top"
|
| ''ZIMOFB''
| ''Rückmelde-Module aus dem ZIMO System.''<br />
|
| bgcolor="#666666" |
|- valign="Top"
|
| Hinweis:
| Die letzten fünf sind reservierte Namen, die sich ggfs. noch ändern können. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Wert von '''<port-max>'''
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Der Wert von <port-max> gibt die höchste Adresse an, die für diesen Modultype zulässig ist. Ein Nummerbereich beginnt mit (0 | 1) ???. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Wert von '''<port-inc>'''
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Der Wert von <port-inc> gibt an wieviele Ports in einem Modul dieses Typs zusammengefasst sind.
|
| bgcolor="#666666" |
|}

=== 2.8 Sonstige Gerätetypen ===

{| width="95%" cellpadding="2" align="Center"
|- valign="Top"
| colspan="3" | Dies kann erst dann spezifiziert werden, wenn entsprechende Definitionen in SRCP vorliegen.
|
| bgcolor="#666666" |
|}

== 3. Geräte und ihre Eigenschaften ==

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" | Hier werden die Eigenschaften beschrieben, die ein tatsächliches Gerät (Lok-, Schaltdekoder, Rückmeldemodul) hat. Das heißt, welche Funktionen von einem Dekoder oder Modul tatsächlich realisiert werden. Dies kann ggfs. weniger sein, als das Protokoll erlaubt.
|
| bgcolor="#666666" |
|}

=== 3.1 Lok- und Funktionsdekoder ===

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" |
'''Überschrift: '= Locomotive & Function =''''

Für jeden definierten Lok- und Funktionsdekoder gibt es eine Zeile des Formats:
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | '''DCGL <name> <prot> <addr> <speed> <dir> <n-func> <prog> [<type>]'''<br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Wert von '''<name>'''
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Der Wert von <name> ist ein eindeutiger Name für diesen Lok-/Funktions- Dekoder (z.B. die Loknummer). Der Name muss ein Wort sein. Das heisst er darf kein Leerzeichen oder Tabultorzeichen enthalten. Zur optischen Gliederung ist ggfs. das Zeichen '-' einzusetzen . Beispiele: "V188-003", "Berghexe", "Zuckersusi". <br /> Soll keine Name angegeben werden, ist stattdessen das Zeichen '-' zu verwenden. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Werte für '''<prot>'''<nowiki>: </nowiki>
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" |
Die Werte für <prot> sind wie in 'Protokolle Lokdekoder' [http://www.der-moba.de/old/Digital/crcf-0.1.0/crcf.html#2.5 (Abschnitt 2.5)] definiert. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Wert von '''<addr>'''<nowiki>: </nowiki>
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Der Wert von <addr> gibt die Adresse dieses Dekoders unter dem gewählten Protokoll an. Multiprotokolldekoder können demgemäss mehrere Einträge haben. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Wert für '''<speed>'''<nowiki>: </nowiki>
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Der Wert von <speed> gibt die höchste Fahrstufen an, die von diesem Dekoder unterstützt wird. Für Funktionsdekoder ist dieser Wert ggfs. auf 0 zu setzen. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Werte für '''<dir>''' sind:
|
| bgcolor="#666666" |
|- valign="Top"
|
| abs
| Absolute Fahrtrichtungsangabe.
|
| bgcolor="#666666" |
|- valign="Top"
|
| rel
| Relative Fahrtrichtungsangabe. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Wert von '''<n-func>'''<nowiki>: </nowiki>
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Der Wert für <n-func> gibt an wieviele Zusatzfunktionen von diesem Dekoder unterstützt werden. Es wird implizit davon ausgegeangen, dass eine Standardfunktion immer implementiert ist. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Der Wert von '''<prog>''' ist ein Wort mit 7 Buchstaben:
|
| bgcolor="#666666" |
|- valign="Top"
|
| 1)
| nowrap="NOWRAP" | Modus (P = Programmiergleis, F = on the Fly [im Betrieb])
|
| bgcolor="#666666" |
|- valign="Top"
|
| 2)
| WRITE- Befehl (W = unterstützt)
|
| bgcolor="#666666" |
|- valign="Top"
|
| 3)
| READ- Befehl (R = unterstützt)
|
| bgcolor="#666666" |
|- valign="Top"
|
| 4)
| VERIFY-Befehl (V = unterstützt) <br />
|
| bgcolor="#666666" |
|- valign="Top"
|
| 5)
| REGISTER (R = unterstützt)
|
| bgcolor="#666666" |
|- valign="Top"
|
| 6)
| VARIABLE (V = unterstützt)
|
| bgcolor="#666666" |
|- valign="Top"
|
| 7)
| BIT (B = unterstützt) <br />
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Wird eine Funktion nicht unterstützt, so ist statt dessen das Zeichen N (= none) zu setzen. <br /> Beispiele: Ein Dekoder, der nur Register auf dem Programmiergleis schreiben kann, erhält die Zeichenkette "PWNNRNN". <br /> Ein Dekoder, der Register und Variablen im laufenden Betrieb lesen und schreiben kann, erhält die Zeichenkette "FWRNRVN". <br /> Ein Dekoder, der nur über Mäuseklavier und Potis eingestellt wird, erhält die Zeichenkette "NNNNNNN". <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Wert von '''<type>'''<nowiki>: </nowiki>
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Der Wert von <type> ist eine Kennung für den Dekodertype. Dekoder des gleichen Typs erhalten den gleichen Wert für <type>. Der Wert von <type> muss ein Wort sein. Das heisst er darf kein Leerzeichen oder Tabultorzeichen enthalten. Zur optischen Gliederung ist ggfs. das Zeichen '-' einzusetzen. Sinnvollerweise hält man sich an die Bezeichnung des Hersteller. Die Angabe dient zur Zeit nur der Dokumentation und ist daher optional.
|
| bgcolor="#666666" |
|}

=== 3.2 Schaltdekoder ===

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" |
'''Überschrift: '= Accessory =''''

Für jeden definierten Schaltdekoder gibt es eine Zeile des Formats: <br />
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | '''DCGA <name> <prot> <addrmin> <addrmax> [<type>]'''<br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Wert von '''<name>'''<nowiki>: </nowiki>
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Der Wert von <name> ist ein eindeutiger Name für diesen Lok-/Funktions- Dekoder (z.B. die Loknummer). Der Name muss ein Wort sein. Das heisst er darf kein Leerzeichen oder Tabultorzeichen enthalten. Zur optischen Gliederung ist ggfs. das Zeichen '-' einzusetzen . Beispiele: "V188-003", "Berghexe", "Zuckersusi". <br /> Soll keine Name angegeben werden, ist stattdessen das Zeichen '-' zu verwenden. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Werte für '''<prot>''' sind:
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" nowrap="NOWRAP" |
Die Werte für <prot> sind wie in "Protokolle Schaltdekoder" [http://www.der-moba.de/old/Digital/crcf-0.1.0/crcf.html#2.6 (Abschnitt 2.6)] angegeben. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Wert von '''<addrmin>'''<nowiki>: </nowiki>
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Der Wert von <addrmin> gibt die die Adresse des ersten verwendeten Ausgang dieses Dekoders an. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Wert von '''<addrmax>'''<nowiki>: </nowiki>
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Der Wert von <addrmax> gibt die die Adresse des letzten verwendeten Ausgang dieses Dekoders an. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Wert von '''<type>'''<nowiki>: </nowiki>
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Der Wert von <type> ist eine Kennung für den Dekodertype. Dekoder des gleichen Typs erhalten den gleichen Wert für <type>. Der Wert von <type> muss ein Wort sein. Das heisst er darf kein Leerzeichen oder Tabultorzeichen enthalten. Zur optischen Gliederung ist ggfs. das Zeichen '-' einzusetzen. Sinnvollerweise hält man sich an die Bezeichnung des Hersteller. Die Angabe dient zur Zeit nur der Dokumentation und ist daher optional. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Hinweis:
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Für einen Einzeldekoder gilt <addrmin> = <addrmax> Auf diese Art kann je nach Wunsch eine Gruppendefiniton oder eine Einzeldefinition der Schaltdekoderausgänge erfolgen.
|
| bgcolor="#666666" |
|}

=== 3.3 Rückmelde Module ===

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" |
'''Überschrift: '= Feedback Units =''''

Für jede definierte Rückmelde Modul gibt es eine Zeile des Formats: <br />
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | '''DCGA <name> <modul-type> <port-min> <port-max> [<type>]'''<br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Wert von '''<name>'''<nowiki>: </nowiki>
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Der Wert von <name> ist ein eindeutiger Name für dieses Rückmelde Modul. Der Name muss ein Wort sein. Das heisst er darf kein Leerzeichen oder Tabultorzeichen enthalten. Zur optischen Gliederung ist ggfs. das Zeichen '-' einzusetzen. Beispiele: "V188-003", "Berghexe", "Zuckersusi". <br /> Soll keine Name angegeben werden, ist stattdessen das Zeichen '-' zu verwenden. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Werte für '''<modul-type>'''<nowiki>: </nowiki>
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" |
Der Wert von <modul-type> gibt Art des verwendeten Modules an. Es gelten die Werte, die in "Protokolle Rückmelder" [http://www.der-moba.de/old/Digital/crcf-0.1.0/crcf.html#2.7 (Abschnitt 2.7)] dafür definiert sind. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Wert von '''<port-min>'''<nowiki>: </nowiki>
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Der Wert von <port-min> gibt die Portnummer des ersten verwendeten Eingang dieses Modules an. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Wert von '''<port-max>'''<nowiki>: </nowiki>
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Der Wert von <port-max> gibt die Portnummer des letzten verwendeten Eingang dieses Modules an. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Wert von '''<type>'''<nowiki>: </nowiki>
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Der Wert von <type> ist eine Kennung für den konkreten Typ eines Rückmelde Modules. Hier dient er hauptsächlich zur Unterscheidung verschiedener Lieferanten eines Modultypes. Rückmelder des gleichen Typs erhalten den gleichen Wert für <type>. Der Wert von <type> muss ein Wort sein. Das heisst er darf kein Leerzeichen oder Tabultorzeichen enthalten. Zur optischen Gliederung ist ggfs. das Zeichen '-' einzusetzen. Sinnvollerweise hält man sich an die Bezeichnung des Hersteller. Die Angabe dient zur Zeit nur der Dokumentation und ist daher optional. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Hinweis:
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" nowrap="NOWRAP" | Mit <port-min> = <port-max> kann man falls gewünscht auch jeden Port einzeln definieren.
|
| bgcolor="#666666" |
|}

== 4. Sonstiges ==

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" |
Dies ist erst einmal ein Platzhalter für zukünftige Erweiterungen oder Festlegungen, die übergreifend sind. Beispielsweise könnte ich mir hier eine Liste von Rückgabewerten vorstellen, wenn das INFO Statement als Antwort auf einen GET Befehl keine Daten zur Verfügung stellen kann.

'''Beispiel: INFO <value> <lang> <Text>'''

Dabei ist <value> der Rückgabewert (eine Zahl, in der Regel negativ), <lang> eine Sprache (z.B. de := deutsch, en := englisch). Alle weiteren Worte in dieser Zeile sind dann der Meldungstext. Das Paar <value>, <lang> muss eindeutig sein. Werden mehrere Sprachen angeboten, so sind für jede Sprache alle möglichen Werte von <value> mit Text zu versehen.
|
| bgcolor="#666666" |
|}

== 5. Abfrage der Konfiguration ==

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" |
Der Befehl CONFGET dient dazu, Clients die Möglichkeit zu geben beim Server nachzufragen, welche Fähigkeiten er hat. [http://www.der-moba.de/old/Digital/crcf-0.1.0/crcf.html#2 (Abschnitt 2)] 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. [http://www.der-moba.de/old/Digital/crcf-0.1.0/crcf.html#3 (Abschnitt 3)] 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.

 Anmerkung:
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Die Spezifikation des Befehl CONFGET gehört eigentlich in das SRCP (Simple Railroad Command Protocol). Dies hier ist nur der erste Vorschlag.
|
| bgcolor="#666666" |
|}

=== 5.1 Konfigurationstypen ===

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" | Zur Zeit sind 10 verschiedene '''Konfigurationstypen''' definiert.
|
| bgcolor="#666666" |
|- valign="Top"
|
| VERS
| <name> <vers> SRCP <srcp>
|
| bgcolor="#666666" |
|- valign="Top"
|
| PORT
| <port> <direction>
|
| bgcolor="#666666" |
|- valign="Top"
|
| SCMD
| <command>
|
| bgcolor="#666666" |
|- valign="Top"
|
| GCMD
| <command> <br />
|
| bgcolor="#666666" |
|- valign="Top"
|
| PRGL
| <prot> <addrmax> <speedmax> <dir> <n-func>
|
| bgcolor="#666666" |
|- valign="Top"
|
| PRGA
| <prot> <addrmax>
|
| bgcolor="#666666" |
|- valign="Top"
|
| PRFB
| <module-type> <port-max> <port-inc> <br />
|
| bgcolor="#666666" |
|- valign="Top"
|
| DCGL
| nowrap="NOWRAP" | <name> <prot> <addr> <spmax> <dir> <n-func> <prog> [<type>]
|
| bgcolor="#666666" |
|- valign="Top"
|
| DCGA
| <name> <prot> <addrmin> <addrmax> [<type>]
|
| bgcolor="#666666" |
|- valign="Top"
|
| DCFB
| <name> <module-type> <port-min> <port-max> [<type>] <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Dabei haben die ersten vier keine weitere Identifikation, die nächsten drei Protokoll/Modultype als genauere Identifikation. Die letzten drei haben Protokoll/Modultype + Adresse/Portnummer als genauere Identifikation. Bei diesen ist jedoch als Besonderheit zwischen dem Konfigurationstyp und der genaueren Identifikation ein frei wählbarer - allerdings eindeutiger - Name eingefügt.
|
| bgcolor="#666666" |
|}

=== 5.2 Befehl CONFGET ===

{| width="95%" cellpadding="2" align="Center"
|- valign="Top"
| colspan="3" | Das generelle Format des Befehls ist:
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | '''CONFGET <conf-type> [<spec-1>] [<spec-2>]'''<br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Der Wert von <conf-type> ist der Typ der Information der angefordert wird (vier Zeichen Kode):
|
| bgcolor="#666666" |
|- valign="Top"
|
| nowrap="NOWRAP" | VERS, PORT, SCMD, GCMD,
| Servereigenschaften
|
| bgcolor="#666666" |
|- valign="Top"
|
| PRGL, PRGA, PRFB,
| unterstützte Protokolle [<spec-1>]
|
| bgcolor="#666666" |
|- valign="Top"
|
| DCGL, DCGA, DCFB,
| nowrap="NOWRAP" | Dekoder, Rückmelder [<spec-1>] [<spec-2>] <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | [<spec-1>] und [<spec-2>] sind genauere Identifikationen von Protokollen, Dekodern und Rückmeldern:
|
| bgcolor="#666666" |
|- valign="Top"
|
| Protokoll / Modultype
| nowrap="NOWRAP" | für Protokolle, (PRGL, PRGA, PRFB)
|
| bgcolor="#666666" |
|- valign="Top"
|
| Protokoll + Adresse
| für Lokdekoder, (DCGL)
|
| bgcolor="#666666" |
|- valign="Top"
|
| Protokoll + Portnummer
| für Schaltdekoder, (DCGA)
|
| bgcolor="#666666" |
|- valign="Top"
|
| nowrap="NOWRAP" | Modultype + Portnummer
| für Rückmelder. (DCFB) <br />
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Für die anderen Informationenstypen sind sie ohne Belang. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Hinweis:
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Für [<spec-1>], [<spec-2>] kann ein '*' als Wildcard verwendet werden. Als Beispiel liefert "CONFGET DCGL NB *" alle Lokdekoder zurück, die mit dem NMRA-DCC Basic Protokoll angesprochen werden.
|
| bgcolor="#666666" |
|}

=== 5.3 Antwort auf CONFGET ===

{| width="95%" cellpadding="2" align="Center"
|- valign="Top"
| colspan="3" | Das generelle Format der Antwort ist:
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" nowrap="NOWRAP" |
'''INFO CONF <conf-type> [<spec-1>] [<spec-2>] [.*] '''

[.*] steht dabei für alle weiteren Angaben entsprechend dem Konfigurationstyp. <br />
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Wird der Befehl CONFGET nicht unterstützt, lautet die Antwort:
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | INFO -1
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Sind keine Daten zu <conf-type> oder [<spec-x>] vorhanden, ist die Antwort:
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | INFO -2
|
| bgcolor="#666666" |
|- valign="Top"
| colspan="3" | Hinweis:
|
| bgcolor="#666666" |
|- valign="Top"
|
| colspan="2" | Die Antwort auf einen Befehl CONFGET kann mehrere Zeilen "INFO CONF ..." umfassen. Ein Client muss darauf vorbereitet sein, diese sinnvoll zu verarbeiten.
|
| bgcolor="#666666" |
|}

== 6. Zukünftige Entwicklungen ==

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" | 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.
|
| bgcolor="#666666" |
|}

== 7. Einige Anmerkungen ==

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" | Hier will ich kurz Erklärungen zu einigen von mir vorgeschlagenen Punkten geben.
|
| bgcolor="#666666" |
|}

=== 7.1 Hintergrund ===

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" |
In der Diskussion um das SRCP wurde mehrfach der Wunsch nach einer zentralen Konfigurationsbasis geäussert. Dies ist für eine einzige Serverimplementierung sicher nicht zwingend. Werden jedoch unterschiedliche Serverimplementierung 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.

Beiden Wünschen soll mit dieser Definition Rechnung getragen werden.
|
| bgcolor="#666666" |
|}

=== 7.2 Aufteilung ===

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" |
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 [http://www.der-moba.de/old/Digital/crcf-0.1.0/crcf.html#2 Kapitel 2]) und eine Datei für die Dekoder und Rückmelder (siehe [http://www.der-moba.de/old/Digital/crcf-0.1.0/crcf.html#3 Kapitel 3]). Sollte eines Tages Informationen über das Layout definiert werden, so ist dafür sicher eine weitere Datei sinnvoll.

 Ob eine weitere Aufteilung wünschenswert ist soll die Diskussion zeigen.
|
| bgcolor="#666666" |
|}

=== 7.3 Namen und Typen ===

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" |
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. <br /> 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.
|
| bgcolor="#666666" |
|}

=== 7.4 Englische Begriffe ===

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" | 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.
|
| bgcolor="#666666" |
|}

== 8. Änderungsprotokoll ==

{| width="95%" cellpadding="1" align="Center"
|- valign="Top"
| colspan="3" | Hier wird in späteren Versionen eine Übersicht über die wichtigsten Änderungen von Version zu Version stehen.
|
| bgcolor="#00FF00" |
|}

[[Kategorie:SRCP]]