Adding ws2812fx lib and its single-led version ws2812sfx
[lpc1224] / include / extdrv / ws2812sfx.h
1 /*
2   WS2812SFX.h - Library for WS2812 LED effects.
4   Harm Aldick - 2016
5   www.aldick.org
6   FEATURES
7     * A lot of blinken modes and counting
8     * WS2812FX can be used as drop-in replacement for Adafruit Neopixel Library
9   NOTES
10     * Uses the Adafruit Neopixel library. Get it here:
11       https://github.com/adafruit/Adafruit_NeoPixel
12   LICENSE
13   The MIT License (MIT)
14   Copyright (c) 2016  Harm Aldick
15   Permission is hereby granted, free of charge, to any person obtaining a copy
16   of this software and associated documentation files (the "Software"), to deal
17   in the Software without restriction, including without limitation the rights
18   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
19   copies of the Software, and to permit persons to whom the Software is
20   furnished to do so, subject to the following conditions:
21   The above copyright notice and this permission notice shall be included in
22   all copies or substantial portions of the Software.
23   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
29   THE SOFTWARE.
30   CHANGELOG
31   2016-05-28   Initial beta release
32   2016-06-03   Code cleanup, minor improvements, new modes
33   2016-06-04   2 new sfx, fixed setColor (now also resets _mode_color)
34   2017-02-02   added external trigger functionality (e.g. for sound-to-light)
35 */
37 #ifndef WS2812SFX_h
38 #define WS2812SFX_h
40 #include "core/pio.h"
42 #define SFX_DEFAULT_BRIGHTNESS 50
43 #define SFX_DEFAULT_MODE 0
44 #define SFX_DEFAULT_SPEED 150
45 #define SFX_DEFAULT_COLOR 0xFFFFFF
47 #define SFX_SPEED_MIN 0
48 #define SFX_SPEED_MAX 255
50 #define SFX_BRIGHTNESS_MIN 0
51 #define SFX_BRIGHTNESS_MAX 255
53 enum ModeSFX {
54         SFX_MODE_STATIC,
55         SFX_MODE_BLINK,
56         SFX_MODE_BREATH,
57         SFX_MODE_RANDOM_COLOR,
58         SFX_MODE_MULTI_DYNAMIC,
59         SFX_MODE_FADE,
60         SFX_MODE_STROBE,
61         SFX_MODE_STROBE_RAINBOW,
62         SFX_MODE_MULTI_STROBE,
63         SFX_MODE_BLINK_RAINBOW,
64         SFX_MODE_COUNT
65 };
67 typedef struct {
68         int _running;
70         uint8_t _mode_index;
71         uint8_t _speed;
72         uint8_t _brightness;
74         uint32_t _color;
75         uint32_t _counter_mode_call;
76         uint32_t _counter_mode_step;
77         uint32_t _mode_color;
78         uint32_t _mode_delay;
80         unsigned long _mode_last_call_time;
81 } ws2812sfx_t;
83 void WS2812SFX(ws2812sfx_t *sfx, const struct pio *pin);
85 void SFX_init(ws2812sfx_t *sfx);
86 void SFX_service(ws2812sfx_t *sfx);
87 void SFX_start(ws2812sfx_t *sfx);
88 void SFX_stop(ws2812sfx_t *sfx);
90 void SFX_setMode(ws2812sfx_t *sfx, uint8_t m);
91 void SFX_setSpeed(ws2812sfx_t *sfx, uint8_t s);
92 void SFX_increaseSpeed(ws2812sfx_t *sfx, uint8_t s);
93 void SFX_decreaseSpeed(ws2812sfx_t *sfx, uint8_t s);
94 void SFX_setRGBColor(ws2812sfx_t *sfx, uint8_t r, uint8_t g, uint8_t b);
95 void SFX_setColor(ws2812sfx_t *sfx, uint32_t c);
96 void SFX_setBrightness(ws2812sfx_t *sfx, uint8_t b);
97 void SFX_increaseBrightness(ws2812sfx_t *sfx, uint8_t s);
98 void SFX_decreaseBrightness(ws2812sfx_t *sfx, uint8_t s);
100 const char* SFX_getModeName(enum ModeSFX m);
102 static inline int SFX_isRunning(ws2812sfx_t *sfx)
104         return sfx->_running;
107 static inline uint8_t SFX_getMode(ws2812sfx_t *sfx)
109         return sfx->_mode_index;
112 static inline uint8_t SFX_getSpeed(ws2812sfx_t *sfx)
114         return sfx->_speed;
117 static inline uint8_t SFX_getBrightness(ws2812sfx_t *sfx)
119         return sfx->_brightness;
122 static inline uint8_t SFX_getModeCount(ws2812sfx_t *sfx)
124         return SFX_MODE_COUNT;
127 static inline uint32_t SFX_getColor(ws2812sfx_t *sfx)
129         return sfx->_color;
132 #endif