Skip to content

pkone:

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 pkone: section of your machine-wide config is where you configure hardware options that are specific to the Penny K Pinball PKONE Controller. Note that we have a how to guide which includes all the PKONE-specific settings throughout your entire config file, so be sure to read that if you have Penny K Pinball PKONE hardware.

pkone:
  port: com3

Required settings

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

port:

Single value, type: string. Defaults to empty.

The serial port name your PKONE controller uses.

Optional settings

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

baud:

Single value, type: integer. Default: 115200

Baud rate to use on the serial port.

console_log:

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

Log level for the console log for this platform.

debug:

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

See the documentation on the debug setting for details.

file_log:

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

Log level for the file log for this platform.

watchdog:

Single value, type: time string (ms) (Instructions for entering time strings). Default: 1000

The PKONE controller includes a "watchdog" timer. A watchdog is a timer that is continuously counting down towards zero, and if it ever hits zero, the controller shuts off all the power to the drivers and turns off all the lights. The idea is that every time MPF runs a game loop (so, 30 times a second or whatever), MPF tells the FAST controller to reset the watchdog timer. So this timer is constantly getting reset and never hits zero.

But if MPF crashes or loses communication with the PKONE hardware, then this watchdog timer won't be reset. When it hits zero, the PKONE controller will kill the power to the coils and servos and turn off all lights. This should prevent an MPF crash from burning up a coil or somehow damaging your hardware in another way.

You can set the watchdog timer to whatever you want (up to 10 seconds). This is essentially the maximum time a coil could be stuck "on" if MPF crashes. The default is 1 second which is probably fine for almost everyone, and you don't have to include this section in your config if you want to use the 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