roo_blink
API Documentation for roo_blink
Loading...
Searching...
No Matches
roo_blink::Led Class Referenceabstract

Abstract interface representing a monochrome LED. More...

#include <led.h>

Public Member Functions

virtual void setLevel (uint16_t level)=0
 Sets the LED brightness in the range 0 (off) to 65535 (max).
 
void turnOn ()
 Sets the LED to the maximum brightness.
 
void turnOff ()
 Turns the LED completely off.
 
virtual bool fade (uint16_t target_level, roo_time::Duration duration)=0
 Initiates a linear fade to the target level over the duration.
 

Detailed Description

Abstract interface representing a monochrome LED.

Definition at line 9 of file led.h.

Member Function Documentation

◆ fade()

virtual bool roo_blink::Led::fade ( uint16_t  target_level,
roo_time::Duration  duration 
)
pure virtual

Initiates a linear fade to the target level over the duration.

◆ setLevel()

virtual void roo_blink::Led::setLevel ( uint16_t  level)
pure virtual

Sets the LED brightness in the range 0 (off) to 65535 (max).

Referenced by turnOff(), and turnOn().

◆ turnOff()

void roo_blink::Led::turnOff ( )
inline

Turns the LED completely off.

Definition at line 18 of file led.h.

References setLevel().

◆ turnOn()

void roo_blink::Led::turnOn ( )
inline

Sets the LED to the maximum brightness.

Definition at line 15 of file led.h.

References setLevel().


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