SimpLedRGB/README.md

41 lines
1.1 KiB
Markdown
Raw Normal View History

2024-10-14 22:09:44 +02:00
# SimpLedRGB
2024-10-14 14:00:03 +02:00
This Arduino IDE library is a simple way to control an RGB LED. It can also be used for other micro controllers that can be programmed via Arduino IDE.
## Installation
Put this folder into your `~/Arduino/libraries` folder.
## Usage
2024-10-14 22:09:44 +02:00
Include the header file `SimpLedRGB.h` and initialize the module with three PWM pins of your micro controller (in the case of the Arduino Uno 3, 5 and 6 for instance). Don't forget to call `begin()` in the setup() method. Now you can use both methods `setColor()` and `translateToColor()` to control your LED.
2024-10-14 14:00:03 +02:00
The RGB Colors are specified with the `Color` type. Red, green and blue can have values between 0.0 (off) and 1.0 (completely on).
The following example defines three colors RED, GREEN and VIOLET and uses the two methods to control the led:
```cpp
2024-10-14 22:09:44 +02:00
#include <SimpLedRGB.h>
2024-10-14 14:00:03 +02:00
const Color RED = {1.0, 0.0, 0.0};
const Color GREEN = {0.0, 1.0, 0.0};
const Color VIOLET = {1.0, 0.0, 1.0};
2024-10-14 22:09:44 +02:00
SimpLedRGB led(3, 5, 6);
2024-10-14 14:00:03 +02:00
void setup {
led.begin();
}
void loop {
led.setColor(RED);
delay(1000);
led.translate(GREEN, 3000);
delay(1000);
led.setColor(VIOLET);
delay(1000);
led.translate({1.0, 0.5, 0.0}, 3000);
}
```