Skip to content

bcp_server:

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 servers: setting in your bcp: section of your config is where you configure listeners for incoming BCP connections.

Required settings

The following sections are required in the bcp_server: 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.

Optional settings

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

ip:

Single value, type: string.

The IP to bind the server on. Starting in MPF 0.33, you can use ip: None and MPF will listen for incoming connections on all network interfaces.

port:

Single value, type: integer. Default: 5050

The port to listen for incoming connections.

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