magnets:¶
Config file section
Valid in machine config files | YES |
Valid in mode config files | NO |
The magnets:
section of your machine config is used to define magnet
mechanisms from coils and (optionally) switches. There are settings that
control the timing of grabbing, releasing, and “flinging” the ball.
Example:
#config_version=5
coils:
magnet_coil1:
number:
default_pulse_ms: 100
default_hold_power: 0.375
magnet_coil2:
number:
default_pulse_ms: 100
default_hold_power: 0.375
magnet_coil3:
number:
default_pulse_ms: 100
default_hold_power: 0.375
switches:
grab_switch1:
number:
grab_switch2:
number:
grab_switch3:
number:
magnets:
magnet1:
magnet_coil: magnet_coil1
grab_switch: grab_switch1
enable_events: magnet1_enable
disable_events: magnet1_disable
release_ball_events: magnet1_release
fling_ball_events: magnet1_fling
magnet_ball_save:
magnet_coil: magnet_coil2
grab_switch: grab_switch2
enable_events: magnet_ball_save_enable
disable_events: magnet_magnet_ball_save_grabbed_ball
fling_ball_events: magnet_magnet_ball_save_grabbed_ball
magnet_auto_enable:
magnet_coil: magnet_coil3
grab_switch: grab_switch3
ball_saves:
magnet_save:
balls_to_save: 1
active_time: 5s
enable_events: magnet_magnet_ball_save_grabbing_ball
Required settings¶
The following sections are required in the magnets:
section of your config:
Optional settings¶
The following sections are optional in the magnets:
section of your config. (If you don’t include them, the default will be used).
disable_events:¶
List of one (or more) device control events (Instructions for entering device control events). Default: ball_will_end, service_mode_entered
These events mean the magnet will no longer try to grab a ball if the
grab_switch:
is activated.
enable_events:¶
List of one (or more) device control events (Instructions for entering device control events). Default: ball_started
These events enable the magnet to grab a ball based on the grab_switch:
being activated.
fling_ball_events:¶
List of one (or more) device control events (Instructions for entering device control events). Defaults to empty.
Events to trigger flinging a ball.
fling_drop_time:¶
Single value, type: time string (ms)
(Instructions for entering time strings). Default: 250ms
How long the magnet is deactivated for before the “fling_regrab_time” when it’s flinging a ball.
fling_regrab_time:¶
Single value, type: time string (ms)
(Instructions for entering time strings). Default: 50ms
How long the “second” (fling) pulse is for when a magnet is flinging a ball after its dropped it.
grab_ball_events:¶
List of one (or more) device control events (Instructions for entering device control events). Defaults to empty.
These events cause the magnet to immediately attempt to grab a ball. The
magnet will be activated for the grab_time:
.
grab_switch:¶
Single value, type: string name of a switches device. Defaults to empty.
The switch which activates grabbing a ball.
grab_time:¶
Single value, type: time string (ms)
(Instructions for entering time strings). Default: 1.5s
How long the magnet will be energized when attempting to grab a ball.
playfield:¶
Single value, type: string name of a playfields device. Default: playfield
The playfield on which this magnet is.
release_ball_events:¶
List of one (or more) device control events (Instructions for entering device control events). Defaults to empty.
These events cause the magnet to deactivate for the release_time:
setting.
release_time:¶
Single value, type: time string (ms)
(Instructions for entering time strings). Default: 500ms
How long the magnet disables to release a ball.
reset_events:¶
List of one (or more) device control events (Instructions for entering device control events). Default: machine_reset_phase_3, ball_starting
These events release a grabbed ball and disable the magnet.
console_log:¶
Single value, type: one of the following options: none, basic, full. Default: basic
Log level for the console log for this device.
debug:¶
Single value, type: boolean
(true
/false
). Default: false
Set this to true to see additional debug output. This might impact the performance of MPF.
file_log:¶
Single value, type: one of the following options: none, basic, full. Default: basic
Log level for the file log for this device.
tags:¶
List of one (or more) values, each is a type: string
. Defaults to empty.
A list of tags. Not used for any logic.