My Project
rgb-led-lighting-shield.hpp
Go to the documentation of this file.
1 
11 #ifndef RGB_LED_LIGHTING_SHIELD_HPP_
12 #define RGB_LED_LIGHTING_SHIELD_HPP_
13 
14 #include <stdint.h>
18 
19 using namespace rgbShield;
20 
32 class RGBShield
33 {
34  public:
35  RGBShield(I2CPAL *i2c);
36  ~RGBShield();
37  Error_t init();
38  Error_t deinit();
39  Error_t setIntensityRGB(uint16_t red, uint16_t green, uint16_t blue);
40  Error_t setIntensityRed(uint16_t red);
41  Error_t setIntensityGreen(uint16_t green);
42  Error_t setIntensityBlue(uint16_t blue);
43  Error_t setDimmingLevel(uint16_t level);
44  Error_t setOffTimesRGB(uint16_t red, uint16_t green, uint16_t blue);
45  Error_t setCurrentRGB(uint16_t red, uint16_t green, uint16_t blue);
46  Error_t setFadeRate(uint16_t fRate);
47  Error_t setWalkTime(uint16_t wTime);
48  Error_t saveParameters();
49  Error_t setColor(uint16_t color);
50 
51  protected:
56  uint16_t _redCurr;
57  uint16_t _greenCurr;
58  uint16_t _blueCurr;
59  uint16_t _redOff;
60  uint16_t _greenOff;
61  uint16_t _blueOff;
62  uint16_t _redInt;
63  uint16_t _greenInt;
64  uint16_t _blueInt;
65  uint16_t _fadeTime;
66  uint16_t _walk;
67  uint16_t _brightness;
68 };
69 
74 #endif
RGBShield::~RGBShield
~RGBShield()
Destructor of the RGBShield-Class.
Definition: rgb-led-lighting-shield.cpp:32
RGBShield::_brightness
uint16_t _brightness
Definition: rgb-led-lighting-shield.hpp:67
INTENSITY_RGB
@ INTENSITY_RGB
Definition: rgb-led-lighting-shield-reg.hpp:31
RED
@ RED
Definition: rgb-led-lighting-shield-reg.hpp:92
RGBShield::_blueOff
uint16_t _blueOff
Definition: rgb-led-lighting-shield.hpp:61
RGBShield::_greenCurr
uint16_t _greenCurr
Definition: rgb-led-lighting-shield.hpp:57
RGBShield::setOffTimesRGB
Error_t setOffTimesRGB(uint16_t red, uint16_t green, uint16_t blue)
Set off-time for the three channels.
Definition: rgb-led-lighting-shield.cpp:239
rgbShield::ENAB
@ ENAB
Definition: rgb-led-lighting-shield-types.hpp:50
RGBShield::setFadeRate
Error_t setFadeRate(uint16_t fRate)
Set the fade rate of the board.
Definition: rgb-led-lighting-shield.cpp:285
CURRENT_GREEN
@ CURRENT_GREEN
Definition: rgb-led-lighting-shield-reg.hpp:34
SILVER
@ SILVER
Definition: rgb-led-lighting-shield-reg.hpp:89
RGBShield::_walk
uint16_t _walk
Definition: rgb-led-lighting-shield.hpp:66
rgb-led-lighting-shield-pal-timer.hpp
RGB LED LIGHTING SHIELD TIMER Platform Abstraction Layer.
RGBShield::_fadeTime
uint16_t _fadeTime
Definition: rgb-led-lighting-shield.hpp:65
YELLOW
@ YELLOW
Definition: rgb-led-lighting-shield-reg.hpp:94
OFFTIME_GREEN
@ OFFTIME_GREEN
Definition: rgb-led-lighting-shield-reg.hpp:45
RGBShield::_redCurr
uint16_t _redCurr
Definition: rgb-led-lighting-shield.hpp:56
RGBShield::_blueCurr
uint16_t _blueCurr
Definition: rgb-led-lighting-shield.hpp:58
RGBShield::setWalkTime
Error_t setWalkTime(uint16_t wTime)
Set the walk-time of the board.
Definition: rgb-led-lighting-shield.cpp:304
RGBShield::setIntensityBlue
Error_t setIntensityBlue(uint16_t blue)
Set intensity of the blue-channel.
Definition: rgb-led-lighting-shield.cpp:199
RGBShield::setIntensityGreen
Error_t setIntensityGreen(uint16_t green)
Set intensity of the green-channel.
Definition: rgb-led-lighting-shield.cpp:181
rgbShield::Status_t
Status_t
Status List.
Definition: rgb-led-lighting-shield-types.hpp:46
rgb-led-lighting-shield.hpp
RGB LED LIGHTING SHIELD Library.
BLUE
@ BLUE
Definition: rgb-led-lighting-shield-reg.hpp:100
RGBShield::setDimmingLevel
Error_t setDimmingLevel(uint16_t level)
Set dimming level.
Definition: rgb-led-lighting-shield.cpp:218
rgbShield::OK
@ OK
Definition: rgb-led-lighting-shield-types.hpp:28
INTENSITY_BLUE
@ INTENSITY_BLUE
Definition: rgb-led-lighting-shield-reg.hpp:30
DIMMINGLEVEL
@ DIMMINGLEVEL
Definition: rgb-led-lighting-shield-reg.hpp:48
READ_DIMMINGLEVEL
@ READ_DIMMINGLEVEL
Definition: rgb-led-lighting-shield-reg.hpp:74
RGBShield::_boardI2C
I2CPAL * _boardI2C
Definition: rgb-led-lighting-shield.hpp:54
READ_OFFTIME_GREEN
@ READ_OFFTIME_GREEN
Definition: rgb-led-lighting-shield-reg.hpp:70
RGBShield::init
Error_t init()
Initialization.
Definition: rgb-led-lighting-shield.cpp:49
INTENSITY_GREEN
@ INTENSITY_GREEN
Definition: rgb-led-lighting-shield-reg.hpp:29
READ_CURRENT_RED
@ READ_CURRENT_RED
Definition: rgb-led-lighting-shield-reg.hpp:65
RGBShield::saveParameters
Error_t saveParameters()
Save the current parameters.
Definition: rgb-led-lighting-shield.cpp:321
WHITE
@ WHITE
Definition: rgb-led-lighting-shield-reg.hpp:88
RGBShield::_blueInt
uint16_t _blueInt
Definition: rgb-led-lighting-shield.hpp:64
OFFTIME_RED
@ OFFTIME_RED
Definition: rgb-led-lighting-shield-reg.hpp:44
LIME
@ LIME
Definition: rgb-led-lighting-shield-reg.hpp:96
SAVEPARAMETERS
@ SAVEPARAMETERS
Definition: rgb-led-lighting-shield-reg.hpp:53
READ_OFFTIME_BLUE
@ READ_OFFTIME_BLUE
Definition: rgb-led-lighting-shield-reg.hpp:71
READ_OFFTIME_RED
@ READ_OFFTIME_RED
Definition: rgb-led-lighting-shield-reg.hpp:69
rgbShield::I2CPAL
Definition: rgb-led-lighting-shield-pal-i2c.hpp:24
CURRENT_BLUE
@ CURRENT_BLUE
Definition: rgb-led-lighting-shield-reg.hpp:35
RGBShield::_redOff
uint16_t _redOff
Definition: rgb-led-lighting-shield.hpp:59
RGBShield::_greenOff
uint16_t _greenOff
Definition: rgb-led-lighting-shield.hpp:60
FUCHSIA
@ FUCHSIA
Definition: rgb-led-lighting-shield-reg.hpp:102
READ_CURRENT_BLUE
@ READ_CURRENT_BLUE
Definition: rgb-led-lighting-shield-reg.hpp:67
NAVY
@ NAVY
Definition: rgb-led-lighting-shield-reg.hpp:101
rgb-led-lighting-shield-pal-i2c.hpp
RGB LED LIGHTING SHIELD I2C Platform Abstraction Layer.
READ_CURRENT_GREEN
@ READ_CURRENT_GREEN
Definition: rgb-led-lighting-shield-reg.hpp:66
rgbShield::UNINITED
@ UNINITED
Definition: rgb-led-lighting-shield-types.hpp:48
RGBShield::_shieldState
Status_t _shieldState
Definition: rgb-led-lighting-shield.hpp:52
WALKTIME
@ WALKTIME
Definition: rgb-led-lighting-shield-reg.hpp:47
rgbShield::INITED
@ INITED
Definition: rgb-led-lighting-shield-types.hpp:49
RGBShield::setIntensityRed
Error_t setIntensityRed(uint16_t red)
Set intensity of the red-channel.
Definition: rgb-led-lighting-shield.cpp:164
rgbShield::TIMEOUT_ERROR
@ TIMEOUT_ERROR
Definition: rgb-led-lighting-shield-types.hpp:38
RGBShield::_greenInt
uint16_t _greenInt
Definition: rgb-led-lighting-shield.hpp:63
RGBShield::setIntensityRGB
Error_t setIntensityRGB(uint16_t red, uint16_t green, uint16_t blue)
Set intensity of all channels.
Definition: rgb-led-lighting-shield.cpp:146
OLIVE
@ OLIVE
Definition: rgb-led-lighting-shield-reg.hpp:95
rgb-led-lighting-shield-reg.hpp
RGB LED LIGHTING SHIELD Library Registers.
RGBShield::_redInt
uint16_t _redInt
Definition: rgb-led-lighting-shield.hpp:62
MAROON
@ MAROON
Definition: rgb-led-lighting-shield-reg.hpp:93
RGBShield::deinit
Error_t deinit()
Deinitialization.
Definition: rgb-led-lighting-shield.cpp:124
OFFTIME_BLUE
@ OFFTIME_BLUE
Definition: rgb-led-lighting-shield-reg.hpp:46
GRAY
@ GRAY
Definition: rgb-led-lighting-shield-reg.hpp:90
TEAL
@ TEAL
Definition: rgb-led-lighting-shield-reg.hpp:99
RGBShield
RGB LED Lighting Shield Class.
Definition: rgb-led-lighting-shield.hpp:32
BLACK
@ BLACK
Definition: rgb-led-lighting-shield-reg.hpp:91
RGBShield::setColor
Error_t setColor(uint16_t color)
Set a predefined color.
Definition: rgb-led-lighting-shield.cpp:342
AQUA
@ AQUA
Definition: rgb-led-lighting-shield-reg.hpp:98
PURPLE
@ PURPLE
Definition: rgb-led-lighting-shield-reg.hpp:103
CURRENT_RED
@ CURRENT_RED
Definition: rgb-led-lighting-shield-reg.hpp:33
DMXOFF
@ DMXOFF
Definition: rgb-led-lighting-shield-reg.hpp:38
rgbShield::Error_t
Error_t
Error List.
Definition: rgb-led-lighting-shield-types.hpp:26
RGBShield::RGBShield
RGBShield(I2CPAL *i2c)
Constructor of the RGBShield-Class.
Definition: rgb-led-lighting-shield.cpp:22
GREEN
@ GREEN
Definition: rgb-led-lighting-shield-reg.hpp:97
INTENSITY_RED
@ INTENSITY_RED
Definition: rgb-led-lighting-shield-reg.hpp:28
RGBShield::setCurrentRGB
Error_t setCurrentRGB(uint16_t red, uint16_t green, uint16_t blue)
Set peak-current for the three channels.
Definition: rgb-led-lighting-shield.cpp:264
rgbShield
Definition: rgb-led-lighting-shield-types.hpp:19
FADERATE
@ FADERATE
Definition: rgb-led-lighting-shield-reg.hpp:49