Overview on Panel, Sound and Beacons
< Back to OdakyufanAts
Here you can find the documentation on how to design your routes and trains for use with OdakyufanAts.
  1. Panel
  2. Sounds
  3. Analog Beacons
  4. Digital Beacons
  5. Virtual Beacons
  6. Legacy Beacons

Panel

The following panel indices are exposed by OdakyufanAts.
Index Description Range
ATS-Sx
0 ATS power (ATS電源) 0 - 1
1 ATS actuation (ATS動作) 0 - 1
ATS-P
2 P power (P電源) 0 - 1
3 pattern approach (パターン接近) 0 - 1
4 brake release (ブレーキ開放) 0 - 1
5 brake application (ブレーキ動作) 0 - 1
6 ATS-P 0 - 1
7 failure (故障) 0 - 1
EB
8 EB 0 - 1
clock
10 hour 0 - 23
11 minute 0 - 59
12 second 0 - 59
ATC
15 ATC 0 - 1
16 ATC service (ATC常用) 0 - 1
17 ATC emergency (ATC非常) 0 - 1
18 ATC power (ATC電源) 0 - 1
19 emergency operation (非常運転) 0 - 1
20 ATC disabled (ATC開放) 0 - 1
21 ATC operating in ATS (ATC-ATS切替) 0 - 1
22 ATC 101/X 0 - 1
23 ATC 102/0 0 - 1
24 ATC 103/15 0 - 1
25 ATC 104/25 0 - 1
26 ATC 105/45 0 - 1
27 ATC 106/55 0 - 1
28 ATC 107/65 0 - 1
29 ATC 108/75 0 - 1
30 ATC 109/90 0 - 1
31 ATC 110/100 0 - 1
32 ATC 111/110 0 - 1
33 ATC 112/120 0 - 1
34 ATC speed (meters/hour) 0 - max
ATS-Ps
35 Ps pattern establishment (Psパターン発生) 0 - 1
36 Ps pattern approach (Psパターン接近) 0 - 1
37 Ps brake application (Psブレーキ動作) 0 - 1
38 Ps brake release (Psブレーキ開放) 0 - 1
39 Ps failure (Ps故障) 0 - 1
40 Ps speed bar 0 - 60
41 Ps pattern bar 0 - 60
42 Ps power (主系) 0 - 1
switches
50 ATS-P disabled (ATS-P開放) 0 - 1
52 ATC emergency operation (ATC非常運転) 0 - 1
53 ATC disabled (ATC開放) 0 - 1
54 ATS-Ps disabled (ATS-Ps開放) 0 - 1
55 ATS-Sx disabled (ATS-Sx開放) 0 - 1
56 TASC disabled (TASC開放) 0 - 1
debug
60 Ps signal A Ps1 establishment 0 - 1
61 Ps signal A Ps2 establishment 0 - 1
62 Ps signal B Ps1 establishment 0 - 1
63 Ps signal B Ps2 establishment 0 - 1
64 Ps signal 15 km/h establishment 0 - 1
65 Ps divergence (分岐) establishment 0 - 1
66 Ps curve (曲線) establishment 0 - 1
67 Ps slope (勾配) pattern establishment 0 - 1
68 Ps temporary (臨時) establishment 0 - 1
69 Ps irekae (入換) establishment 0 - 1
70 Ps yuudou (誘導) establishment 0 - 1
71 Ps signal A downslope compensation establishment 0 - 1
72 Ps signal B downslope compensation establishment 0 - 1
74 deceleration in km/h/s, integer part 0 - 9
75 deceleration in km/h/s, fractional part 0 - 9
TASC
80 TASC power (TASC電源) 0 - 1
81 TASC pattern (TASCパターン) 0 - 1
82 TASC braking (TASCブレーキ) 0 - 1
83 TASC override (TASC切) 0 - 1
85 home position (定位置) 0 - 1
86 train doors closed (車両ドア全閉) 0 - 1
87 home doors closed (ホームドア全閉) 0 - 1
90 TASC brake notch 0 - max
buttons
93 ATS acknowledge (S) 0 - 1
94 ATS cancel chime (A1) 0 - 1
95 EB acknowledge (A2) 0 - 1
96 ATS reset (B1) 0 - 1
97 ATS-P brake release (B2) 0 - 1
98 To ATC (C1) 0 - 1
99 To ATS (C2) 0 - 1
miscellaneous
100 power application (力行) 0 - 1
101 brake application (ブレーキ) 0 - 1
ATC (continuation)
110 ATC red 0 - 1
111 ATC green 0 - 1
112 ATC P 0 - 1
113 ATC advance notice (前方予告) 0 - 1
114 ATC ORP speed (meters/hour) 0 - max
120 ATC 0 km/h 0 - 1
121 ATC 5 km/h 0 - 1
122 ATC 10 km/h 0 - 1
123 ATC 15 km/h 0 - 1
124 ATC 20 km/h 0 - 1
125 ATC 25 km/h 0 - 1
126 ATC 30 km/h 0 - 1
127 ATC 35 km/h 0 - 1
128 ATC 40 km/h 0 - 1
129 ATC 45 km/h 0 - 1
130 ATC 50 km/h 0 - 1
131 ATC 55 km/h 0 - 1
132 ATC 60 km/h 0 - 1
133 ATC 65 km/h 0 - 1
134 ATC 70 km/h 0 - 1
135 ATC 75 km/h 0 - 1
136 ATC 80 km/h 0 - 1
137 ATC 85 km/h 0 - 1
138 ATC 90 km/h 0 - 1
139 ATC 95 km/h 0 - 1
140 ATC 100 km/h 0 - 1
141 ATC 105 km/h 0 - 1
142 ATC 110 km/h 0 - 1
143 ATC 115 km/h 0 - 1
144 ATC 120 km/h 0 - 1
[...] [...] [...]
179 ATC 295 km/h 0 - 1
miscellaneous
255 always true 1
In addition, all panel indices exposed by OpenBveAts are also exposed by OdakyufanAts.

