BVEC_ATS: Configuration

BVEC_ATS has been designed to be compatible with trains that previously used the Windows only OS_ATS plugin, and will attempt to automatically upgrade any existing OS_ATS1.cfg file. This page describes the supported parameters for BVEC_ATS.
Whilst I’ve deprecated some values, & there are minor functional differences, these should not detract from your driving experience.

The configuration file is divided into sections, each one of which represents a supported device. An additional [KeyAssignments] section may be appended to the end of the file in order to alter the default key assignments.
There are three different types of devices:

  1. Traction models- Only one traction model per train is supported.
  2. Safety systems- Vigilance devices, TPWS & AWS.
  3. Miscellaneous devices- Traction interlocks and the windscreen.

1. Traction Models:

The [Steam] section represents a basic steam locomotive, modelling pressure, cutoff and water levels.
Supported values for this section are as follows:

Attribute NameSupported Values
cutoffmaxDefines the maximum cutoff [Forwards]
This value should be greater than 0
The default value is 75
cutoffminDefines the minimum cutoff [Backwards]
This value should be less than 0
The default value is -55
cutoffineffectiveDefines the range above and below zero where the cutoff is ineffective (No power)
The default value is 15
cutoffratiobaseDefines the maximum speed in kph where maximum cutoff is effective
The default value is 30
cutoffratioDefines the ratio at which the ideal cutoff drops relative to the speed in kph.
The value given should be divided by 10; For example, if our ratio is 5, then the ideal cutoff drops by 1 when our speed increases by 2kph.
The default value is 10
cutoffdeviationDefines the effective range around the ideal cutoff, and must be greater than or equal to 1.
As this value gets smaller, your cutoff needs to get closer to the ideal cutoff to receive maximum performance. Similarly, a higher value will lead to easier driving.
The default value is 8
cutoffchangespeedDefines how quickly the cutoff changes when a key is held down.
The cutoff will increase or decrease one unit at this interval in milliseconds
The default value is 40
cutoffindicatorSets the panel index for the cutoff indicator
The default value is -1
regulatorpressureuseDefines how much pressure is used when the regulator is fully open and the cutoff is at maximum setting in pressure units per second.
The default value is 32
boilermaxwaterlevelDefines the maximum water level in the boiler.
The default value is 1600
boilerwatertosteamrateDefines the rate at which water units are converted to pressure units per minute.
The default value is 1500
boilerstartwaterlevelDefines the starting water level of the boiler.
If this value is -1 or undefined, then the boiler will start at maximum water level.
The default value is -1
boilermaxpressureDefines the nominal maximum pressure of the boiler, and must be greater than the minimum pressure.
The default value is 20000
boilerminpressureDefines the minimum boiler pressure for the train to accelerate, and must be below the maximum pressure.
The default value is 12000
boilerblowoffpressureDefines the point at which the safety valves operate and blowoff excess steam- At this point, the boiler is reduced to maximum pressure.
The default value is 21000
blowoffsoundDefines the sound index which should play once when the boiler blowoff operates.
The default value is -1
blowoffindicatorThe panel index for the blowoff indicator. This shows for 10 seconds whenever the blowoff valve operates.
The default value is -1
boilerpressureindicatorSets the panel index for the boiler pressure indicator.
The default value is -1
injectorrateDefines the number of water units the injector moves from the tanks/ tender to the boiler per second.
The number of pressure units will also be reduced by one fourth of this value.
The default value is 100
injectorindicatorSets the panel index for the injector indicator.
The default value is -1
injectorsoundA comma separated pair of values, defining the sound index which plays looped when the injectors are active, and the sound index played when the injectors are toggled on and off.
The default values are -1 and -1
fuelcapacityDefines the maximum amount of water which the tender/ tanks can hold.
The default value is 20000
fuelstartamountDefines the amount of water in the tender/ tanks at the start of the simulation.
If this is not set, then it will default to fuelstartamount
fuelindicatorSets the panel index for the tender/ tanks water indicator.
The default value is -1
fuelfillspeedDefines the number of units added per second whilst fueling.
The default value is 50
fuelfillidicatorSets the panel index for the fueling indicator.
The default value is -1
automaticDefines whether the cutoff should be operated automatically,
The default value is -1
automaticindicatorSets the panel index for the automatic cutoff indicator.
The defaut value is -1
klaxonpressureuseDefines the number of additional pressure units used per second whilst any klaxon is playing.
The default value is -1
steamheatindicatorDefines the panel index for a 5-step steam heat gauge.
The default value is -1
steamheatpressureuseDefines the number of pressure units used per second by a notch of steam heating (Linear addition)
The default value is -1
blowersindicatorThe panel index for the blowers indicator.
The default value is -1
blowersoundThe sound played looped whenever the blowers are active.
The default value is -1
blowers_pressurefactorThe factor by which steam generation should be multiplied whilst the blowers are active.
The default value is 0
blowers_firefactorThe factor by which the fire temperature increase should be multiplied whilst the blowers are active.
The default value is 0
cylindercockspressureuseA comma separated pair of values, defining the base pressure used whilst the cylinder cocks are open, and the additional pressure used per notch of throttle.
The default values are 0 and 0
cylindercocksoundA comma separated pair of values, defining the sound index which plays looped whilst the cylinder-cocks are open & the power is not in notch 0, and the sound index played when the cylinder-cocks are opened or closed.
The default values are -1 and -1
cylindercocksindicatorThe panel index for the cylinder-cocks indicator.
The default value is -1

