Troubleshooting Hardware Platforms
If you got problems with your hardware platform we first recommend to read our troubleshooting guide. Here are some hardware platform specific steps. This is a generic guide so please check if there is a more specific guide for your specific platform.
If you got problems with your platform try to enable
debug first. As
described in the
general debugging section of our
troubleshooting guide this is done by adding
debug: true to your platform config
section. This will add a lot more debugging and might slow down MPF a
bit. We recommend to disable/remove it after finishing debugging.
Reducing light update rate
If you got a lot of lights you might run into bus contention issues. You can reduce the light update rate in MPF:
mpf: default_light_hw_update_hz: 30 # defaults to 50
If you set this too low fades will be less smooth but otherwise it should not affect your game.
Coils Are Not Firing
What to do if your coils are not working?
Check if Your Hardware is Working at all
Sounds stupid but this is a good start: Is the hardware working at all?
Do you see switch hits in the logs? If not, check our section
Your hardware is not working at all.
Check the Watchdog
If switches (or other features of the platform) are working but coils
are not we have to dig deeper. Most hardware platforms have some kind of
watchdog. Often there is some LED which indicates if the watchdog is
received. The MPF log might also contain clues (especially if you have
debug and run MPF with verbose flags
-v -V). If the watchdog
is not received by your platform it will not enable coils.
In most cases watchdog related problems indicate wiring problems. Check if your boards are properly wired.
Test Your Coil Numbers using MPF Service CLI
Hardware is connected and generally working, watchdog is good but still your coils are not working? Maybe something with the numbering is odd. Lets tests that using the MPF Service CLI. Alternatively, you can also use service mode if you have already configured it. Both ways work similarly.
To use service cli:
- Open two consoles
- Start your game (e.g. using
- Start the service cli from within your game folder using
ENTERto see a list of coils.
coil_pulse your_coiland press
ENTERto pulse it.
Does it work? If not check the log and try verify the coil number. If
you do not specify
default_pulse_ms MPF will use
10ms which might
not be enough for some mechs. Try to increase that gently (maybe
Your hardware is not working at all
If your hardware is not working at all make sure that you removed the
--vpx from your
mpf both or
command line. Those options will overwrite the settings in your
hardware section and MPF will not even try to connect to your
hardware. If you got config errors we suggest you add
-X to figure
things out without interfacing real hardware all the time. Just keep
that option in mind.
Another stupid thing to check: Is your hardware connected to your PC? We know it is stupid but a loose USB connector has happened to most of us.
On Linux you might want to run the command
lsusb which should show
both of your micro controllers connected. You should see two lines
Bus 002 Device 014: ID 0483:5740 STMicroelectronics Virtual COM Port Bus 002 Device 015: ID 0483:5740 STMicroelectronics Virtual COM Port
If you are unsure about the output, run the command once with your controllers connected and once without. If there is no difference, then for sure the USB device is not properly connected.
Add debugging to related devices
If you got problems with some switches also add
debug: true to those
as it will give to more insights into the intentions of those devices.
Same will work for flippers, coils, lights, servos, steppers and more.
general debugging section for details.
Run MPF with verbose flag
general debugging section for details. TLDR: run
mpf both -t -v -V.
Report Your Issue and Ask For Help
If you cannot find the issue yourself please prepare some information about your issue according to our troubleshooting guide and ask in our forum.
Consider Improving the Documentation
Did you solve your issue but found that some relevant information in the documentation is missing or should be linked/located elsewhere? Either tell us in the forum or consider improving the documentation yourself to save future users some troubles the same way others saved you some troubles by writing this documentation.
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