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

Single step of a monochrome blink sequence. More...

#include <blinker.h>

Friends

class Blinker
 
constexpr Step TurnOn ()
 Creates a step that sets the LED to the maximum brightness instantly.
 
constexpr Step TurnOff ()
 Creates a step that sets the LED to completely off instantly.
 
constexpr Step FadeOn (roo_time::Duration duration)
 Creates a step that fades linearly to the maximum brightness over duration.
 
constexpr Step FadeOff (roo_time::Duration duration)
 Creates a step that fades linearly down to off over the duration.
 
constexpr Step SetTo (uint16_t level)
 Creates a step that sets the LED to the specified brightness instantly.
 
constexpr Step FadeTo (uint16_t level, roo_time::Duration duration)
 Creates a step that fades linearly to the target level over the duration.
 
constexpr Step Hold (roo_time::Duration duration)
 Creates a step that maintains the current brightness for the duration.
 

Detailed Description

Single step of a monochrome blink sequence.

Definition at line 16 of file blinker.h.

Friends And Related Symbol Documentation

◆ Blinker

friend class Blinker
friend

Definition at line 28 of file blinker.h.

◆ FadeOff

constexpr Step FadeOff ( roo_time::Duration  duration)
friend

Creates a step that fades linearly down to off over the duration.

Definition at line 146 of file blinker.h.

◆ FadeOn

constexpr Step FadeOn ( roo_time::Duration  duration)
friend

Creates a step that fades linearly to the maximum brightness over duration.

Definition at line 142 of file blinker.h.

◆ FadeTo

constexpr Step FadeTo ( uint16_t  level,
roo_time::Duration  duration 
)
friend

Creates a step that fades linearly to the target level over the duration.

Definition at line 138 of file blinker.h.

◆ Hold

constexpr Step Hold ( roo_time::Duration  duration)
friend

Creates a step that maintains the current brightness for the duration.

Definition at line 150 of file blinker.h.

◆ SetTo

constexpr Step SetTo ( uint16_t  level)
friend

Creates a step that sets the LED to the specified brightness instantly.

Definition at line 136 of file blinker.h.

◆ TurnOff

constexpr Step TurnOff ( )
friend

Creates a step that sets the LED to completely off instantly.

Definition at line 134 of file blinker.h.

◆ TurnOn

constexpr Step TurnOn ( )
friend

Creates a step that sets the LED to the maximum brightness instantly.

Definition at line 133 of file blinker.h.


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