The [Diesel] section represents a diesel locomotive fitted with a variable ratio gearbox.
Supported values for this section are as follows:

Attribute NameSupported Values
gearratiosA comma separated list, defining the gears fitted to this train and their ratios.
The traction model has a maximum notional RPM of 1000rpm, and this is calculated by multiplying the speed in kph by the 'gear ratio' in use.
For example, if the ratio for the first gear is 20, then maximum RPM will be reached at 1000 / 20- 50kph
The default value is 0
An example train with 4 gears should look like this: 30,20,16,8
gearfadeinrangeA comma separated list defining the 'fade-in' range for each gear in RPM.
If the engine RPM is below this value, then acceleration will be slower.
The default value is 0
If this list is shorter than the number of gears, then the final value will be used for all subsequent gears.
gearfadeoutrangeA comma separated list defining the 'fade-out' range for each gear in RPM.
If the engine RPM is above this value, then acceleration will be slower.
The default value is 0
If this list is shorter than the number of gears, then the final value will be used for all subsequent gears.
Note: The gear fade-in and fade-out should never be equal to or greater than 1000.
gearindicatorSets the panel index of the gear indicator.
The default value is -1
gearchangesoundDefines the sound index to be played once when the gear is changed.
The default value is -1
gearloopsoundA pair of comma separated values, defining the sound index to be played looped after each non-neutral gear has been selected & the delay in ms before playback starts.
The default values are -1 and 0
tachometerSets the panel index for the engine RPM gauge.
The default value is -1
heatingpartDefines whether part of the engine will heat up over time.
Possible values are as follows:
0 No heating part. (Default)
1 Heating is based upon the selected throttle notch.
2 Heating is based upon engine RPM.
heatingrateA comma separated list defining the rate at which the engine will heat up, based upon the throttle notch or 10% of RPM per second.
The default value is 0 (No heating)
This list should start at neutral throttle, or zero RPM.
If the list is shorter than the number of throttle notches or under 10, then the final value will be used for all subsequent values.
thermometerSets the panel index for the thermometer.
The default value is -1
overheatwarnDefines the temperature threshold at which the overheat warning will trigger.
The default value is 0
overheatDefines the temperature threshold at which the engine will overheat.
The default value is 0
overheatindicatorSets the panel index for the overheat indicator.
The default value is -1
overheatalarmDefines the sound index which plays looped whilst the engine has overheated.
The default value is -1
allowneutralrevsDefines whether the engine can be revved in neutral.
If this is enabled, the revs achieved in each power notch will be 90% of the percentage of the total number of power notches.
For a train with 5 power notches, notch 1 will achieve 190rpm, notch 2 will achieve 380rpm etc. out of the notional 1000rpm
Possible values are as follows:
0 Disabled (Default)
1 Enabled
revsupsoundDefines the sound index to be played once when allowneutralrevs is enabled & the power notch is increased in neutral.
The default value is -1
revsdownsoundDefines the sound index to be played once when allowneutralrevs is enabled & the power notch is decreased in neutral.
The default value is -1
motorsoundDefines the sound index to be played looped whilst the motor is revving in neutral.
The default value is -1
reversercontrolDefines the behavior for when the reverser is placed into neutral whilst the train is moving.
Possible values:
0 No effect (Default)
1 The train must come to a full stand, and the reverser be placed into neutral before power can be applied.
fuelcapacityDefines the maximum amount of fuel which the tanks can hold.
The default value is 20000
fuelstartamountDefines the amount of fuel in the tanks at the start of the simulation.
If this is not set, then it will default to fuelstartamount
fuelindicatorSets the panel index for the fuel indicator.
The default value is -1
fuelfillspeedDefines the number of units per second added whilst fueling.
The default value is 50
fuelfillindicatorSets the panel index for the fueling indicator.
The default value is -1
fuelconsumptionA comma separated list defining the number of fuel units consumed per second for each throttle notch.
The default value is 0 (No fuel consumed)
The list should start at neutral throttle. If this list is shorter than the number of possible throttle notches, then the last value will be used for all undefined throttle notches.
automaticDefines whether the gears should be operated automatically.
The default value is -1
automaticindicatorSets the panel index for the automatic gears indicator.
The default value is -1