Sounds

The following sound indices are exposed by OdakyufanAts.
Index Description Type
safety devices
0 ATS bell looping
1 ATS chime looping
2 ATS-P bell once
3 ATS-Ps pattern establishment once
4 ATS-Ps pattern release once
5 ATS-Ps chime once
7 ATC bell once
8 ATC to ATS once
9 ATS to ATC once
10 ATC to ATS reminder looping
11 ATS to ATC reminder looping
13 EB looping
calling out home signal (場内) aspects
100R (停止) once
101YY (警戒) once
102Y (注意) once
103YG (減速) once
104YGF (抑速) once
105G (進行) once
106GG (高速進行) once
calling out block signal (閉塞) aspects
107R (停止) once
108YY (警戒) once
109Y (注意) once
110YG (減速) once
111YGF (抑速) once
112G (進行) once
113GG (高速進行) once
calling out departure signal (出発) aspects
114R (停止) once
115YY (警戒) once
116Y (注意) once
117YG (減速) once
118YGF (抑速) once
119G (進行) once
120GG (高速進行) once
calling out repeating signal (中継) aspects
121R (停止) once
122YY (警戒) once
123Y (注意) once
124YG (減速) once
125YGF (抑速) once
126G (進行) once
127GG (高速進行) once
128 restricted (制限) once
calling out distant signal (遠方) aspects
129YY (警戒) once
130Y (注意) once
131YG (減速) once
132YGF (抑速) once
133G (進行) once
134GG (高速進行) once
calling out passing signal (通過) aspects
135Y (注意) once
136G (進行) once
calling out shunting signal (入換) aspects
137R (停止) once
138Y (注意) once
139G (進行) once
calling out speed restrictions
200 released once
201 5 km/h once
202 10 km/h once
203 15 km/h once
.........
230 150 km/h once
231 155 km/h once
232 160 km/h once
calling out advance speed restrictions
300 released once
301 5 km/h once
302 10 km/h once
303 15 km/h once
.........
330 150 km/h once
331 155 km/h once
332 160 km/h once
OdakyufanAts is based on the following assignments to signal aspects.
Index Aspect
0R (停止)
1YY (警戒)
2Y (注意)
3YG (減速)
4YGF (抑速)
5G (進行)
6GG (高速進行)

Analog Beacons

OdakyufanAts supports a very generic model of working with analog beacons. Instead of using arbitrary beacon indices, frequencies are used. Instead of using different beacon types for beacons that are attached to signals or are always active, this information is encoded in the optional data. This gives a great deal of flexibility.
There are two types of analog beacons: those engaged to a particular signal aspect, and those that are always active.

Engaged To a Signal Aspect

Frequency-based beacon that are engaged to a particular signal aspect have the following syntax:
Track.Beacon 123; object; signal; 0103
123 is the active frequency in KHz, transmitted when the signal aspect matches.
103 is the idle frequency in KHz, transmitted when the signal aspect does not match.
0 is the signal aspect to which the beacon is engaged. Signal aspects of 10 or greater are considered equivalent to signal aspect 0 (red).
The active frequency must be at least 73 KHz. Otherwise, the beacon is not recognized by OdakyufanAts as a frequency-based beacon. The idle frequency can take any value.
If you want to create a beacon that is engaged to multiple signal aspects, create multiple beacons, one for each possible signal aspect, and set all idle frequencies to zero. For example:
Track.Beacon 132; object; signal; 0000
Track.Beacon 124; -1;     signal; 1000
Track.Beacon 116; -1;     signal; 2000
Track.Beacon 108; -1;     signal; 3000
Track.Beacon 100; -1;     signal; 5000

Always Active

Frequency-based beacons that are always active have the following syntax:
Track.Beacon 123; object; 0; -1
123 is the active frequency in KHz.
-1 tells the beacon to be always active.
This syntax is a shortcut. You could also set the active and idle frequency to the same value.

Continuous Transmission

In order to set up a section of continuous transmission, see beacon type 44.

Available Frequencies

These are the frequencies that are recognized. All frequencies are given in KHz and rounded down to the nearest integer.
Frequency Description
73 Nop frequency used by ATS-Ps
80 Has various functions in ATS-Ps
85 Has various functions in ATS-Ps
90 Has various functions in ATS-Ps
95 Has various functions in ATS-Ps
103 Nop frequency used by ATS-Sx
108 Sx speed check (actually 108.5 KHz)
123 SN immediate stop
129 S long (actually 129.3 KHz)
130 S long (same as 129.3 KHz)
Please read about the safety systems to understand how they work.

Digital Beacons

The following are digital beacons that transmit a particular data package.

Beacon type 3 (ATS-P pattern renewal)

Track.Beacon 3; object; signal; 00
This refreshes the ATS-P signal pattern. The right digit is used to select one of ten signal patterns (default is 0). You can employ patterns against multiple signals independently using different indices. The left digit is 0 to set the pattern, or 1 to clear the pattern. Clearing the pattern is only necessary if you use multiple patterns. If the number is -1, this does not switch to ATS-P.

Beacon type 4 (ATS-P immediate stop, emergency type)

Track.Beacon 4; object; signal; 0
This refreshes the ATS-P signal pattern. If the attached signal is less than 50 meters away and red, the emergency brakes are applied immediately. If the number is -1, this does not switch to ATS-P.

Beacon type 5 (ATS-P immediate stop, service type)

Track.Beacon 5; object; signal; 0
This refreshes the ATS-P signal pattern. If the attached signal is less than 50 meters away and red, the service brakes are applied immediately. If the number is -1, this does not switch to ATS-P.

Beacon type 6 (ATS-P divergence speed limit)

Track.Beacon 6; object; 0; 600075
This sets up an upcoming speed limit due to diverging track. The left number is the distance to the speed limit in meters, and the right number is the speed limit in km/h. The distance must not be zero. The divergence speed limit is automatically released 50 meters after the divergence. You can also use beacon type 16 to release the limit explicitly.

