roo_blink
API Documentation for roo_blink
Loading...
Searching...
No Matches
Public Member Functions
roo_blink::RgbBlinker Class Reference

Runs blink sequences on an RGB LED. More...

#include <blinker.h>

Public Member Functions

 RgbBlinker (RgbLed &led)
 Constructs a RgbBlinker using the default scheduler.
 
 RgbBlinker (RgbLed &led, roo_scheduler::Scheduler &scheduler)
 Constructs a RgbBlinker using the specified scheduler.
 
void loop (RgbBlinkSequence sequence)
 Repeats the sequence indefinitely.
 
void repeat (RgbBlinkSequence sequence, int repetitions, Color terminal_color=Color())
 Repeats the sequence the specified number of times.
 
void execute (RgbBlinkSequence sequence, Color terminal_color=Color())
 Executes the sequence once.
 
void setColor (Color color)
 Enables the LED, setting it to the specified color.
 
void turnOff ()
 Disables the LED.
 

Detailed Description

Runs blink sequences on an RGB LED.

Definition at line 62 of file blinker.h.

Constructor & Destructor Documentation

◆ RgbBlinker() [1/2]

roo_blink::RgbBlinker::RgbBlinker ( RgbLed &  led)

Constructs a RgbBlinker using the default scheduler.

Definition at line 11 of file blinker.cpp.

◆ RgbBlinker() [2/2]

roo_blink::RgbBlinker::RgbBlinker ( RgbLed &  led,
roo_scheduler::Scheduler &  scheduler 
)

Constructs a RgbBlinker using the specified scheduler.

Definition at line 13 of file blinker.cpp.

Member Function Documentation

◆ execute()

void roo_blink::RgbBlinker::execute ( RgbBlinkSequence  sequence,
Color  terminal_color = Color() 
)

Executes the sequence once.

Definition at line 28 of file blinker.cpp.

◆ loop()

void roo_blink::RgbBlinker::loop ( RgbBlinkSequence  sequence)

Repeats the sequence indefinitely.

Definition at line 19 of file blinker.cpp.

◆ repeat()

void roo_blink::RgbBlinker::repeat ( RgbBlinkSequence  sequence,
int  repetitions,
Color  terminal_color = Color() 
)

Repeats the sequence the specified number of times.

Definition at line 23 of file blinker.cpp.

◆ setColor()

void roo_blink::RgbBlinker::setColor ( Color  color)

Enables the LED, setting it to the specified color.

Definition at line 32 of file blinker.cpp.

◆ turnOff()

void roo_blink::RgbBlinker::turnOff ( )

Disables the LED.

Definition at line 34 of file blinker.cpp.

The documentation for this class was generated from the following files: