Skip to content

Commit 843eb30

Browse files
committed
Update manual
1 parent f6b5599 commit 843eb30

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed

Source/Documentation/Manual/driving.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1026,6 +1026,17 @@ You can have train cars oscillating (swaying) by hitting ``<Ctrl+V>``; if
10261026
you want more oscillation, click ``<Ctrl+V>`` again. Four levels,
10271027
including the no-oscillation level, are available by repeating ``<Ctrl+V>``.
10281028

1029+
Manual emergency braking release
1030+
--------------------------------
1031+
1032+
In some cases where the emergency braking is triggered by the simulator, it is possible to release
1033+
the emergency braking by pressing ``<Shift+Backspace>``.
1034+
1035+
The cases where the reset is allowed are:
1036+
1037+
- Signal passed at danger
1038+
- Trailed misaligned switch
1039+
10291040
.. _driving-turntable:
10301041

10311042
Engaging a turntable or a transfertable

Source/Documentation/Manual/features-rollingstock.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1054,6 +1054,38 @@ to be displayed in the ETCS DMI. For example, the following block orders the DMI
10541054
single: Style
10551055
single: SwitchVal
10561056

1057+
Emergency braking triggered by the simulator
1058+
''''''''''''''''''''''''''''''''''''''''''''
1059+
1060+
The emergency brakings triggered by the simulator are always sent to the TCS script.
1061+
1062+
Two functions are used to transmit this information:
1063+
1064+
.. code-block:: csharp
1065+
1066+
public override void HandleEvent(TCSEvent evt, string message)
1067+
1068+
The events sent are ``EmergencyBrakingRequestedBySimulator``, ``EmergencyBrakingReleasedBySimulator`` and ``ManualResetOutOfControlMode``.
1069+
For the first event, the reason of the emergency braking is also sent:
1070+
1071+
- ``SPAD``: The train has passed a signal at danger at the front of the train
1072+
- ``SPAD_REAR``: The train has passed a signal at danger at the rear of the train
1073+
- ``MISALIGNED_SWITCH``: The train has trailed a misaligned switch
1074+
- ``OUT_OF_AUTHORITY``: The train has passed the limit of authority
1075+
- ``OUT_OF_PATH``: The train has ran off its allocated path
1076+
- ``SLIPPED_INTO_PATH``: The train has slipped back into the path of another train
1077+
- ``SLIPPED_TO_ENDOFTRACK``: The train has slipped off the end of the track
1078+
- ``OUT_OF_TRACK``: The train has moved off the track
1079+
- ``OTHER_TRAIN_IN_PATH``: Another train has entered the train's path
1080+
- ``SLIPPED_INTO_TURNTABLE``: The train has entered a misaligned turntable
1081+
- ``TRAIN_ON_MOVING_TURNTABLE``: The train has started moving on a moving turntable
1082+
1083+
.. code-block:: csharp
1084+
1085+
public override void SetEmergency(bool emergency)
1086+
1087+
This function is deprecated and will be deleted in a future version. The parameter indicates if the emergency braking is requested (true) or released (false).
1088+
10571089
Generic cabview controls
10581090
''''''''''''''''''''''''
10591091
Often Train Control Systems have a quite sophisticated DMI (driver-machine

0 commit comments

Comments
 (0)