Beacon type 7 (ATS-P permanent speed limit)

Track.Beacon 7; object; 0; 075
This sets up a permanent speed limit in km/h. If you want to release the permanent speed limit, set the speed to a large number. A value of zero creates an immediate stop with the emergency brakes, useful for the end of the track.

Beacon type 8 (ATS-P slope speed limit)

Track.Beacon 8; object; 0; 600075
This sets up an upcoming speed limit due to a slope. The left number is the distance to the speed limit in meters, and the right number is the speed limit in km/h. The distance must not be zero. The speed limit must be released with beacon type 18.

Beacon type 9 (ATS-P curve speed limit)

Track.Beacon 9; object; 0; 600075
This sets up an upcoming speed limit due to a curve. The left number is the distance to the speed limit in meters, and the right number is the speed limit in km/h. The distance must not be zero. The speed limit must be released with beacon type 19.

Beacon type 10 (ATS-P temporary speed limit)

Track.Beacon 10; object; 0; 600075
This sets up an upcoming temporary speed limit. The left number is the distance to the speed limit in meters, and the right number is the speed limit in km/h. The distance must not be zero. The speed limit must be released with beacon type 20.

Beacon type 16 (ATS-P divergence speed limit released)

Track.Beacon 16; object; 0; 0
This releases the speed limit due to diverging track.

Beacon type 18 (ATS-P slope speed limit released)

Track.Beacon 18; object; 0; 0
This releases the speed limit due to a slope.

Beacon type 19 (ATS-P curve speed limit released)

Track.Beacon 19; object; 0; 0
This releases the speed limit due to a curve.

Beacon type 20 (ATS-P temporary speed limit released)

Track.Beacon 20; object; 0; 0
This releases the temporary speed limit.

Beacon type 25 (ATS-P system switch)

Track.Beacon 25; object; 0; 0
If the optional data is 0, this clears all ATS-P speed patterns and switches to ATS-Sx. If the optional data is 1, this switches to ATS-P exclusively. If the optional data is 2, this switches to ATS-Sx/P, usually used where the existing ATS-Sx infrastructure checks for signals and ATS-P is superimposed to check for speed restrictions.

Beacon type 30 (TASC pattern)

Track.Beacon 30; object; 0; 400000
Sets up a TASC pattern. The left number is the distance to the stop point in meters. The right number is ignored.

Beacon type 31 (TASC home doors)

Track.Beacon 31; object; 0; 0
Indicates that the following stop point is equipped with home doors. This beacon must be installed prior to reaching the stopping area. The signal must be zero.

Beacon type 32 (TASC pattern)

Track.Beacon 32; object; 0; 12160450
Sets up a TASC pattern for a train with a specific amount of cars. The left number is the minimum amount of cars, the middle number is the maximum amount of cars, and the right number is the distance to the stop point in meters. You can also use 0000 for a train regardless of the amount of cars.

Virtual Beacons

The following are virtual beacons used to convey additional information to the plugin. These beacons have no physical counterpart.

Beacon type 40 (calling out signal aspects and speed restrictions)

Track.Beacon 40; -1; signal; 07010
This beacon is used for pointing and calling, and also to influence the behavior of the AI. The right number is the subtype that determines what to call. The left number (varying in length) is additional data depending on the subtype. The following subtypes are available:
Subtype Description
01 Home signal (場内)
02 Block signal (閉塞)
03 Departure signal (出発)
04 Repeating signal (中継)
00 is the surface type with white bars
01 is the tunnel type with color lights
05 Distant signal (遠方) [1]
2335555 describes the aspects the distant signal shows in relation to the main signal.
The left-most digit corresponds to the stop aspect and the right-most digit to the high-speed aspect.
06 Passing signal (通過) [2]
07 Shunting signal (入換)
09 End of signal visibility
10 Speed restriction
070 is the speed limit in km/h, or 000 for unlimited speed
11 Advance speed restriction
070 is the speed limit in km/h, or 000 for unlimited speed
[1] For distant signals, OdakyufanAts assumes that they are decorative only, meaning they only use a Track.SigF but not their own Track.Section.
[2] For passing signals, OdakyufanAts assumes that the home signal and the passing signal are attached to the same Track.Section with 0 (red), 2 (yellow) and 5 (green) aspects. The home signal shows red on 0, and green otherwise, while the passing signal shows green on 5, and yellow otherwise.
In order to call out a signal aspect, place a beacon of the subtype that corresponds to the type of signal at a location where the signal comes just into visual range. Additionally, place a beacon with subtype 09 about 15 meters before the signal. The signal aspect is called out somewhere between these two beacons, depending on the type of signal and on the speed and acceleration of the train.
In order to call out a speed restriction, place a beacon with the appropriate subtype at any desired location before the speed limit post. The speed restriction is called out immediately when passing the beacon.

