BCP socket client.

class mpf.core.bcp.bcp_socket_client.BCPClientSocket(machine, name, bcp)

Parent class for a BCP client socket.

(There can be multiple of these to connect to multiple BCP media controllers simultaneously.)

  • machine – The main MachineController object.
  • name – String name this client.
  • bcp – The bcp object.

Initialise BCP client socket.

accept_connection(receiver, sender)

Create client for incoming connection.


Actively connect to server.


Read the next message.

send(bcp_command, bcp_command_args)

Send a message to the BCP host.

  • bcp_command – command to send
  • bcp_command_args – parameters to command

Send BCP ‘goodbye’ command.


Send BCP ‘hello’ command.


Stop and shut down the socket client.

class mpf.core.bcp.bcp_socket_client.MpfJSONEncoder(skipkeys=False, ensure_ascii=True, check_circular=True, allow_nan=True, sort_keys=False, indent=None, separators=None, default=None)

Encoder which by default encodes to string.

Constructor for JSONEncoder, with sensible defaults.

If skipkeys is false, then it is a TypeError to attempt encoding of keys that are not str, int, float or None. If skipkeys is True, such items are simply skipped.

If ensure_ascii is true, the output is guaranteed to be str objects with all incoming non-ASCII characters escaped. If ensure_ascii is false, the output can contain non-ASCII characters.

If check_circular is true, then lists, dicts, and custom encoded objects will be checked for circular references during encoding to prevent an infinite recursion (which would cause an OverflowError). Otherwise, no such check takes place.

If allow_nan is true, then NaN, Infinity, and -Infinity will be encoded as such. This behavior is not JSON specification compliant, but is consistent with most JavaScript based encoders and decoders. Otherwise, it will be a ValueError to encode such floats.

If sort_keys is true, then the output of dictionaries will be sorted by key; this is useful for regression tests to ensure that JSON serializations can be compared on a day-to-day basis.

If indent is a non-negative integer, then JSON array elements and object members will be pretty-printed with that indent level. An indent level of 0 will only insert newlines. None is the most compact representation.

If specified, separators should be an (item_separator, key_separator) tuple. The default is (‘, ‘, ‘: ‘) if indent is None and (‘,’, ‘: ‘) otherwise. To get the most compact JSON representation, you should specify (‘,’, ‘:’) to eliminate whitespace.

If specified, default is a function that gets called for objects that can’t otherwise be serialized. It should return a JSON encodable version of the object or raise a TypeError.


Encode to string.


Return a JSON string representation of a Python data structure.

>>> from json.encoder import JSONEncoder
>>> JSONEncoder().encode({"foo": ["bar", "baz"]})
'{"foo": ["bar", "baz"]}'
iterencode(o, _one_shot=False)

Encode the given object and yield each string representation as available.

For example:

for chunk in JSONEncoder().iterencode(bigobject):

Decode a BCP command string into separate command and paramter parts.

Parameters:bcp_string – The incoming UTF-8, URL encoded BCP command string.
Returns:A tuple of the command string and a dictionary of kwarg pairs.


Input: trigger?name=hello&foo=Foo%20Bar Output: (‘trigger’, {‘name’: ‘hello’, ‘foo’: ‘Foo Bar’})

Note that BCP commands and parameter names are not case-sensitive and will be converted to lowercase. Parameter values are case sensitive, and case will be preserved.

mpf.core.bcp.bcp_socket_client.encode_command_string(bcp_command, **kwargs)

Encode a BCP command and kwargs into a valid BCP command string.

  • bcp_command – String of the BCP command name.
  • **kwargs – Optional pair(s) of kwargs which will be appended to the command.

A string.


Input: encode_command_string(‘trigger’, {‘name’: ‘hello’, ‘foo’: ‘Bar’}) Output: trigger?name=hello&foo=Bar

Note that BCP commands and parameter names are not case-sensitive and will be converted to lowercase. Parameter values are case sensitive, and case will be preserved.