This documentation is for an unreleased version of MPF!
This is the developer documentation for MPF 0.54, which is the “dev” (next) release of MPF that is a work-in-progress. Use the “Read the Docs” link in the lower left corner to view the developer docs for the version of MPF you’re using.
LightRing(machine: mpf.core.machine.MachineController, name)¶
A light ring.
Accessing light_rings in code
The device collection which contains the light_rings in your machine is available via
self.machine.light_rings. For example, to access one called “foo”, you would use
self.machine.light_rings.foo. You can also access light_rings in dictionary form, e.g.
You can also get devices by tag or hardware number. See the DeviceCollection documentation for details.
Methods & Attributes
Light_rings have the following methods & attributes available. Note that methods & attributes inherited from base classes are not included here.
color(color, fade_ms=None, priority=0, key=None)¶
Call color on all lights in this group.
format_log_line(msg, context, error_no) → str¶
Return a formatted log line with log link and context.
Return all lights in group as token.
raise_config_error(msg, error_no, *, context=None) → NoReturn¶
Raise a ConfigFileError exception.