Beacon type 44 (continuous analog transmission)

Track.Beacon 44; -1; signal; 010307301
This beacon is used to set up a section of continuous analog transmission. If the right-most number is 01, this marks the start of the continuous transmission, if 00 the end. The active frequency, idle frequency and signal aspect are identical to the normal analog beacon setup. Continuous transmission can be used, for example, to clear signal patterns - if the train travels or comes to a stop inside a section of continuous transmission, the train receives the matching frequency as soon as the signal aspect changes. However, sections of continuous analog transmission may not overlap, and engaging the continuous transmission to multiple signal aspects is currently not supported.

Legacy Beacons

These beacons are included for compatibility with other plugins.

Beacon type 0 (S long)

Track.Beacon 0; object; signal; 0
Sets up the S long beacon. If the optional data is less than -1, this sets up the downslope in 1/1000 for ATS-Ps, but only if this beacon follows a type 14 (95 KHz) beacon. Deprecated. Use frequency-based beacons instead.

Beacon type 1 (SN immediate stop)

Track.Beacon 1; object; signal; 0
Sets up the SN immediate stop beacon. Deprecated. Use frequency-based beacons instead.

Beacon type 2 (accidental departure)

Track.Beacon 2; object; signal; 0
Sets up the accidental departure beacon. This is the same as beacon type 1 as long as the optional data is 0. Otherwise, the brakes are only engaged if the train has at most as many cars as specified in the optional data. Deprecated. Use beacon types 60 and 61 instead to create a ground-based timer.

Beacon type 9 (Sx speed check)

Track.Beacon 9; object; 0; 000075
This sets up an ATS-Sx speed check. The right number is the speed limit in km/h. The left number must be zero. Deprecated. Use frequency-based beacons instead.

Beacon type 10 (P to S)

Track.Beacon 10; object; 0; 000025
Switches from ATS-P to ATS-Sx. The right number is the distance in meters after which to switch to ATS-Sx. The distance must not be zero. The left number must be zero. Deprecated. Use beacon type 25 instead.

Beacon type 11 (Ps1)

Track.Beacon 11; object; signal; 0
Sets up the Ps1 beacon for ATS-Ps. If preceded by a type 14 (95 KHz) beacon, sets pattern B, otherwise pattern A. Deprecated. Use frequency-based beacons instead.

Beacon type 12 (Ps2 + Sx speed check)

Track.Beacon 12; object; signal; 050
Sets up the Ps2 beacon for ATS-Ps. If preceded by a type 14 (95 KHz) beacon, sets pattern B, otherwise pattern A. The number is the speed limit in km/h to check against by ATS-Sx. There must always be two such beacons in close proximity to each other with the same optional data. Deprecated. Use frequency-based beacons instead.

Beacon type 13 (Ps clear)

Track.Beacon 13; object; signal; 0
Clears all ATS-Ps signal patterns if the attached signal is not red. Deprecated. Use frequency-based beacons instead.

Beacon type 14 (Ps marker)

Track.Beacon 14; object; 0; 90
Places a marker beacon for ATS-Ps. If the optional data is 90, a type 15, type 16, type 17 or type 18 beacon must follow to set up a speed restriction pattern. If the optional data is 95, a type 1, type 11 or type 12 beacon must follow to set up a pattern B signal pattern. If the optional data is 108, a type 19 or type 20 beacon must follow to set up an irekae or yuudou speed restriction pattern. Deprecated. Use frequency-based beacons instead.

