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

RGB.h@4:a7a26506c62f, 2015-10-22 (annotated)

Committer:
sillevl
Date:
Thu Oct 22 17:17:13 2015 +0000
Revision:
4:a7a26506c62f
Parent:
2:ed46f45e1d66
Child:
6:b5a88296bc50
code cleanup

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sillevl 0:9509f771054b 1
sillevl 0:9509f771054b 2 #include "mbed.h"
sillevl 2:ed46f45e1d66 3 #include "Color.h"
sillevl 0:9509f771054b 4
sillevl 2:ed46f45e1d66 5 #ifndef RGB_H
sillevl 2:ed46f45e1d66 6 #define RGB_H
sillevl 0:9509f771054b 7
sillevl 4:a7a26506c62f 8 class RGB
sillevl 4:a7a26506c62f 9 {
sillevl 4:a7a26506c62f 10 public:
sillevl 4:a7a26506c62f 11
sillevl 2:ed46f45e1d66 12 static const int OFF = 0;
sillevl 4:a7a26506c62f 13
sillevl 0:9509f771054b 14 RGB(PinName r_pin, PinName g_pin, PinName b_pin);
sillevl 4:a7a26506c62f 15 ~RGB();
sillevl 0:9509f771054b 16 // void setIntensity(int intensity); // How are we gonna do this?
sillevl 2:ed46f45e1d66 17 void setColor(Color* color);
sillevl 0:9509f771054b 18 void setColor(int color);
sillevl 2:ed46f45e1d66 19 Color* getColor();
sillevl 4:a7a26506c62f 20
sillevl 0:9509f771054b 21 // void on(); // do we need this? what value to turn on to?
sillevl 0:9509f771054b 22 void off();
sillevl 4:a7a26506c62f 23
sillevl 4:a7a26506c62f 24 protected:
sillevl 0:9509f771054b 25 //void setColor(int r, int g, int b);
sillevl 4:a7a26506c62f 26
sillevl 4:a7a26506c62f 27 private:
sillevl 0:9509f771054b 28 PwmOut* r_out;
sillevl 0:9509f771054b 29 PwmOut* g_out;
sillevl 0:9509f771054b 30 PwmOut* b_out;
sillevl 4:a7a26506c62f 31
sillevl 2:ed46f45e1d66 32 Color* color;
sillevl 4:a7a26506c62f 33
sillevl 2:ed46f45e1d66 34 void setPwmColor(int value, PwmOut* output);
sillevl 4:a7a26506c62f 35
sillevl 0:9509f771054b 36 };
sillevl 2:ed46f45e1d66 37
sillevl 2:ed46f45e1d66 38 #endif