Handbuch

STS Handbuch

Stellwerksim Handbuch

Webseiten-Werkzeuge


stellwerksim:plugins:spezifikation

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen RevisionVorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
stellwerksim:plugins:spezifikation [2017/08/24 22:01] DevonFroschstellwerksim:plugins:spezifikation [2022/05/20 17:02] (aktuell) – [Befehle] manuel3108
Zeile 1: Zeile 1:
-===== Spezifikation =====+===== Spezifikation der Pluginschnittstelle =====
 {{indexmenu_n>30}} {{indexmenu_n>30}}
  
Zeile 5: Zeile 5:
 Nach dem Connect meldet sich der Sim mit dem Status-XML: Nach dem Connect meldet sich der Sim mit dem Status-XML:
 <code> <code>
-<status code='300'>ein Text</status>+<status code='300' >STS Plugin Interface, bitte anmelden.</status>
 </code> </code>
  
Zeile 37: Zeile 37:
 <register name='Supersuper' autor='der Held' version='0.1alpha-nix' protokoll='1' text='Tut nix!' /> <register name='Supersuper' autor='der Held' version='0.1alpha-nix' protokoll='1' text='Tut nix!' />
 </code> </code>
 +
 Antwort: Antwort:
 <code> <code>
Zeile 49: Zeile 50:
 Parameter: Parameter:
   * sender: Wird wieder zurückgesendet   * sender: Wird wieder zurückgesendet
 +
 Antwort: Antwort:
   * sender: Wert aus der Anfrage   * sender: Wert aus der Anfrage
Zeile 57: Zeile 59:
 <simzeit sender='28908598' /> <simzeit sender='28908598' />
 </code> </code>
 +
 Antwort: Antwort:
 <code> <code>
Zeile 63: Zeile 66:
  
 ==== <anlageninfo> ==== ==== <anlageninfo> ====
-Liefert Name ('name') des Stellwerks, AID ('aid') und Build des Sims ('simbuild').+Liefert Name ('name') des Stellwerks, AID ('aid') und Build des Sims ('simbuild'). Außerdem, ob ein Online-Spiel läuft oder in der Sandbox gestartet wurde.
  
 Parameter: Keine Parameter: Keine
Zeile 71: Zeile 74:
 <anlageninfo /> <anlageninfo />
 </code> </code>
 +
 Antwort: Antwort:
 <code> <code>
-<anlageninfo simbuild='1' name='Plugin Test Anlage' aid='86' />+<anlageninfo simbuild='1' name='Plugin Test Anlage' aid='86' region='Testregion' online='True'/>
 </code> </code>
  
Zeile 85: Zeile 89:
 <bahnsteigliste /> <bahnsteigliste />
 </code> </code>
 +
 Antwort: Antwort:
 <code> <code>
 <bahnsteigliste > <bahnsteigliste >
-  <bahnsteig name='1' >+  <bahnsteig name='1' haltepunkt='false'>
     <n name='2' />     <n name='2' />
     <n name='3' />     <n name='3' />
   </bahnsteig>   </bahnsteig>
-  <bahnsteig name='2' >+  <bahnsteig name='2' haltepunkt='true'>
     <n name='1' />     <n name='1' />
   </bahnsteig>   </bahnsteig>
-  <bahnsteig name='3' >+  <bahnsteig name='3' haltepunkt='false'>
     <n name='1' />     <n name='1' />
   </bahnsteig>   </bahnsteig>
Zeile 105: Zeile 110:
  
 Parameter: Keine Parameter: Keine
-Antwort:  
  
 Beispiel: Beispiel:
Zeile 111: Zeile 115:
 <zugliste /> <zugliste />
 </code> </code>
 +
 Antwort: Antwort:
 <code> <code>
Zeile 123: Zeile 128:
  
 Wurde der letzte Fahrplanhalt passiert und es somit keine anzufahrenden Gleise mehr gibt, werden die Attribute 'gleis' und 'plangleis' nicht mehr mitgeschickt. So lässt sich erkennen, ob ein Zug den letzten Fahrplanhalt passiert hat. Umgeleitete Züge haben ebenfalls kein 'gleis' und 'plangleis', da sie keinen Fahrplan haben. Wurde der letzte Fahrplanhalt passiert und es somit keine anzufahrenden Gleise mehr gibt, werden die Attribute 'gleis' und 'plangleis' nicht mehr mitgeschickt. So lässt sich erkennen, ob ein Zug den letzten Fahrplanhalt passiert hat. Umgeleitete Züge haben ebenfalls kein 'gleis' und 'plangleis', da sie keinen Fahrplan haben.
 +
 +Zusatztexte (freier Text) stehen in 'usertext' und 'hinweistext'.
  
 Parameter: Parameter:
Zeile 131: Zeile 138:
 <zugdetails zid='1' /> <zugdetails zid='1' />
 </code> </code>
 +
 Antwort: Antwort:
 <code> <code>
-<zugdetails zid='1' name='RE 10' verspaetung='+2' gleis='1' plangleis='1' von='A-Stadt' nach='B-Hausen' sichtbar='true' amgleis='true' />+<zugdetails zid='1' name='RE 10' verspaetung='+2' gleis='1' plangleis='1' von='A-Stadt' nach='B-Hausen' sichtbar='true' amgleis='true' usertext='' usertextsender='' hinweistext='' />
 </code> </code>
  
Zeile 146: Zeile 154:
 <zugfahrplan zid='1' /> <zugfahrplan zid='1' />
 </code> </code>
 +
 Antwort: Antwort:
 <code> <code>
Zeile 159: Zeile 168:
   * abfahrt   * abfahrt
   * ausfahrt   * ausfahrt
 +  * rothalt
 +  * wurdegruen
 +  * kuppeln
 +  * fluegeln
 +
 Möchte man alle haben, müssen entsprechend viele Registrierungen abgeschickt werden. Man muss sich für jeden Zug neu registrieren, mehrmaliges Registrieren für den selben Zug ist nicht zulässig! Die Meldung eines Ereignisses enthält die ZID, die Art sowie alle Daten, die auch per <zugdetails> geliefert werden. Im Falle eines D-Flags wird nur die Ankunft gemeldet, jedoch keine Abfahrt. Möchte man alle haben, müssen entsprechend viele Registrierungen abgeschickt werden. Man muss sich für jeden Zug neu registrieren, mehrmaliges Registrieren für den selben Zug ist nicht zulässig! Die Meldung eines Ereignisses enthält die ZID, die Art sowie alle Daten, die auch per <zugdetails> geliefert werden. Im Falle eines D-Flags wird nur die Ankunft gemeldet, jedoch keine Abfahrt.
  
Zeile 165: Zeile 179:
 <ereignis zid='1' art='einfahrt' /> <ereignis zid='1' art='einfahrt' />
 </code> </code>
 +
 Antwort: Antwort:
 <code> <code>
 <ereignis zid='1' art='einfahrt' name='RE 10' verspaetung='+2' gleis='1' plangleis='1' von='A-Stadt' nach='B-Hausen' sichtbar='true' amgleis='true' /> <ereignis zid='1' art='einfahrt' name='RE 10' verspaetung='+2' gleis='1' plangleis='1' von='A-Stadt' nach='B-Hausen' sichtbar='true' amgleis='true' />
 +</code>
 +
 +==== <wege> ====
 +Liefert eine Liste aller Knoten und Verbindungen des Gleisbild. Daraus sind die Fahrwege von Einfahrten zu Bahnsteigen zu Bahnsteigen zu Ausfahrten ermittelbar.
 +
 +Knoten sind dabei Gleiselemente wie Signale, Einfahrten, Ausfahrten und Bahnsteige. Diese haben entweder eine ENR oder einen Namen (Bahnsteige haben nur Namen). Die Verbindungen haben entweder 2 ENRs, ENR und Name oder 2 Namen. Das sind dann die Verbindungen zwischen 2 Knoten. Bahnsteige haben nur Namen, alle anderen haben ENRs.
 +
 +Beispiel:
 +<code>
 +<wege />
 +</code>
 +
 +Antwort:
 +<code>
 +<wege>
 +  <shape type='6' name="Ein1" enr="1" />
 +  <shape type='7' name="Aus1" enr="2" />
 +  <connector enr1="1" enr2="2" />
 +</wege>
 </code> </code>
  
stellwerksim/plugins/spezifikation.1503604899.txt.gz · Zuletzt geändert: 2017/08/24 22:01 von DevonFrosch