Skip to content

display_light_player:

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 YES ✅

Note

This section can also be used in a show file in the display_lights: section of a step.

The display_light_player: section of your config is where you use your lights as a display. See Using LEDs as display (display_light_player) for details.

Optional settings

The following sections are optional in the display_light_player: section of your config. (If you don't include them, the default will be used).

action:

Single value, type: one of the following options: play, stop. Default: play

Play or stop the display.

bcp_connection:

Single value, type: string. Default: local_display

Which BCP client provides the content for your display. You can usually leave this at the default.

lights:

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

Which LEDs should receive the updates. You usually use a tag here or '*' for all of them.

max_x:

Single value, type: integer. Defaults to empty.

Unused.

max_y:

Single value, type: integer. Defaults to empty.

Unused.

min_x:

Single value, type: integer. Default: 0

Unused.

min_y:

Single value, type: integer. Default: 0

Unused.

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