Skip to content

Commit b54024b

Browse files
committed
Added documentation
1 parent b3679ba commit b54024b

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

Source/Documentation/Manual/cabs.rst

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1364,6 +1364,43 @@ Customizations for such file are possible following these rules:
13641364
Except for the first column, fields
13651365
in the 3D distributed power display are always with center alignment.
13661366

1367+
ETCS circular speed gauge and the Driver Machine Interface
1368+
----------------------------------------------------------
1369+
1370+
It is possible to show the ETCS display using the following block::
1371+
1372+
ScreenDisplay (
1373+
Type ( ORTS_ETCS SCREEN_DISPLAY )
1374+
Graphic ( statictexture.ace )
1375+
Units ( KM_PER_HOUR )
1376+
Parameters (
1377+
Mode FullSize
1378+
MaxSpeed 180
1379+
DisplayUnits 0
1380+
)
1381+
)
1382+
1383+
The following DMI size variants are available: ``FullSize`` displays the whole DMI,
1384+
``SpeedArea`` displays only the left part with information about distance and speed
1385+
and ``PlanningArea`` displays only the right side planning area and navigation buttons.
1386+
The default value is FullSize
1387+
1388+
The following commonly used ``MaxSpeed`` values can be set
1389+
* 140, 150, 180, 240, 250, 260, 280, 400 for ``KM_PER_HOUR`` unit
1390+
* 87, 111, 155, 248 for ``MILES_PER_HOUR`` unit
1391+
The default value is 400 with KM_PER_HOUR unit.
1392+
1393+
Use the ``MaxVisibleSpeed`` to set the highest speed displayed as a number,
1394+
if literal numbering is undesirable above this number on the circular speed gauge.
1395+
The default value is the MaxSpeed rounded to the highest tens below.
1396+
1397+
Use the ``DisplayUnits`` parameter to suppress diplaying the speed unit at the
1398+
bottom of the circular speed gauge. The default is 1.
1399+
1400+
Use the ``Graphic`` parameter to designate the static texture inside the .s file
1401+
that will be replaced at runtime with the dynamic picture of the display. This
1402+
parameter is mandatory, if omitted, no display will be shown.
1403+
13671404
Alignment for digital controls
13681405
------------------------------
13691406

0 commit comments

Comments
 (0)