OpenBveAts
< Back to Index Page
Banner
OpenBveAts is the default train plugin used by OpenBVE when trains lack their own plugin. It simulates a basic version of ATS-SN, ATS-P and ATC. If you want to use this plugin in your train, then simply don't include the ats.cfg file. This plugin will then be used automatically.
If you are interested in a more comprehensive plugin for simulating Japanese safety equipment, then please use OdakyufanAts instead. OdakyufanAts is fully compatible with the default safety systems but offers a lot more functionality, including ATS-Ps, more detailed ATS-P, more detailed ATC, and TASC. In fact, OpenBveAts is just a stripped-down version of OdakyufanAts to meet backward compatibility requirements.
If you are still interested in OpenBveAts, then please find all information relevant for users and developers in the OpenBVE documentation. This page summarizes the technical details of the plugin only.
  1. Panel
  2. Sounds
  3. Beacons
  4. Special Beacons
  5. Keyboard Assignment

Panel

The following panel indices are exposed.
Index Description Range
ATS-SN
256 ATS power (ATS電源) 0 - 1
257 ATS actuation (ATS動作) 0 - 2
258 ATS actuation (ATS動作) 0 - 1
ATS-P
259 P power (P電源) 0 - 1
260 pattern approach (パターン接近) 0 - 1
261 brake release (ブレーキ開放) 0 - 1
262 brake application (ブレーキ動作) 0 - 1
263 ATS-P 0 - 1
264 failure (故障) 0 - 1
ATC
265 ATC 0 - 1
266 ATC power (ATC電源) 0 - 1
267 ATC service (ATC常用) 0 - 1
268 ATC emergency (ATC非常) 0 - 1
miscellaneous
269 const speed (定速) 0 - 1
270 EB 0 - 1
ATC
271 ATC speed indicator 0 - 12
ATC speed indicator (panel index 271)
Value Description
0 ATC not available
1 0 km/h
2 15 km/h
3 25 km/h
4 45 km/h
5 55 km/h
6 65 km/h
7 75 km/h
8 90 km/h
9 100 km/h
10 110 km/h
11 120 km/h
12 ATS is active

Sounds

The following sound indices are exposed.
Index File Description Type
0 ats.wav ATS bell looping
1 atscnt.wav ATS chime looping
2 ding.wav ATS-P/ATC bell once
3 toats.wav ATC to ATS once
4 toatc.wav ATS to ATC once
5 eb.wav EB bell looping

Beacons

The following beacon types are supported.

Beacon type 0 (S long)

Track.Beacon 0; object; signal; 0
Sets up the S long beacon. If the signal is red, the alarm starts to sound. If the optional data is 0, the train switches from ATS-P to ATS-SN. If the optional data is -1, the train stays in its current mode.

Beacon type 1 (SN immediate stop)

Track.Beacon 1; object; signal; 0
Sets up the SN immediate stop beacon. If the signal is red, the emergency brakes are applied immediately. If the optional data is 0, the train switches from ATS-P to ATS-SN. If the optional data is -1, the train stays in its current mode.

Beacon type 2 (accidental departure)

Track.Beacon 2; object; signal; 0
Sets up the accidental depature beacon. If the signal is red, the emergency brakes are applied immediately. If the optional data is 0, the train switches from ATS-P to ATS-SN. If the optional data is -1, the train stays in its current mode. If the optional data is greater than zero, the beacon only triggers for trains with at most the specified number of cars, and the train switches from ATS-P to ATS-SN.

Beacon type 3 (ATS-P pattern renewal)

Track.Beacon 3; object; signal; 0
Place this beacon to refresh the ATS-P signal pattern. If the optional data is 0, the train switches from ATS-SN to ATS-P. If the optional data is -1, the train stays in its current mode.

Beacon type 4 (ATS-P immediate stop)

Track.Beacon 4; object; signal; 0
Place this beacon to refresh the ATS-P pattern. If the signal is red and less than 50 meters away, the brakes are applied immediately and the brake application needs to be canceled manually. If the optional data is 0, the train switches from ATS-SN to ATS-P. If the optional data is -1, the train stays in its current mode.

Special Beacons

The following beacon types cannot be used directly in routes - they are automatically created by the CSV/RW parser to provide backward compatibility with ATS-P and ATC.

Beacon type 0xFF000001 (ATC track status)

Marks the status of ATC. The optional data has the following meaning:
0 ATC not available
1 ATC available, switch from ATS to ATC
2 ATC available
3 ATC available, switch from ATC to ATS

Beacon type 0xFF000002 (ATC speed limit)

Sets up an ATC speed limit. The optional data has the following meaning:
bits 0-11 Speed in km/h
bits 12-31 Distance in m
All speed limits in the entire route are communicated to the plugin at the beginning of the route, so the plugin keeps a database of known speed limits and then applies them as necessary.

Beacon type 0xFF000003 (ATS-P temporary speed limit)

Sets up an ATS-P temporary speed limit. The optional data has the following meaning:
bits 0-11 Speed in km/h
bits 12-31 Distance in m
All speed limits in the entire route are communicated to the plugin at the beginning of the route, so the plugin keeps a database of known speed limits and then applies them as necessary.

Beacon type 0xFF000004 (ATS-P permanent speed limit)

Sets up an ATS-P permanent speed limit. The optional data is the speed limit in km/h.

Keyboard Assignment

The following keys are recognized.
Name Default assignment Description
S space Cancels the ATS-SN bell.
A1 insert Cancels the ATS-SN chime.
A2 delete Cancels the EB.
B1 home Cancels the ATS-SN or ATS-P brake application.
B2 delete Activates the temporary ATS-P brake release.
C1 page up Switches from ATC to ATS.
C2 page down Switches from ATS to ATC.
D 2 Enables the safety systems.
E 3 Disables the safety systems.