The [Electric] section represents a basic electric locomotive.
Supported values for this section are as follows:

Attribute NameSupported Values
powergapbehaviourDefines the behavior for when the pantograph/ pickup shoes are on an isolated section.
Possible values are as follows:
0 No effect
1 Maximum throttle is reduced proportionally to the number of pickup points on the isolated section.
2 Throttle inactive when any pickup points are in the isolated section.
3 Throttle inactive when all pickup points are in the isolated section,
powerpickuppointsA comma separated list, defining the location of all the power pickup points in meters from the front of the train.
The default value is 0
powerindicatorSets the panel index of the power indicator, which lights up when power is present.
The default value is -1
breakerindicatorSets the panel index for the ACB/ VCB breaker.
The default value is -1
breakersoundSets the sound index to be played once when the ACB/ VCB is toggled.
The default value is -1
heatingpartDefines whether part of the engine will heat up over time.
Possible values are as follows:
0 No heating part. (Default)
1 Heating is based upon the selected throttle notch.
heatingrateA comma separated list defining the rate at which the engine will heat up, based upon the throttle notch.
The default value is 0 (No heating)
This list should start at neutral throttle.
If the list is shorter than the number of throttle notches, then the final value will be used for all subsequent values.
thermometerSets the panel index for the thermometer.
The default value is -1
overheatwarnDefines the temperature threshold at which the overheat warning will trigger.
The default value is 0
overheatDefines the temperature threshold at which the engine will overheat.
The default value is 0
overheatindicatorSets the panel index for the overheat indicator.
The default value is -1
overheatalarmDefines the sound index which plays looped whilst the engine has overheated.
The default value is -1
ammeterSets the panel index of the ammeter.
The default value is -1
ammetervaluesA comma separated list, defining the ammeter values for each throttle notch.
If the list is shorter than the number of throttle notches, then the last value will be used for all undefined notches.
The default value is 0
pantographindicator_fSets the panel index for the front pantograph indicator
The default value is -1
pantographindicator_rSets the panel index for the rear pantograph indicator
The default value is -1
pantographsoundSets the sound index to be played once when a pantograph is raised or lowered.
The default value is -1
pantographalarmbehaviourSets the behaviour when a pantograph is lowered at speed with the ACB/VCB closed.
0 Pantograph lowers (Default)
1 Pantograph lowers and the ACB/VCB trips.
2 Pantograph lowers, ACB/VCB trips and the train is braked to a stop.
pantographalarmsoundSets the sound index to be played looped whilst the train is being braked to a stop.
The default value is -1
pantographretryintervalSets the retry interval in ms for raising the pantograph.
This applies after the train has been braked to a stop after lowering a pantograph at speed *OR* after an attempt has been made to raise a pantograph with the ACB/VCB closed.
The default value is 5000
powerloopsoundA pair of comma separated values, defining the sound index to be played looped after the controller has been moved into each non-neutral power notch & the delay in ms before playback starts.
The default values are -1 and 0