Beacon type 15 (Ps divergence speed limit)

Track.Beacon 15; object; 0; 035
If following a type 14 (90 KHz) beacon, sets up an upcoming speed restriction for ATS-Ps due to diverging track. The number is the speed limit in km/h, or 0 to clear the pattern. Deprecated. Use frequency-based beacons instead.

Beacon type 16 (Ps curve speed limit)

Track.Beacon 16; object; 0; 050
If following a type 14 (90 KHz) beacon, sets up an upcoming speed restriction for ATS-Ps due to a curve. The number is the speed limit in km/h, or 0 to clear the pattern. Deprecated. Use frequency-based beacons instead.

Beacon type 17 (Ps slope speed limit)

Track.Beacon 17; object; 0; 045
If following a type 14 (90 KHz) beacon, sets up an upcoming speed restriction for ATS-Ps due to a slope. The number is the speed limit in km/h, or 0 to clear the pattern. Deprecated. Use frequency-based beacons instead.

Beacon type 18 (Ps temporary speed limit)

Track.Beacon 18; object; 0; 035
If following a type 14 (90 KHz) beacon, sets up an upcoming temporary speed restriction for ATS-Ps. The number is the speed limit in km/h, or 0 to clear the pattern. Deprecated. Use frequency-based beacons instead.

Beacon type 19 (Ps irekae speed limit)

Track.Beacon 19; object; 0; 030
If following a type 14 (108 KHz) beacon, sets up an immediate irekae (siding) speed restriction for ATS-Ps. The number is the speed limit in km/h. Deprecated. Use frequency-based beacons instead.

Beacon type 20 (Ps yuudou speed limit)

Track.Beacon 20; object; 0; 0
If following a type 14 (108 KHz) beacon, sets up an immediate yuudou (call-on) speed restriction for ATS-Ps. The speed limit is 15 km/h, plus 10 km/h as tolerance. Deprecated. Use frequency-based beacons instead.

Beacon type 31 (ATC advance warning)

Track.Beacon 31; -1; 1; 0
Indicates that the current section supports the ATC advance warning (前方予告). The warning is shown for as long as the upcoming section has a worse aspect than the current section. The invisible beacon should be placed 1 meter after the Track.Section command. The signal must reference the upcoming section (1). The optional data must be zero.

Beacon type 50 (Sx speed check, red signal, 45 km/h)

Track.Beacon 50; object; signal; 0
Sets up an ATS-Sx speed check. The beacon checks against a speed of 45 km/h, but only if the signal is red. Deprecated. Use frequency-based beacons instead.

Beacon type 55 (Sx speed check, immediate stop type)

Track.Beacon 55; object; 0; 045
Sets up an ATS-Sx speed check. The number is the speed limit in km/h. If the speed is exceeded, the emergency brakes are applied. Deprecated. Use frequency-based beacons instead.

Beacon type 56 (Sx speed check, bell type)

Track.Beacon 56; object; 0; 045
Sets up a ground-based ATS-Sx speed check. The number is the speed limit in km/h. If the speed is exceeded, the bell starts to ring and needs to be acknowledged. In reality, there are two beacons: the first starts a ground-based timer, and the second is an S long beacon that is either engaged (overspeed) or disengaged (no overspeed). When using beacon type 56 in your route, place the first beacon decoratively and use beacon type 56 on the second beacon (resembling an S long beacon).

Beacon type 60 (accidental departure, reset timer)

Track.Beacon 60; object; 0; 0
Sets up a ground-based timer for a type 61 ATS-Sx accidental departure beacon.

Beacon type 61 (accidental departure, trigger)

Track.Beacon 61; object; signal; 40000
If the attached signal is red and the ground-based timer that was set up using a type 60 beacon has reached the specified number of milliseconds, this triggers an emergency brake application.