roo_blink
API Documentation for roo_blink
Loading...
Searching...
No Matches
roo_blink::Blinker Class Reference

Runs blink sequences on a monochrome LED. More...

#include <blinker.h>

Public Member Functions

 Blinker (Led &led)
 Constructs a Blinker using the default scheduler.
 
 Blinker (Led &led, roo_scheduler::Scheduler &scheduler)
 Constructs a Blinker using the specified scheduler.
 
void loop (BlinkSequence sequence)
 Repeats the sequence indefinitely.
 
void repeat (BlinkSequence sequence, int repetitions, uint16_t terminal_level=0)
 Repeats the sequence the specified number of times.
 
void execute (BlinkSequence sequence, uint16_t terminal_level=0)
 Executes the sequence once.
 
void set (uint16_t intensity)
 Enables the LED at the specified intensity.
 
void turnOn ()
 Enables the LED at the maximum intensity.
 
void turnOff ()
 Disables the LED.
 

Detailed Description

Runs blink sequences on a monochrome LED.

Definition at line 72 of file blinker.h.

Constructor & Destructor Documentation

◆ Blinker() [1/2]

roo_blink::Blinker::Blinker ( Led led)

Constructs a Blinker using the default scheduler.

Definition at line 12 of file blinker.cpp.

◆ Blinker() [2/2]

roo_blink::Blinker::Blinker ( Led led,
roo_scheduler::Scheduler &  scheduler 
)

Constructs a Blinker using the specified scheduler.

Definition at line 14 of file blinker.cpp.

Member Function Documentation

◆ execute()

void roo_blink::Blinker::execute ( BlinkSequence  sequence,
uint16_t  terminal_level = 0 
)

Executes the sequence once.

Definition at line 29 of file blinker.cpp.

◆ loop()

void roo_blink::Blinker::loop ( BlinkSequence  sequence)

Repeats the sequence indefinitely.

Definition at line 20 of file blinker.cpp.

◆ repeat()

void roo_blink::Blinker::repeat ( BlinkSequence  sequence,
int  repetitions,
uint16_t  terminal_level = 0 
)

Repeats the sequence the specified number of times.

Definition at line 24 of file blinker.cpp.

◆ set()

void roo_blink::Blinker::set ( uint16_t  intensity)

Enables the LED at the specified intensity.

Definition at line 33 of file blinker.cpp.

Referenced by turnOff(), and turnOn().

◆ turnOff()

void roo_blink::Blinker::turnOff ( )

Disables the LED.

Definition at line 37 of file blinker.cpp.

References set().

◆ turnOn()

void roo_blink::Blinker::turnOn ( )

Enables the LED at the maximum intensity.

Definition at line 35 of file blinker.cpp.

References set().


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