2. Safety Systems:

The [AWS] section represents a British AWS (Automatic Warning System) device.
Supported values for this section are as follows:

Attribute NameSupported Values
awsindicatorSets the panel index for the AWS Sunflower.
The default value is -1
awswarningsoundSets the sound index for the AWS warning horn.
The default value is -1
awsclearsoundSets the sound index for the AWS clear signal bell.
The default value is -1
awsdelayDefines the total time within which the driver has to cancel an AWS warning, before a brake application is triggered in milliseconds.
The default value is 2000
tpwswarningsoundSets the sound index for an AWS warning triggered by the TPWS device. (If fitted)
The default value is -1

The [TPWS] section represents a British TPWS (Train Protection & Warning System) device.
Supported values for this section are as follows:
Attribute NameSupported Values
tpwsoverridelifetimeDefines the total time before a driver initiated TPWS override is automatically cancelled in milliseconds.
The default value is 20000
tpwsstopdelayDefines the total time before the brakes are automatically released after the train has been stopped by a TPWS intervention in milliseconds.
The default value is 60000
tpwsindicatorSets the panel index of the TPWS Trainstop indicator.
This should be made up of a pair of comma separated values as follows:
-1 The default panel indicator,
300 The default blink rate in milliseconds for this indicator.
tpwsindicator2Sets the panel index of the TPWS Override indicator.
This should be made up of a pair of comma separated values as follows:
-1 The default panel indicator,
300 The default blink rate in milliseconds for this indicator.
tpwsindicator4Sets the panel index for the TPWS isolation indicator.
The default value is -1

