Skip to content

Commit 386b83c

Browse files
committed
Update docs for battery voltage
1 parent d5ae4a7 commit 386b83c

File tree

3 files changed

+27
-13
lines changed

3 files changed

+27
-13
lines changed

Source/Documentation/Manual/cabs.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,23 +61,25 @@ The following DMI size variants are available: FullSize (displays the whole DMI)
6161
The information displayed in the DMI is controlled via the TCS script. For more details,
6262
see :ref:`C# engine scripting - Train Control System <features-scripting-tcs>`.
6363

64-
.. _cabs-battery-switch:
64+
.. _cabs-battery:
6565

66-
Battery switch
67-
--------------
66+
Battery
67+
-------
6868

6969
.. index::
7070
single: ORTS_BATTERY_SWITCH_COMMAND_SWITCH
7171
single: ORTS_BATTERY_SWITCH_COMMAND_BUTTON_CLOSE
7272
single: ORTS_BATTERY_SWITCH_ON
73+
single: ORTS_BATTERY_VOLTAGE
7374

74-
The :ref:`battery switch <physics-battery-switch>` controls the low voltage power supply of the locomotive.
75+
The :ref:`battery subsystem <physics-battery>` controls the low voltage power supply of the locomotive.
7576

7677
The following controls are available for the cabview:
7778

78-
- ``ORTS_BATTERY_SWITCH_COMMAND_SWITCH`` can be used if the switch is directly controlled from the cab
79+
- ``ORTS_BATTERY_SWITCH_COMMAND_SWITCH`` can be used if the battery switch is directly controlled from the cab
7980
- ``ORTS_BATTERY_SWITCH_COMMAND_BUTTON_CLOSE`` and ``ORTS_BATTERY_SWITCH_COMMAND_BUTTON_OPEN`` can be used if the switch is controlled with two pushbuttons (one to close the switch and the other to open it)
8081
- ``ORTS_BATTERY_SWITCH_ON`` can be used to control a light on the cab showing the state of the battery switch
82+
- ``ORTS_BATTERY_VOLTAGE`` monitors the battery voltage
8183

8284
Other controls can be disabled if the low voltage power supply is not available using the following parameter::
8385

Source/Documentation/Manual/features-rollingstock.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -149,11 +149,11 @@ block!
149149
.. index::
150150
single: Conditions(ORTSBattery
151151

152-
Battery Switch
153-
''''''''''''''
152+
Battery
153+
'''''''
154154

155155
The light condition ``ORTSBattery`` allows a light to respond to the state of
156-
the :ref:`battery switch subsystem <physics-battery-switch>`. The valid settings
156+
the :ref:`battery subsystem <physics-battery>`. The valid settings
157157
and associated conditions for the light to turn *on* are as follows:
158158

159159
- ``ORTSBattery ( 0 )`` Battery state is ignored (default)

Source/Documentation/Manual/physics.rst

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4985,16 +4985,16 @@ outside the usual MSTS folders; e.g. brake parameters.
49854985
Common locomotive subsystems
49864986
============================
49874987

4988-
.. _physics-battery-switch:
4988+
.. _physics-battery:
49894989

4990-
Battery switch
4991-
--------------
4990+
Battery
4991+
-------
49924992

4993-
The battery switch controls the low voltage power supply of the locomotive.
4993+
The battery provides a low voltage power supply of the train car. It is activated via the battery switch.
49944994
If the low voltage power supply is disabled, all of the systems of the locomotive are disabled
49954995
(for example, the circuit breaker opens and the pantograph falls down).
49964996

4997-
The battery switch of all locomotives in a consist can be controlled by
4997+
The battery switch of all vehicles in a consist can be controlled by
49984998
*Control Battery Switch Close* and *Control Battery Switch Open* commands
49994999
( ``<Insert>`` and ``<Ctrl+Insert>`` by default ). The status of the battery switch
50005000
is indicated by the *Battery switch* value in the HUD view.
@@ -5020,13 +5020,25 @@ you have to keep pressing the button until the battery is (dis)connected.
50205020
It is possible for the battery switch to be switched on at the start of the simulation.
50215021
To activate this behaviour, you can add the optional parameter ``ORTSBattery( DefaultOn ( 1 ) )``
50225022

5023+
The voltage and energetic capacity of the battery can be indicated using the ``Voltage`` and ``MaxCapacity``
5024+
parameters. Optionally, it is possible to define a realistic capacity-voltage curve such that voltage becomes
5025+
lower when the battery is discharged, using ``ChargeVoltageCurve``.
5026+
50235027
Example::
50245028

50255029
Engine (
50265030
ORTSBattery (
50275031
Mode ( PushButtons )
50285032
Delay ( 2s )
50295033
DefaultOn ( 1 )
5034+
Voltage ( 72V )
5035+
MaxCapacity ( 50kWh )
5036+
ChargeVoltageCurve (
5037+
0 0
5038+
5kWh 50V
5039+
30kWh 72V
5040+
50kWh 80V
5041+
)
50305042
)
50315043
)
50325044

0 commit comments

Comments
 (0)