Config file section
|Valid in machine config files||YES|
|Valid in mode config files||YES|
|Valid in shows||YES|
This section can also be used in a show file in the
coils: section of a step.
coil_player: section of your config is where you configure coil/solenoid/driver actions (pulse, enable,
disable, etc.) based on events. It’s also used in shows (via the
coils: section) to perform
coil actions in that show step.
Example from a config file:
coil_player: some_event: coil_1 some_other_event: coil_2: action: enable hold_power: .5
In the example above, when the event called
some_event is posted, coil_1 will pulse.
When the event
some_other_event is posted, coil_2 will enable (be held on) at power
Note that the
some_event: coil_1 is entered in a different way than the
The first one has a simple key/value pair, whereas the second has a complete nested sub-configuration.
The first example shows the “express” config, while the second shows the full config. (What’s an “express config?” Details here.
The coil player’s express config is the “pulse” action.
Example coil player from a show:
- time: 0 coils: coil1: pulse
The following sections are optional in the
coil_player: section of your config. (If you don’t include them, the default will be used).
Single value, type:
string (case-insensitive). Options include
What action the coil should perform. Note that “on” and “enable” are the same, and that “disable” and “off” are the same.
Single value, type:
number (will be converted to floating point). Default:
A multiplier value that will be applied to this coil’s pulse time (which you can use to make this coil pulse for longer or shorter durations). Note that this power setting only applies to pulse actions.
The number of milliseconds you’d like this coil to pulse for. This setting overrides the coil’s default_pulse_ms setting. Note that this setting only affects pulse actions. Make sure you are not exceeding the coil’s max_pulse_ms setting.