Skip to content

Commit

Permalink
Merge pull request #501 from worldpeace-germany/main
Browse files Browse the repository at this point in the history
LED section clean up after doc migration
  • Loading branch information
toomanybrians authored Dec 31, 2023
2 parents 0d3b4ef + 25ba2c7 commit ee89d30
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 25 deletions.
4 changes: 3 additions & 1 deletion docs/config/light_stripes.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,16 @@ title: "light_stripes:"
|[machine](instructions/machine_config.md) config files |**YES** :white_check_mark:|
|[mode](instructions/mode_config.md) config files|**NO** :no_entry_sign:|

A `led_stripe` will create `count` leds for you starting the number
A `light_stripes` will create `count` leds for you starting the number
at `number_start`. If you need a prefix or suffix for the number you
can use `number_template`. All settings in `led_template` will be
applied to all LEDs. The only difference between
[led_stripes](light_stripes.md) and
[light_rings](light_rings.md) is how
the x/y coordinates are computed.

In order to access single light in your strip you can use the following syntax schema `<light_strip_name>_light_<light_number>`. Where `<light_strip_name>` is the name you have choosen for your light strip and `<light_number>` is the number of the light in the stip, keep in mind the numbering starts with 0 and not 1.

## Required settings

The following sections are required in the `light_stripes:` section of
Expand Down
6 changes: 6 additions & 0 deletions docs/mechs/lights/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,13 +226,19 @@ light_player:
strip0: DFFF00
led_off:
led_strip_0: off
single_led_green:
led_strip_0_light_5: green #led_strip_0 is the name of the strip
keyboard:
1:
event: led_off
2:
event: full_strip_on
3:
event: single_led_green
```
Pay attention to the event `single_led_green` to understand how to address a single light in your light strip.


## Monitorable Properties
For dynamic values and conditional events, the prefix for lights is `device.lights.<name>`.
Expand Down
24 changes: 0 additions & 24 deletions docs/mechs/lights/leds.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,30 +37,6 @@ channels (either RGBW or GRBW order). Other serial LEDs contain three
white LEDs (WWW order). If nothing is specified MPF assumes RGB order so
you need to specify it for any LED with a different channel order.

MPF can control LEDs, including single-channel (single color) and full
RGB LEDs. (You can control the order too, so you can control RGB, BRG,
etc.) You can set default fade rates and control strips and rings of
LEDs.

In general there are two ways to wire LEDs in a pinball machine. Either
parallel or serial. With serial LEDs you got a chain of LEDs which are
connected to a controller board on one side. In contrast, with parallel
LEDs every LED has its own wire(s) to the controller. While parallel
LEDs are more robust in general they also require much more wiring.
Which kind of LEDs you're using usually depends on what is supported in
your platform (some support both).

## Serial LEDs

With serial LEDs the order of colors is usually fixed. For instance, in
WS2811 LEDs (a common serial LED controller embedded inside the LED),
the first channel is red, the second green and third is blue (RGB
order). Newer WS2812 LEDs have GRB order (green, red and blue). Some
LEDs also contain an additional white channel and thereby have four
channels (either RGBW or GRBW order). Other serial LEDs contain three
white LEDs (WWW order). If nothing is specified MPF assumes RGB order so
you need to specify it for any LED with a different channel order.

Overview video about serial LEDs:

<div class="video-wrapper">
Expand Down

0 comments on commit ee89d30

Please sign in to comment.