Skip to content

Commit f378efa

Browse files
committed
update and link fast aud processor documentation, document exp_int feature, and link root fast config docs to fast website
1 parent da08d34 commit f378efa

File tree

3 files changed

+111
-1
lines changed

3 files changed

+111
-1
lines changed

docs/config/fast.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ title: "fast: Config Reference"
1717
The following config documentation is relevant for MPF 0.57.4 and 0.80.0. Last updated Dec 18, 2025.
1818

1919
The `fast:` section of your machine-wide config is where you configure hardware options that are specific to the FAST Pinball Controller.
20-
There is [a guide in "Hardware"](../hardware/fast/index.md) which includes FAST-specific settings and device configuration examples.
20+
The [FAST website](https://fastpinball.com/mpf/config/) also has thorough documentation and examples for MPF 0.57 and 0.80 compatible configurations.
2121

2222
## fast: config reference
2323

docs/config/fast/fast_aud.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,54 @@ title: "fast:aud: Config Reference"
1414
## aud: config reference
1515

1616
Within the `fast:` section of your machine-wide config, you configure the audio board processor in the subsection `aud:`.
17+
18+
### Sample config:
19+
20+
```yaml
21+
fast:
22+
aud:
23+
port: auto
24+
main_amp_enabled: true
25+
sub_amp_enabled: true
26+
headphones_amp_enabled: true
27+
28+
main_steps: 20
29+
sub_steps: 20
30+
headphones_steps: 20
31+
32+
default_main_volume: 32
33+
default_sub_volume: 32
34+
default_headphones_volume: 16
35+
36+
persist_volume_settings: true
37+
38+
max_hw_volume_main: 63
39+
max_hw_volume_sub: 63
40+
max_hw_volume_headphones: 63
41+
42+
main_levels_list: None
43+
sub_levels_list: None
44+
headphones_levels_list: None
45+
46+
link_sub_to_main: true
47+
link_headphones_to_main: false
48+
49+
headphones_level: headphones
50+
mute_speakers_with_headphones: true
51+
```
52+
53+
### port:
54+
55+
List of one (or more) values, each is a type: `string`. Defaults to `auto`.
56+
57+
A comma-separated list of the serial port names your FAST controller uses.
58+
59+
### baud:
60+
61+
Single value, int, default: `230400`
62+
63+
The connection baud rate.
64+
65+
### FAST Docs:
66+
67+
For the other properties, see the [FAST Audio Interface MPF Config page](https://fastpinball.com/mpf/config/audio/).

docs/config/fast/fast_exp.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,62 @@ title: "fast:exp: Config Reference"
1414
## exp: config reference
1515

1616
Within the `fast:` section of your machine-wide config, you configure the EXP processor in the subsection `exp:`, and sometimes in `exp_int`.
17+
18+
### port:
19+
20+
List of one (or more) values, each is a type: `string`. Defaults to `auto`.
21+
22+
A comma-separated list of the serial port names your FAST controller uses.
23+
24+
### baud:
25+
26+
Single value, int, default: `921600`
27+
28+
The connection baud rate.
29+
30+
### boards:
31+
32+
Dict of string board names to dicts of EXP board properties. Defaults to empty.
33+
34+
Example:
35+
36+
```yaml
37+
fast:
38+
exp:
39+
port: auto
40+
boards:
41+
neuron:
42+
model: FP-EXP-2000
43+
playfield_0081:
44+
model: FP-EXP-0081
45+
```
46+
47+
#### model:
48+
49+
The product number of the IO board. E.G. `FP-EXP-0081`
50+
51+
#### ignore_led_errors:
52+
53+
Single value, boolean, default: `false`
54+
55+
If false, LED hex communication decode errors will be raised as errors when encountered from this board.
56+
If you encounter instability due to these errors, set this to true to silently ignore them.
57+
58+
## Using exp_int
59+
60+
If using a Raspberry Pi connected directly to the Neuron controller, the LED headers on the Neuron will not be available on the normal EXP interface.
61+
In order to access these Neuron LED headers, you must define a parallel structure to the existing `exp:` configuration, and move the Neuron definition over to it.
62+
63+
Example:
64+
65+
```yaml
66+
fast:
67+
exp:
68+
boards:
69+
playfield_0081:
70+
model: FP-EXP-0081
71+
exp_int:
72+
boards:
73+
neuron:
74+
model: FP-EXP-2000
75+
```

0 commit comments

Comments
 (0)