Skip to content

digital_outputs:

This is a config file reference. Click for instructions.

This page is reference material which explains every setting and option for this section of an MPF yaml config file. See the instructions for config files for formatting and other details. See our guide to config file examples for more examples of real configs in action.

Valid in
machine config files YES ✅
mode config files NO 🚫

The digital_outputs: section of your config is where you configure digital outputs. Those can be either mapped to a light or a driver and support only enabling and diabling. In contrast to a light, digital_outputs do not support any fading or pwm/brightness. Opposed to drivers, digital_outputs do not support pulsing, pattern or hardware rules. Use them to control digital logic. MPF uses them to control motors with additional control logic.

Some platforms such as Stern Spike, Gottlieb System 1 or Gottlieb System 80 use lights outputs to control logic. In other platforms you usually use drivers.

Required settings

The following sections are required in the digital_outputs: section of your config:

number:

Single value, type: string. Defaults to empty.

The number of your light or driver. The exact meaning of this number depends on your platform but is exactly the same as if this was a light or driver (depending on the type setting).

type:

Single value, type: one of the following options: light, driver. Defaults to empty.

Whether this output is mapped as light or driver.

Optional settings

The following sections are optional in the digital_outputs: 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). Defaults to empty.

Those events will disable this output when posted.

enable_events:

List of one (or more) device control events (Instructions for entering device control events). Defaults to empty.

Those events will enable this output when posted.

light_subtype:

Single value, type: string. Defaults to empty.

If this is mapped as light (type: light) you can set the subtype here (see lights for details about subtype). The exact meaning depends on your platform.

platform:

Single value, type: string. Defaults to empty.

In case you want to overwrite the default platform (as defined in hardware:), you can choose a platform for this output.

platform_settings:

Single value, type: dict. Defaults to empty.

Dict of platform specific settings. Consult your platform documentation for those settings.

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.

label:

Single value, type: string. Default: %

Name of this device in service mode.

tags:

List of one (or more) values, each is a type: string. Defaults to empty.

Not used.

Something missing or wrong? You can fix it!

This website is edited by people like you! Is something wrong or missing? Is something out of date, or can you explain it better?

Please help us! You can fix it yourself and be an official "open source" contributor!

It's easy! See our Beginner's guide to editing the docs.

Page navigation via the keyboard: < >

You can navigate this site via the keyboard. There are two modes:

General navigation, when search is not focused:

  • F , S , / : open search dialog
  • P , , : go to previous page
  • N , . : go to next page

While using the search function:

  • Down , Up : select next / previous result
  • Esc , Tab : close search
  • Enter : go to highlighted page in the results