BVE Trainsim > Create scenario > File formats > Vehicle

Instrument panel file

format:encoding
[section1]
key1 = value1
key2 = value2
...
[section2]
key3 = value3
...

File header

File format

The file format must be described always at the beginning of the file. The string indicating the current instrument panel file format is

BveTs Instrument Panel 2.01

Character encoding

The character encoding of the file may be described after the file format. If the character encoding is omitted, UTF-8 is used.

For example, the file header of ISO 8859-1 is shown below:

BveTs Instrument Panel 2.01:ISO_8859-1

Comments

Text from a sharp ( # ) or a semicolon ( ; ) until the end of the line is a comment, and is ignored.

Sections and keys

Setting items are grouped into sections, similar to the INI file.

Sections

Cab panel is formed by a combination of the following gauge elements. The instrument elements correspond to sections.

Section name Description
This The display area and the base image
PilotLamp A indicator light
Needle A needle
DigitalGauge A circular digital gauge
DigitalNumber A seven-segment display

This section

Sets the display area and the base image. This section can be defined only once.

Resolution = value
Horizontal resolution at 1x zoom

Left = value
The coordinate of left of displayable area.

Top = value
The coordinate of top of displayable area.

Right = value
The coordinate of right of displayable area.

Bottom = value
The coordinate of bottom of displayable area.

DaytimeImage =path
Image file path for daytime.

NighttimeImage =path
Image file path for nighttime.

TransparentColor =color
The transparent color of this image.

Center = x, y
The coordinates of the screen center in the default view.

Origin = x, y
The vanishing point coordinates.

PilotLamp section

Adds a indicator light. This section can be defined more than once.

Subject = subjectKey
Physical quantity to display.

Location = x, y
The coordinate of upper left of this image in the base image

DaytimeImage =path
Image file path for daytime.

NighttimeImage =path
Image file path for nighttime.

TransparentColor =color
The transparent color of this image..

Layer = renderingOrder
The rendering order of this image.

Needle section

Adds a needle. This section can be defined more than once.

Subject = subjectKey
Physical quantity to display.

Location = x, y
The coordinates of the center of rotation in the base image.

DaytimeImage =path
Image file path for daytime.

NighttimeImage =path
Image file path for nighttime.

Color =color
The surface color.

TransparentColor =color
The transparent color of this image.

Origin = x, y
The coordinates of the center of rotation in the needle image.

Layer = renderingOrder
The rendering order of this image.

Radius = value
The radius of the needle.

InitialAngle =angle
The minimum angle of the needle [deg].

LastAngle = angle
The maximum angle of the needle [deg].

Minimum = value
The minimum physical quantity.

Maximum = value
The maximum physical quantity.

Tilt = angleX, angleY NEW
The angle of the rotation plane of the needle with respect to the vertical plane.
angleX: The pitch angle (positive is upward) [deg]
angleY: The yaw angle (positive is left) [deg]

StopPin = flag NEW
True if the movable range of the needle is limited between Minimum and Maximum; otherwise, False. The default is False.

NaturalFreq = value
The natural angular frequency of the needle [rad/s].

DampingRatio = value
The damping ratio of needle.

DigitalGauge section

Adds a circular digital gauge. This section can be defined more than once.

Subject = subjectKey
Physical quantity to display.

Location = x, y
The coordinates of the center of rotation in the base image.

Color =color
The color when light is off.

Layer = renderingOrder
The rendering order of this image.

Radius = value
The radius of the gauge.

InitialAngle = angle
The minimum angle [deg].

LastAngle = angle
The maximum angle [deg].

Minimum = value
The minimum physical quantity.

Maximum = value
The maximum physical quantity.

Tilt = angleX, angleY NEW
The angle of the display surface with respect to the vertical plane.
angleX: The pitch angle (positive is upward) [deg]
angleY: The yaw angle (positive is left) [deg]

Step = value
The resolution in physical quantity.

DigitalNumber section

Adds a seven-segment display. This section can be defined more than once.

Subject = subjectKey
Physical quantity to display.

Location = x, y
The coordinate of upper left of this image in the base image

DaytimeImage =path
Image file path for daytime.

NighttimeImage = path
Image file path for nighttime.

TransparentColor = color
The transparent color of this image.

Layer = renderingOrder
The rendering order of this image.

Interval = value
The hight of this seven-segment display.

Values

subjectKey

Name Type Description
true bool Always true
kmph float Traveling speed [km/h]
kmphd0 int Ones digit of traveling speed [km/h]
kmphd1 int Tens digit of traveling speed [km/h]
kmphd2 int Hundreds digit of traveling speed [km/h]
bc float Brake actuator pressure [kPa]
bcd1 int Tens digit of brake actuator pressure [kPa]
bcd2 int Hundreds digit of brake actuator pressure [kPa]
mr float Main air reservoir pressure [kPa]
mrd1 int Tens digit of main air reservoir pressure [kPa]
mrd2 int Hundreds digit of main air reservoir pressure [kPa]
sap float Straight air pipe pressure [kPa]
bp float Brake pipe pressure [kPa]
er float 釣り合い空気溜め圧力 [kPa]
am float Current (positive is power, negative is brake) [A]
amabs float Absolute value of current [A]
door bool Doors status (True if all doors are closed; otherwise, False)
doorl0, doorl1, ... bool Left door status for each car (True if the doors is open; otherwise, False)
doorr0, doorr1, ... bool Right door status for each car (True if the doors is open; otherwise, False)
csc bool Constant speed control status (True if controlling; otherwise, False)
ats0, ats1, ..., ats255 int Value received from the train protection system plugin
power int Power handle position
brake int Brake notch
hour float Time [hour]
min float Time [min]
sec int Time [sec]

renderingOrder

The rendering order. The larger the number, the closer to the front. The base image is 0.

angle

The angle [deg]. The origin is at 12 o'clock on the clock. Positive is clockwise. For needle that rotate more than one turn, set the LastAngle to the InitialAngle + 360.

path

The relative path from this file.

color

The color code represented by a 6-digit hexadecimal number (e.g. FF0000).

© 2020 mackoy