oveRTOS C++ API
C++20 RAII wrappers for the oveRTOS C API
Loading...
Searching...
No Matches
Functions
ove::led Namespace Reference

Thin C++ wrappers around the oveRTOS LED control API. More...

Functions

void set (unsigned int led, int on)
 Turns a LED on or off.
 
void toggle (unsigned int led)
 Toggles the state of a LED.
 
unsigned int count ()
 Returns the total number of LEDs available on this board.
 

Detailed Description

Thin C++ wrappers around the oveRTOS LED control API.

Available when CONFIG_OVE_LED is enabled. LEDs are identified by a zero-based index.

Function Documentation

◆ set()

void ove::led::set ( unsigned int  led,
int  on 
)
inline

Turns a LED on or off.

Parameters
[in]ledLED index (0-based).
[in]onNon-zero to turn on, zero to turn off.

◆ toggle()

void ove::led::toggle ( unsigned int  led)
inline

Toggles the state of a LED.

Parameters
[in]ledLED index (0-based).

◆ count()

unsigned int ove::led::count ( )
inline

Returns the total number of LEDs available on this board.

Returns
Number of LEDs.