LCDBackLight Class Reference

Controls Wio Terminal LCD back light brightness. More...

#include <lcd_backlight.hpp>

Public Member Functions
std::uint8_t	getBrightness () const
	Gets current brightness. More...
std::uint8_t	getMaxBrightness () const
	Gets maximum brightness. More...
void	setBrightness (std::uint8_t brightness)
	Sets brightness. More...
void	setMaxBrightness (std::uint8_t maxBrightness)
	Sets maximum brightness. More...
void	initialize ()
	Initialize hardware/peripherals to control back light brightness. More...

Detailed Description

Controls Wio Terminal LCD back light brightness.

Definition at line 16 of file lcd_backlight.hpp.

Member Function Documentation

getBrightness()

std::uint8_t LCDBackLight::getBrightness ( ) const

inline

Gets current brightness.

Returns

current brightness.

Definition at line 26 of file lcd_backlight.hpp.

getMaxBrightness()

std::uint8_t LCDBackLight::getMaxBrightness ( ) const

inline

Gets maximum brightness.

Returns

maximum brightness.

Definition at line 31 of file lcd_backlight.hpp.

initialize()

void LCDBackLight::initialize ( )

inline

Initialize hardware/peripherals to control back light brightness.

Remarks

This function must be called before using other LCDBackLight class member functions.

Definition at line 65 of file lcd_backlight.hpp.

setBrightness()

void LCDBackLight::setBrightness ( std::uint8_t  brightness )

inline

Sets brightness.

Parameters

[in]

brightness

new value of brightness. If the brightness value exceeds maximum brightness, the value will be clipped.

Definition at line 38 of file lcd_backlight.hpp.

setMaxBrightness()

void LCDBackLight::setMaxBrightness ( std::uint8_t  maxBrightness )

inline

Sets maximum brightness.

Parameters

[in]

maxBrightness

new value of maximum brightness. If the current brightness value exceeds maximum brightness, the current brightness will be clipped.

Definition at line 49 of file lcd_backlight.hpp.

---

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

• examples/wio_terminal/lode_runner/lcd_backlight.hpp