Fetched: 2026-10-31. Raw markdown of the MPF docs main branch (the current 0.80 docs):
- Settings: channels, color_correction_profile, default_on_color, fade_ms, number, platform, platform_settings, previous, start_channel, subtype, type, x, y, z, tags.
- type: "This describes the channel order of an LED."
- previous: "MPF will then calculate the number based on the light of the previous" (chain syntax since MPF 0.54).
- fade_ms: "When this light receives instructions to change color, it can interpolate from its current value to the new value over a fade time."
- x/y: "used for display_light_player to determine the position of this light on the playfield and use it as a huge display."
- Colours as names (
red) or hex (ff0000). Fade short syntax "(color)-f(time)(unit) (i.e. red-f200ms)". Lights can be set by tag.
- action: play, stop, pause, resume, advance, step_back, update, queue (default play).
- loops: default -1 = repeat until stopped, 0 = play once.
- priority: "Adds to the priority of the mode the entry belongs to ... 10 in a mode at 300 gives 310."
- speed: multiplier (2 = double). sync_ms: "Delays the start to a millisecond multiple so shows started at different times stay in sync."
- show_tokens: values that replace tokens, e.g.
led: right_inlane.
- Also: manual_advance, start_step, start_running, block_queue, key, events_when_played/stopped/completed/looped.
- "When MPF plays a show, it looks for words in the show contained in parenthesis". Example step
(led): red, played with show_tokens: led: led_02.
- Number format chain-card-index, index from 0. Channels = 3 x index. "OPP hardware can directly drive LED strips" ("feature is currently being developed"). RGBW must be chained with
previous: and given a type.
- "There is no point to use RGB LEDs below colored inserts. That simply does not work physically." / "Those colored inserts act as filter and any other color simply shall not pass." / "We recommend white LEDs below colored inserts."
- "if one LED fails within a chain all subsequent ones will likely also fail until the broken LED is changed."
- "Jersey Jack Pinball tried serial LEDs in the Wizard of Oz (WoZ) and ran into a lot of reliability issues." ... "they reverted back to parallel LEDs (one I2C driver chip per chain)."
- "Both types are spec'd for 4.5V to 5.5V operations" / "make sure that the voltage does not drop below 4.5V inside the chain at full brightness." / "run your power supply at 5.5V instead of 5V to give your LEDs some headroom."
- LEDs "might be pinkish or blueish instead depending on the brand of the LED", which is what color_correction profiles correct for.
- "GI in Stern SPIKE systems are just regular LEDs"; LEDs have "256 levels of brightness"; "Flashers in Stern SPIKE systems are also controlled just like normal lights."