Skip to content

smartmatrix:

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 smartmatrix: section of your config is where you configure RGB DMD devices.

This is an example:

#config_version=5
hardware:
  rgb_dmd: smartmatrix
smartmatrix:
  my_smartmatrix:
    port: com4
    baud: 4000000
displays:
  dmd:
    width: 128
    height: 32
rgb_dmds:
  my_smartmatrix:
    hardware_brightness: .5

Required settings

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

baud:

Single value, type: integer. Defaults to empty.

Baud rate of your serial port. Depends on the smartmatrix firmware.

port:

Single value, type: string. Defaults to empty.

Name of the serial port of your smartmatrix device. This will be comX on Windows. On Linux and Mac it depends on the usb-serial chip (usually /dev/ttyUSBX on linux or /dev/tty.usbmodemYYY on Mac).

Optional settings

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

console_log:

Single value, type: one of the following options: none, basic, full. Default: none

Help us write it!

This section is unwritten or needs an update or edit. Can you help write it? Get your name in lights and geeky pinball bragging rights! Hit the magic sparkly wand to the right of the title to see this page source on GitHub. Then add/edit and submit your change. It's easy!

file_log:

Single value, type: one of the following options: none, basic, full. Default: basic

Help us write it!

This section is unwritten or needs an update or edit. Can you help write it? Get your name in lights and geeky pinball bragging rights! Hit the magic sparkly wand to the right of the title to see this page source on GitHub. Then add/edit and submit your change. It's easy!

Single value, type: boolean (true/false). Default: false

Set to true to use the old cookie. Will use the new cookie by default.

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