Library to control LEDs, implemented in C. It supports single, bicolor or tricolor LEDs. The library is designed to use only static memory allocation and it can be used with any microcontroller.
- CPU agnostic implementation
- use only static memory allocation
- support to blink, brightness, fade in/out
- widely configurable via macros
Simply copy the content of src directory to your work directory.
The configuration of the library is done by setting 'define' macros in the header file, under the configuration section.
There are two mandatory configurations before the use, the GPIO include file and the
setting of the LEDZ_GPIO_SET macro. In the include files section replace the line
#include "gpio.h" with the include of your GPIO library. Then, in the configuration
section, adjust the macro LEDZ_GPIO_SET to the "set gpio" function of your library.
To use the library with an Arduino the configuration would be:
#include <Arduino.h>
// ...
#define LEDZ_GPIO_SET(port,pin,value) digitalWrite(pin,value)
The other settings are preset and can be adjusted as needed. The macro LEDZ_MAX_INSTANCES is used to define the total amount of LEDs being controlled by the library. Note that a RGB LED requires three LEDs. For example, if you have two RGB LEDs on your system, you have to set LEDZ_MAX_INSTANCES to the value 6. The macro LEDZ_TURN_ON_VALUE defines if the LED turns on with high or low logic and the LEDZ_TICK_PERIOD macro is used to set the interrupt service routine (ISR) period.
The LEDs brightness support is enabled by default through the LEDZ_BRIGHTNESS_SUPPORT macro. You can disable the brightness support by commenting out that macro line. This saves RAM and program memory. The PWM used to control the brightness can be either, generated internally or provided by the user via LEDZ_GPIO_PWM macro.
Once the configuration is done the last required step, before start to use the library, is to
place the function ledz_tick inside one timer ISR. Remember that the period of this timer must
match with the value in LEDZ_TICK_PERIOD macro.
Remark: this library does not configure the GPIO direction, you have to do it before use any LED control function.
To see more details how to use the library, please check the online API documentation.
MIT