Sille Van Landschoot / RGB-fun

simple RGB led library

Dependents:   m3Dpi MQTT-Thermostat-example Final_project_Tran Final_project_Tran ... more

RGB-fun

RGB library used to control RGB leds using PWM modulation to dim and mix the individual colors. The library uses a Color helper class to define the colors. It is possible to define colors in these ways:

  • web color notation: #FF00AA
  • Integer notation: 0 - 255
  • Floating point notation: 0.0 - 1.0

By combining red, green and blue a great amount of colors can be created. This class can accept color objects or colors in hexadecimal notation (web color notation).

Note

Effects and effectsmanager are still experimental and not documented.

RGB class reference

Import library
RGB-fun - RGB Class Reference

Public Member Functions

RGB (PinName r_pin, PinName g_pin, PinName b_pin)
Create a new RGB instance.
void setColor ( Color *color)
Set the color by giving an instance of an Color object.
void setColor (int color)
Set the color by giving an integer in hexadecimal notation.
Color * getColor ()
Get the current color of the RGB led.
void off ()
Turn the led off.

Color class reference

Import library
RGB-fun - Color Class Reference

Public Types

enum Colors

Enum with named colors for easy use.

More...

Public Member Functions

Color (int red, int green, int blue)
Create Color instance, giving individual red, green and blue factors as integer values.
Color (float red, float green, float blue)
Create Color instance, giving individual red, green and blue factors as floating point values.
Color (int hexColor)
Create Color instance, giving red, green and blue factors as a single integer value.
int getHex ()
Get the color value as an integer in hexadecimal notation.
int getRed ()
Get the red factor of the color.
int getGreen ()
Get the green factor of the color.
int getBlue ()
Get the blue factor of the color.

Example

Repository: rgb-fun-helloworld

effects/Effect.cpp@7:d10cfeb2f18e, 2015-12-03 (annotated)

Committer:
sillevl
Date:
Thu Dec 03 07:56:55 2015 +0000
Revision:
7:d10cfeb2f18e
Parent:
4:a7a26506c62f 
remove .orig files

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sillevl 2:ed46f45e1d66 1
sillevl 2:ed46f45e1d66 2 #include "Effect.h"
sillevl 2:ed46f45e1d66 3
sillevl 4:a7a26506c62f 4 Effect::Effect(RGB* led)
sillevl 4:a7a26506c62f 5 {
sillevl 2:ed46f45e1d66 6 this->led = led;
sillevl 2:ed46f45e1d66 7 speed = 1.0;
sillevl 2:ed46f45e1d66 8 reset();
sillevl 2:ed46f45e1d66 9 }
sillevl 2:ed46f45e1d66 10
sillevl 4:a7a26506c62f 11 Effect::~Effect()
sillevl 4:a7a26506c62f 12 {
sillevl 4:a7a26506c62f 13 delete led;
sillevl 4:a7a26506c62f 14 }
sillevl 4:a7a26506c62f 15
sillevl 4:a7a26506c62f 16 void Effect::setSpeed(float speed)
sillevl 4:a7a26506c62f 17 {
sillevl 2:ed46f45e1d66 18 this->speed = speed;
sillevl 2:ed46f45e1d66 19 }
sillevl 2:ed46f45e1d66 20
sillevl 4:a7a26506c62f 21 float Effect::getSpeed()
sillevl 4:a7a26506c62f 22 {
sillevl 2:ed46f45e1d66 23 return speed;
sillevl 2:ed46f45e1d66 24 }
sillevl 2:ed46f45e1d66 25
sillevl 4:a7a26506c62f 26 void Effect::reset()
sillevl 4:a7a26506c62f 27 {
sillevl 2:ed46f45e1d66 28 led->setColor(0);
sillevl 2:ed46f45e1d66 29 }
sillevl 2:ed46f45e1d66 30
sillevl 4:a7a26506c62f 31 void Effect::flash(Color * color, float onTime, float offTime)
sillevl 4:a7a26506c62f 32 {
sillevl 2:ed46f45e1d66 33 flash(color->getHex(), onTime, offTime);
sillevl 2:ed46f45e1d66 34 }
sillevl 2:ed46f45e1d66 35
sillevl 4:a7a26506c62f 36 void Effect::flash(int color, float onTime, float offTime)
sillevl 4:a7a26506c62f 37 {
sillevl 2:ed46f45e1d66 38 led->setColor(color);
sillevl 2:ed46f45e1d66 39 wait(onTime * speed);
sillevl 2:ed46f45e1d66 40 led->setColor(RGB::OFF);
sillevl 2:ed46f45e1d66 41 wait(offTime * speed);
sillevl 2:ed46f45e1d66 42 }