Skip to content

bcp_connection:

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 NO 🚫
mode config files NO 🚫

The connections: setting in your bcp: section of your config is where you configure BCP connections MPF should establish on startup.

Required settings

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

type:

Single value, type: string.

The class to implement the transport. Use mpf.core.bcp.bcp_socket_client.BCPClientSocket to use the standard MPF BCP protocol.

More implementations are possible here. For instance, a highly efficient implemententation for production or an encrypted socket for communication over the Internet.

Optional settings

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

exit_on_close:

Single value, type: boolean (Yes/No or True/False). Default: True

Whatever MPF should exit if this connection disconnects. This is usually true for the media manager because we want MPF to exit once it is closed.

host:

Single value, type: string.

The host to connect to for this connection.

port:

Single value, type: integer. Default: 5050

The port to connect to for this connection.

required:

Single value, type: boolean (Yes/No or True/False). Default: True

Whatever this connection is required for MPF to run. Set this to false if you want MPF not to wait for this connection on start.

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