#include <frc/LEDPattern.h>
|
| static LEDPattern | Solid (const Color color) |
| | Creates a pattern that displays a single static color along the entire length of the LED strip. More...
|
| |
| static LEDPattern | ProgressMaskLayer (std::function< double()> progressFunction) |
| | Creates a pattern that works as a mask layer for LEDPattern::Mask(const LEDPattern&) that illuminates only the portion of the LED strip corresponding with some progress. More...
|
| |
| static LEDPattern | Steps (std::span< const std::pair< double, Color > > steps) |
| | Display a set of colors in steps across the length of the LED strip. More...
|
| |
| static LEDPattern | Steps (std::initializer_list< std::pair< double, Color > > steps) |
| | Display a set of colors in steps across the length of the LED strip. More...
|
| |
| static LEDPattern | Gradient (std::span< const Color > colors) |
| | Creates a pattern that displays a non-animated gradient of colors across the entire length of the LED strip. More...
|
| |
| static LEDPattern | Gradient (std::initializer_list< Color > colors) |
| | Creates a pattern that displays a non-animated gradient of colors across the entire length of the LED strip. More...
|
| |
| static LEDPattern | Rainbow (int saturation, int value) |
| | Creates an LED pattern that displays a rainbow across the color wheel. More...
|
| |
◆ LEDPattern()
◆ ApplyTo() [1/2]
Writes the pattern to an LED buffer.
Dynamic animations should be called periodically (such as with a command or with a periodic method) to refresh the buffer over time.
This method is intentionally designed to use separate objects for reading and writing data. By splitting them up, we can easily modify the behavior of some base pattern to make it scroll, blink, or breathe by intercepting the data writes to transform their behavior to whatever we like.
- Parameters
-
| data | the current data of the LED strip |
◆ ApplyTo() [2/2]
Writes the pattern to an LED buffer.
Dynamic animations should be called periodically (such as with a command or with a periodic method) to refresh the buffer over time.
This method is intentionally designed to use separate objects for reading and writing data. By splitting them up, we can easily modify the behavior of some base pattern to make it scroll, blink, or breathe by intercepting the data writes to transform their behavior to whatever we like.
- Parameters
-
| data | the current data of the LED strip |
| writer | data writer for setting new LED colors on the LED strip |
◆ AtBrightness()
| LEDPattern frc::LEDPattern::AtBrightness |
( |
double |
relativeBrightness | ) |
|
Creates a pattern that plays this one, but at a different brightness.
Brightness multipliers are applied per-channel in the RGB space; no HSL or HSV conversions are applied. Multipliers are also uncapped, which may result in the original colors washing out and appearing less saturated or even just a bright white.
This method is predominantly intended for dimming LEDs to avoid painfully bright or distracting patterns from playing (apologies to the 2024 NE Greater Boston field staff).
For example, dimming can be done simply by adding a call to atBrightness at the end of a pattern:
// Solid red, but at 50% brightness
frc::LEDPattern::Solid(frc::Color::kRed).AtBrightness(0.5);
// Solid white, but at only 10% (i.e. ~0.5V)
frc::LEDPattern::Solid(frc:Color::kWhite).AtBrightness(0.1);
- Parameters
-
| relativeBrightness | the multiplier to apply to all channels to modify brightness |
- Returns
- the input pattern, displayed at
◆ Blend()
Creates a pattern that displays outputs as a combination of this pattern and another.
Color values are calculated as the average color of both patterns; if both patterns set the same LED to the same color, then it is set to that color, but if one pattern sets to one color and the other pattern sets it to off, then it will show the color of the first pattern but at approximately half brightness. This is different from LEDPattern::OverlayOn(const LEDPattern&), which will show the base pattern at full brightness if the overlay is set to off at that position.
- Parameters
-
| other | the pattern to blend with |
- Returns
- the blended pattern
◆ Blink() [1/2]
| LEDPattern frc::LEDPattern::Blink |
( |
units::second_t |
onTime | ) |
|
Like LEDPattern::Blink(units::second_t), but where the "off" time is exactly equal to the "on" time.
- Parameters
-
| onTime | how long the pattern should play for (and be turned off for), per cycle |
- Returns
- the blinking pattern
◆ Blink() [2/2]
| LEDPattern frc::LEDPattern::Blink |
( |
units::second_t |
onTime, |
|
|
units::second_t |
offTime |
|
) |
| |
Creates a pattern that switches between playing this pattern and turning the entire LED strip off.
- Parameters
-
| onTime | how long the pattern should play for, per cycle |
| offTime | how long the pattern should be turned off for, per cycle |
- Returns
- the blinking pattern
◆ Breathe()
| LEDPattern frc::LEDPattern::Breathe |
( |
units::second_t |
period | ) |
|
Creates a pattern that brightens and dims this one over time.
Brightness follows a sinusoidal pattern.
- Parameters
-
| period | how fast the breathing pattern should complete a single cycle |
- Returns
- the breathing pattern
◆ Gradient() [1/2]
| static LEDPattern frc::LEDPattern::Gradient |
( |
std::initializer_list< Color > |
colors | ) |
|
|
static |
Creates a pattern that displays a non-animated gradient of colors across the entire length of the LED strip.
The gradient wraps around so the start and end of the strip are the same color, which allows the gradient to be modified with a scrolling effect with no discontinuities. Colors are evenly distributed along the full length of the LED strip.
- Parameters
-
| colors | the colors to display in the gradient |
- Returns
- a motionless gradient pattern
◆ Gradient() [2/2]
| static LEDPattern frc::LEDPattern::Gradient |
( |
std::span< const Color > |
colors | ) |
|
|
static |
Creates a pattern that displays a non-animated gradient of colors across the entire length of the LED strip.
The gradient wraps around so the start and end of the strip are the same color, which allows the gradient to be modified with a scrolling effect with no discontinuities. Colors are evenly distributed along the full length of the LED strip.
- Parameters
-
| colors | the colors to display in the gradient |
- Returns
- a motionless gradient pattern
◆ Mask()
Similar to LEDPattern::Blend(const LEDPattern&), but performs a bitwise mask on each color channel rather than averaging the colors for each LED.
This can be helpful for displaying only a portion of the base pattern by applying a mask that sets the desired area to white, and all other areas to black. However, it can also be used to display only certain color channels or hues; for example, masking with
LEDPattern.color(Color.kRed)
- Parameters
-
- Returns
- the masked pattern
◆ OffsetBy()
| LEDPattern frc::LEDPattern::OffsetBy |
( |
int |
offset | ) |
|
Creates a pattern that displays this one, but offset by a certain number of LEDs.
The offset pattern will wrap around, if necessary.
- Parameters
-
| offset | how many LEDs to offset by |
- Returns
- the offset pattern
◆ OverlayOn()
Creates a pattern that plays this pattern overlaid on another.
Anywhere this pattern sets an LED to off (or frc::Color::kBlack), the base pattern will be displayed instead.
- Parameters
-
| base | the base pattern to overlay on top of |
- Returns
- the combined overlay pattern
◆ ProgressMaskLayer()
| static LEDPattern frc::LEDPattern::ProgressMaskLayer |
( |
std::function< double()> |
progressFunction | ) |
|
|
static |
Creates a pattern that works as a mask layer for LEDPattern::Mask(const LEDPattern&) that illuminates only the portion of the LED strip corresponding with some progress.
The mask pattern will start from the base and set LEDs to white at a proportion equal to the progress returned by the function. Some usages for this could be for displaying progress of a flywheel to its target velocity, progress of a complex autonomous sequence, or the height of an elevator.
For example, creating a mask for displaying a red-to-blue gradient, starting from the red end, based on where an elevator is in its range of travel.
frc::LEDPattern basePattern =
frc::LEDPattern::Gradient(frc::Color::kRed, frc::Color::kBlue);
frc::LEDPattern progressPattern =
basePattern.Mask(frc::LEDPattern::ProgressMaskLayer([&]() {
return elevator.GetHeight() / elevator.MaxHeight();
});
- Parameters
-
| progressFunction | the function to call to determine the progress. This should return values in the range [0, 1]; any values outside that range will be clamped. |
- Returns
- the mask pattern
◆ Rainbow()
| static LEDPattern frc::LEDPattern::Rainbow |
( |
int |
saturation, |
|
|
int |
value |
|
) |
| |
|
static |
Creates an LED pattern that displays a rainbow across the color wheel.
The rainbow pattern will stretch across the entire length of the LED strip.
- Parameters
-
| saturation | the saturation of the HSV colors, in [0, 255] |
| value | the value of the HSV colors, in [0, 255] |
- Returns
- the rainbow pattern
◆ Reversed()
Creates a pattern that displays this one in reverse.
Scrolling patterns will scroll in the opposite direction (but at the same speed). It will treat the end of an LED strip as the start, and the start of the strip as the end. This can be useful for making ping-pong patterns that travel from one end of an LED strip to the other, then reverse direction and move back to the start. This can also be useful when working with LED strips connected in a serpentine pattern (where the start of one strip is connected to the end of the previous one).
- Returns
- the reverse pattern
◆ ScrollAtAbsoluteSpeed()
| LEDPattern frc::LEDPattern::ScrollAtAbsoluteSpeed |
( |
units::meters_per_second_t |
velocity, |
|
|
units::meter_t |
ledSpacing |
|
) |
| |
Creates a pattern that plays this one scrolling up an LED strip.
A negative velocity makes the pattern play in reverse.
For example, scrolling a pattern at 4 inches per second along an LED strip with 60 LEDs per meter:
// LEDs per meter, a known value taken from the spec sheet of our
particular LED strip units::meter_t LED_SPACING = units::meter_t{1 /60.0};
frc::LEDPattern rainbow = frc::LEDPattern::Rainbow();
frc::LEDPattern scrollingRainbow =
rainbow.ScrollAtAbsoluteSpeed(units::inches_per_second_t{4},
LED_SPACING);
Note that this pattern will scroll faster if applied to a less dense LED strip (such as 30 LEDs per meter), or slower if applied to a denser LED strip (such as 120 or 144 LEDs per meter).
- Parameters
-
| velocity | how fast the pattern should move along a physical LED strip |
| ledSpacing | the distance between adjacent LEDs on the physical LED strip |
- Returns
- the scrolling pattern
◆ ScrollAtRelativeSpeed()
| LEDPattern frc::LEDPattern::ScrollAtRelativeSpeed |
( |
units::hertz_t |
velocity | ) |
|
Creates a pattern that plays this one scrolling up the buffer.
The velocity controls how fast the pattern returns back to its original position, and is in terms of the length of the LED strip; scrolling across a segment that is 10 LEDs long will travel twice as fast as on a segment that's only 5 LEDs long (assuming equal LED density on both segments).
◆ Solid()
Creates a pattern that displays a single static color along the entire length of the LED strip.
- Parameters
-
| color | the color to display |
- Returns
- the pattern
◆ Steps() [1/2]
| static LEDPattern frc::LEDPattern::Steps |
( |
std::initializer_list< std::pair< double, Color > > |
steps | ) |
|
|
static |
Display a set of colors in steps across the length of the LED strip.
No interpolation is done between colors. Colors are specified by the first LED on the strip to show that color. The last color in the map will be displayed all the way to the end of the strip. LEDs positioned before the first specified step will be turned off (you can think of this as if there's a 0 -> black step by default).
- Parameters
-
| steps | a map of progress to the color to start displaying at that position along the LED strip |
- Returns
- a motionless step pattern
◆ Steps() [2/2]
| static LEDPattern frc::LEDPattern::Steps |
( |
std::span< const std::pair< double, Color > > |
steps | ) |
|
|
static |
Display a set of colors in steps across the length of the LED strip.
No interpolation is done between colors. Colors are specified by the first LED on the strip to show that color. The last color in the map will be displayed all the way to the end of the strip. LEDs positioned before the first specified step will be turned off (you can think of this as if there's a 0 -> black step by default).
- Parameters
-
| steps | a map of progress to the color to start displaying at that position along the LED strip |
- Returns
- a motionless step pattern
◆ SynchronizedBlink()
| LEDPattern frc::LEDPattern::SynchronizedBlink |
( |
std::function< bool()> |
signal | ) |
|
Creates a pattern that blinks this one on and off in sync with a true/false signal.
The pattern will play while the signal outputs true, and will turn off while the signal outputs false.
- Parameters
-
| signal | the signal to synchronize with |
- Returns
- the blinking pattern
◆ kOff
A pattern that turns off all LEDs.
The documentation for this class was generated from the following file:
1.9.4