Driver::LED::RedGreenBlue Class Reference

This abstract class defines a basic interface for a single Red-Green-Blue LED where the application can set the individual color values and the overall brightness of the LED. More...

Detailed Description

This abstract class defines a basic interface for a single Red-Green-Blue LED where the application can set the individual color values and the overall brightness of the LED.

#include <RedGreenBlue.h>

Inheritance diagram for Driver::LED::RedGreenBlue:

Public Member Functions
virtual void	start () noexcept=0
	This method is used to start the driver.
virtual void	stop () noexcept=0
	This method is used to stop the driver.
virtual void	setRgb (uint8_t redValue, uint8_t greenValue, uint8_t blueValue) noexcept=0
	This method is used to set the LED's color value/state by individual Red/Green/Blue color values.
virtual void	setHsv (float hue, float saturation, float value) noexcept=0
	This method is used to set the LED's color value/state by Hue, Saturation, Value.
virtual void	setBrightness (uint8_t brightness) noexcept=0
	This method is used to set the LED's overall brightness.
void	setOff ()
	Convenience method to turn the LED off.
virtual	~RedGreenBlue ()
	Virtual destructor to make the compiler happy.

Constructor & Destructor Documentation

~RedGreenBlue()

virtual Driver::LED::RedGreenBlue::~RedGreenBlue ( )

inlinevirtual

Virtual destructor to make the compiler happy.

Member Function Documentation

setBrightness()

virtual void Driver::LED::RedGreenBlue::setBrightness ( uint8_t  brightness )

pure virtualnoexcept

This method is used to set the LED's overall brightness.

Implemented in Driver::LED::Pimoroni::RedGreenBlue, and Driver::LED::TPipe::RedGreeBlue.

setHsv()

virtual void Driver::LED::RedGreenBlue::setHsv ( float  hue, float  saturation, float  value  )

pure virtualnoexcept

This method is used to set the LED's color value/state by Hue, Saturation, Value.

Implemented in Driver::LED::Pimoroni::RedGreenBlue, and Driver::LED::TPipe::RedGreeBlue.

setOff()

void Driver::LED::RedGreenBlue::setOff ( )

inline

Convenience method to turn the LED off.

setRgb()

virtual void Driver::LED::RedGreenBlue::setRgb ( uint8_t  redValue, uint8_t  greenValue, uint8_t  blueValue  )

pure virtualnoexcept

This method is used to set the LED's color value/state by individual Red/Green/Blue color values.

Implemented in Driver::LED::Pimoroni::RedGreenBlue, and Driver::LED::TPipe::RedGreeBlue.

start()

virtual void Driver::LED::RedGreenBlue::start ( )

pure virtualnoexcept

This method is used to start the driver.

Implemented in Driver::LED::Pimoroni::RedGreenBlue, and Driver::LED::TPipe::RedGreeBlue.

stop()

virtual void Driver::LED::RedGreenBlue::stop ( )

pure virtualnoexcept

This method is used to stop the driver.

Implemented in Driver::LED::Pimoroni::RedGreenBlue, and Driver::LED::TPipe::RedGreeBlue.

---

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

• Driver/LED/RedGreenBlue.h