Skip to content

osc:

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 osc: section of your config is where you configure the osc platform.

Optional settings

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

events_to_send:

List of one (or more) events. The device will add handlers for those events. Defaults to empty.

You can list all events which you want to be forwarded to your OSC remote. This is an example:

hardware:
  platform: osc

osc:
  remote_ip: 127.0.0.1
  remote_port: 8000

  events_to_send:
    - player_score
    - some_non_osc_switch_active
    - some_non_osc_switch_inactive

listen_ip:

Single value, type: string. Default: 127.0.0.1

The IP MPF should use to listen for incoming UDP OSC connections. You can also set this to 0.0.0.0 if you want MPF to listen on all interfaces instead of just on loopback (local connections only).

listen_port:

Single value, type: integer. Default: 9000

The port MPF shoud use to listen for incoming UDP OSC connections.

remote_ip:

Single value, type: string. Default: 127.0.0.1

The IP address of your remote OSC server. MPF will send all messages to this IP.

remote_port:

Single value, type: integer. Default: 8000

The port of your remote OSC server.

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