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

Files at this revision

API Documentation at this revision

Revision 7:d10cfeb2f18e, committed 2015-12-03

Comitter:
sillevl
Date:
Thu Dec 03 07:56:55 2015 +0000
Parent:
6:b5a88296bc50
Commit message:
remove .orig files

Changed in this revision

Color.h.orig Show diff for this revision Revisions of this file
RGB.h.orig Show diff for this revision Revisions of this file 
diff -r b5a88296bc50 -r d10cfeb2f18e Color.h.orig
--- a/Color.h.orig	Thu Nov 19 08:16:58 2015 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,30 +0,0 @@
-
-#ifndef COLOR_H
-#define COLOR_H
-
-class Color
-{
-
-    int red;
-    int green;
-    int blue;
-
-    void setColor(int red, int green, int blue);
-
-public:
-
-    enum Colors {RED = 0xFF0000, GREEN = 0x00FF00, BLUE = 0x0000FF, CYAN = 0x00FFFF, MAGENTA = 0xFF00FF, YELLOW = 0xFFFF00, WHITE = 0xFFFFFF, BLACK = 0x000000};
-
-    Color(int red, int green, int blue);
-    Color(float red, float green, float blue);
-    Color(int hexColor);
-
-    int getHex();
-
-    int getRed();
-    int getGreen();
-    int getBlue();
-
-};
-
-#endif

diff -r b5a88296bc50 -r d10cfeb2f18e RGB.h.orig
--- a/RGB.h.orig	Thu Nov 19 08:16:58 2015 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,38 +0,0 @@
-
-#include "mbed.h"
-#include "Color.h"
-
-#ifndef RGB_H
-#define RGB_H
-
-class RGB
-{
-public:
-
-    static const int OFF = 0;
-
-    RGB(PinName r_pin, PinName g_pin, PinName b_pin);
-    ~RGB();
-    // void setIntensity(int intensity); // How are we gonna do this?
-    void setColor(Color* color);
-    void setColor(int color);
-    Color* getColor();
-
-    // void on(); // do we need this? what value to turn on to?
-    void off();
-
-protected:
-    //void setColor(int r, int g, int b);
-
-private:
-    PwmOut* r_out;
-    PwmOut* g_out;
-    PwmOut* b_out;
-
-    Color* color;
-
-    void setPwmColor(int value, PwmOut* output);
-
-};
-
-#endif