The [Vigilance] section contains generic vigilance devices, such as the deadman’s handle and overspeed device.
Supported values for this section are as follows:
Attribute NameSupported Values
overspeedcontrolDefines whether an overspeed warning/ safety devices is fitted to this train.
Possible values are as follows:
0 No overspeed device fitted. (Default)
1 Overspeed device fitted.
warningspeedWhen the speed of the train in kph exceeds this value, the warning indicator will light, and the overspeed alarm will play.
The default value is -1
overspeedWhen the speed of the train in kph exceeds this value, full service brakes will be applied.
The default value is -1
safespeedIf the overspeed device has been triggered, the brakes will be released upon the speed dropping below this value.
The default value is 0 (The train will be halted completely)
overspeedindicatorSets the panel index for the overspeed indicator.
The default value is -1
overspeedalarmSets the sound index for the overspeed alarm.
The default value is -1
overspeedtimeSets a grace period in seconds before the overspeed device will trigger the brakes.
The default value is 0
deadmanshandleDefines whether a deadman's handle is fitted to this train.
Possible values are:
0 No deadman's handle fitted. (Default)
1 Deadman's handle fitted.
vigilanceintervalA comma separated list, defining the time in milliseconds for each throttle notch at which the deadman's handle will trigger if no keys are pressed.
If this list is shorter than the number of throttle notches, then the last value will be used for all undefined notches.
The default value is 60000
vigilancelampSets the panel index for the deadman's handle warning light.
The default value is -1
vigilancealarmSets the sound index for the deadman's handle warning alarm.
The default value is -1
vigilanceautoreleaseDefines whether a deadman's handle brake application is released upon coming to a full-stop.
Possible values are:
0 No (Default)
1 Yes
vigilancecancellableDefines whether the driver can release a deadman's handle brake application before the train comes to a full-stop.
Possible values are:
0 Brakes cannot be released (Default)
1 Braking may be cancelled.
independantvigilanceDefines whether keys other than the reverser, power & brake may reset the deadman's handle.
Possible values are:
0 All controls reset the timer. (Default)
1 Only the power, reverser & brake will reset the timer.
draenabledDefines whether the train is fitted with a DRA (Driver's reminder appliance)
Possible values are:
0 No DRA fitted. (Default)
1 DRA fitted,
drastartstateDefines the starting state of the DRA.
Possible values are:
0 DRA off.
1 DRA triggered.
draindicatorSets the panel indicator for the DRA.
The default value is -1

3. Miscellaneous Devices:

The [Interlocks] section contains basic interlocks and panel controls.
Supported values for this section are as follows:

Attribute NameSupported Values
doorpowerlockDefines whether the throttle is forced to neutral when stopped with the doors open.
Possible values are as follows:
0 Throttle enabled. (Default)
1 Throttle forced to neutral.
doorapplybrakeDefines whether the brakes are applied when stopped with the doors open.
Possible values are as follows:
0 No brakes applied. (Default)
1 Full service brakes applied.
2 Full emergency brake applied.
neutralrvrbrakeDefines whether brakes are applied when the reverser is set to neutral.
Possible values are as follows:
0 No brakes applied. (Default)
1 Full service brakes applied.
2 Full emergency brake applied.
neutralrvrbrakeresetDefines the conditions under which the brakes may be reset after the reverser is set into neutral.
Possible values are as follows:
0 Brakes are reset upon moving the reverser into drive. (Default)
1 The train must come to a stand before the brakes are automatically reset.
2 The train must come to a stand, and the driver apply full brakes before the interlock is reset.
directionindicatorSets the panel index for a directional indicator.
The default value is -1
reverserindexSets the panel index for the driver's reverser.
The default value is -1
travelmetermodeSets the unit of distance measured by the travelometer.
Possible modes are:
0 Kilometers (Default)
1 Miles
travelmeter100Sets the panel index for the travelometer's 100 digit.
The default value is -1
travelmeter10Sets the panel index for the travelometer's 10 digit.
The default value is -1
travelmeter1Sets the panel index for the travelometer's 1 digit.
The default value is -1
travelmeter01Sets the panel index for the travelometer's 1/10 digit digit.
The default value is -1
travelmeter001Sets the panel index for the travelometer's 1/100 digit.
The default value is -1
klaxonindicatorA comma separated list, which defines the panel index for the klaxon (horn) indicators and their timings, in this order- Primary horn, indicator display time, secondary horn, indicator display time, music horn, indicator display time.
The default values are:
-1 No indicator.
500 500ms indicator display time.

The [Windscreen] section represents rain, the windscreen, and the windscreen wipers.
Supported values for this section are as follows:
Attribute NameSupported Values
dropstartindexDefines the first panel index for the raindrops.
The default value is 0
numberofdropsDefines the number of raindrops.
The default value is 0
wiperindexSets the panel index for the windscreen wipers.
The default value is -1
wiperholdpositionDefines the default position of the windscreen wiper.
Possible values are:
0 Far left. (Default)
100 Far right.
wiperrateSets the approximate sweep time of the wiper from one side to the other in milliseconds.
The default value is 1000
wiperdelaySets the time for which the wiper holds at the side of the windscreen when it is operating in slow mode (In milliseconds).
The default value is 1000
dropsoundTwo comma separated values, representing:
The first sound index for raindrops hitting the windscreen. The default value is -1
The total number of drop sounds available, or blank for 1.
drywipesoundSets the sound index to be played when the wiper moves with less than 20% of the possible raindrops visible *OR* when no wetwipe sound has been set.
The default value is -1
wetwipesoundSets the sound index to be played when the wiper moves with more than 20% of the possible drops on the windscreen.
The default value is -1
wipersoundbehaviourIf this value is set to 0 then the wiper sound will only play when the wiper moves from the hold position. Otherwise it will play when the wiper starts to move in either direction.
The default value is 0
wiperswitchindexSets the panel index for the 3-position wipers rotary switch.
The default value is -1
wiperswitchsoundSets the sound index to be played once when the wipers switch is moved.
The default value is -1

The [Animations] section provides functions for additional animations.

Steam Locomotive Valve Gear:

ATTRIBUTE NAMESUPPORTED VALUES
wheelrotation_variableThe plugin variable which describes the rotation of the wheel
rodradiusSets the radius for the pivot point of the main conrod in millimeters from the wheel center.
gear_Yvariable_RThe plugin variable which describes the movement of the right-hand conrod in the Y-Axis
gear_Zvariable_RThe plugin variable which describes the movement of the right-hand conrod in the Z-Axis
gear_Yvariable_LThe plugin variable which describes the movement of the left-hand conrod in the Y-Axis
gear_Zvariable_LThe plugin variable which describes the movement of the left-hand conrod in the Z-Axis
crankradiusSets the radius of the pivot point of the main crank in millimeters
cranklengthSets the length of the crank in millimeters
crankrotation_RThe plugin variable which describes the rotation of the right-hand side crank
crankvariable_RThe plugin variable which describes the motion of the right-hand side crank
crankrotation_LThe plugin variable which describes the rotation of the left-hand side crank
crankvariable_LThe plugin variable which describes the motion of the left-hand side crank

A left and a right conrod object is required, each constructed with the pivot point at position 0,0,0
They should then be placed in your .animated file as follows:

Similarly, wheel objects should be constructed with the center of the axle at 0,0,0
They should then be placed in your .animated file as follows:

Finally, a left and a right crank object should also be constructed with pivot points at 0,0,0
They should then be placed in your .animated file as follows:

Other Animations:

ATTRIBUTE NAMESUPPORTED VALUES
headcodeindicatorA comma separated value pair, defining the panel index for a rotary heacode indicator and the total possible number of values.
The default values are:
-1 No headcode indicator.
0 Single headcode state.
flashingdoorlightDefines the panel index for a light which flashes for 30s before the train doors close.
The default value is -1

The flashing doors light requires two beacons to work correctly, and these are described on the beacons page:
http://www.bvecornwall.co.uk/wordpress/bvec_ats-beacon-types/

4. Key Assignments:

Please note that each key assignment represents an OpenBVE internal key, **not** a physical key on your keyboard.
Case and format are important; All strings must be entirely in capitals and match exactly. f will not work, whilst F will.

Attribute NameDescriptionDefault Assignment
safetykeySets the key used to reset/ acknowledge the safety systems (AWS, TPWS & vigilance devices)A1
automatickeySets the key used to toggle automatic gearchange/ cutoffA2
gearupkeySets the key used to move up a gear in a diesel locomotiveB1
geardownkeySets the key used to move down a gear in a diesel locomotiveB2
cutoffupkeySets the key used to increase cutoff in a steam locomotiveC2
cutoffdownkeySets the key used to decrease cutoff in a steam locomotiveC1
injectorkeySets the key used to toggle a steam locomotive's injectorsB2
fuelkeySets the key to be pressed and held to fill fuel/ water in a steam or diesel locomotive.
Also toggles the ACB/VCB in an electric locomotive
I
wiperspeedupSets the key used to increase the windscreen wipers speed.J
wiperspeeddownSets the key used to decrease the windscreenwipers speedK
isolatesafetykeySets the key used to isolate the AWS & TPWS systemsL
customindicatorkey1 ==>
customindicatorkey10
Sets the keys used to toggle the custom indicators1 to 5 are assigned to D to H
6 to 10 are not assigned by default.
frontpantographkeySets the key used to raise or lower the front pantographNot assigned by default
If neither pantograph key is defined, both will remain permanently up.
If only one key is defined, the other will be disabled.
rearpantographkeySets the key used to raise or lower the rear pantographNot assigned by default
blowerskeySets the key used to toggle the blowers on steam locomotivesNot assigned by default