1 /* Copyright 2016-2017 Yang Liu
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 #include <avr/eeprom.h>
18 #include <avr/interrupt.h>
19 #include <util/delay.h>
24 #include "led_tables.h"
26 __attribute__ ((weak))
27 const uint8_t RGBLED_BREATHING_INTERVALS[] PROGMEM = {30, 20, 10, 5};
28 __attribute__ ((weak))
29 const uint8_t RGBLED_RAINBOW_MOOD_INTERVALS[] PROGMEM = {120, 60, 30};
30 __attribute__ ((weak))
31 const uint8_t RGBLED_RAINBOW_SWIRL_INTERVALS[] PROGMEM = {100, 50, 20};
32 __attribute__ ((weak))
33 const uint8_t RGBLED_SNAKE_INTERVALS[] PROGMEM = {100, 50, 20};
34 __attribute__ ((weak))
35 const uint8_t RGBLED_KNIGHT_INTERVALS[] PROGMEM = {127, 63, 31};
36 __attribute__ ((weak))
37 const uint16_t RGBLED_GRADIENT_RANGES[] PROGMEM = {360, 240, 180, 120, 90};
39 rgblight_config_t rgblight_config;
40 rgblight_config_t inmem_config;
42 LED_TYPE led[RGBLED_NUM];
43 uint8_t rgblight_inited = 0;
44 bool rgblight_timer_enabled = false;
46 void sethsv(uint16_t hue, uint8_t sat, uint8_t val, LED_TYPE *led1) {
47 uint8_t r = 0, g = 0, b = 0, base, color;
49 if (sat == 0) { // Acromatic color (gray). Hue doesn't mind.
54 base = ((255 - sat) * val) >> 8;
55 color = (val - base) * (hue % 60) / 60;
90 r = pgm_read_byte(&CIE1931_CURVE[r]);
91 g = pgm_read_byte(&CIE1931_CURVE[g]);
92 b = pgm_read_byte(&CIE1931_CURVE[b]);
94 setrgb(r, g, b, led1);
97 void setrgb(uint8_t r, uint8_t g, uint8_t b, LED_TYPE *led1) {
104 uint32_t eeconfig_read_rgblight(void) {
105 return eeprom_read_dword(EECONFIG_RGBLIGHT);
107 void eeconfig_update_rgblight(uint32_t val) {
108 eeprom_update_dword(EECONFIG_RGBLIGHT, val);
110 void eeconfig_update_rgblight_default(void) {
111 dprintf("eeconfig_update_rgblight_default\n");
112 rgblight_config.enable = 1;
113 rgblight_config.mode = 1;
114 rgblight_config.hue = 0;
115 rgblight_config.sat = 255;
116 rgblight_config.val = 255;
117 eeconfig_update_rgblight(rgblight_config.raw);
119 void eeconfig_debug_rgblight(void) {
120 dprintf("rgblight_config eprom\n");
121 dprintf("rgblight_config.enable = %d\n", rgblight_config.enable);
122 dprintf("rghlight_config.mode = %d\n", rgblight_config.mode);
123 dprintf("rgblight_config.hue = %d\n", rgblight_config.hue);
124 dprintf("rgblight_config.sat = %d\n", rgblight_config.sat);
125 dprintf("rgblight_config.val = %d\n", rgblight_config.val);
128 void rgblight_init(void) {
129 debug_enable = 1; // Debug ON!
130 dprintf("rgblight_init called.\n");
132 dprintf("rgblight_init start!\n");
133 if (!eeconfig_is_enabled()) {
134 dprintf("rgblight_init eeconfig is not enabled.\n");
136 eeconfig_update_rgblight_default();
138 rgblight_config.raw = eeconfig_read_rgblight();
139 if (!rgblight_config.mode) {
140 dprintf("rgblight_init rgblight_config.mode = 0. Write default values to EEPROM.\n");
141 eeconfig_update_rgblight_default();
142 rgblight_config.raw = eeconfig_read_rgblight();
144 eeconfig_debug_rgblight(); // display current eeprom values
146 #ifdef RGBLIGHT_ANIMATIONS
147 rgblight_timer_init(); // setup the timer
150 if (rgblight_config.enable) {
151 rgblight_mode(rgblight_config.mode);
155 void rgblight_update_dword(uint32_t dword) {
156 rgblight_config.raw = dword;
157 eeconfig_update_rgblight(rgblight_config.raw);
158 if (rgblight_config.enable)
159 rgblight_mode(rgblight_config.mode);
161 #ifdef RGBLIGHT_ANIMATIONS
162 rgblight_timer_disable();
168 void rgblight_increase(void) {
170 if (rgblight_config.mode < RGBLIGHT_MODES) {
171 mode = rgblight_config.mode + 1;
175 void rgblight_decrease(void) {
177 // Mode will never be < 1. If it ever is, eeprom needs to be initialized.
178 if (rgblight_config.mode > 1) {
179 mode = rgblight_config.mode - 1;
183 void rgblight_step(void) {
185 mode = rgblight_config.mode + 1;
186 if (mode > RGBLIGHT_MODES) {
191 void rgblight_step_reverse(void) {
193 mode = rgblight_config.mode - 1;
195 mode = RGBLIGHT_MODES;
200 uint32_t rgblight_get_mode(void) {
201 if (!rgblight_config.enable) {
205 return rgblight_config.mode;
208 void rgblight_mode(uint8_t mode) {
209 if (!rgblight_config.enable) {
213 rgblight_config.mode = 1;
214 } else if (mode > RGBLIGHT_MODES) {
215 rgblight_config.mode = RGBLIGHT_MODES;
217 rgblight_config.mode = mode;
219 eeconfig_update_rgblight(rgblight_config.raw);
220 xprintf("rgblight mode: %u\n", rgblight_config.mode);
221 if (rgblight_config.mode == 1) {
222 #ifdef RGBLIGHT_ANIMATIONS
223 rgblight_timer_disable();
225 } else if (rgblight_config.mode >= 2 && rgblight_config.mode <= 24) {
226 // MODE 2-5, breathing
227 // MODE 6-8, rainbow mood
228 // MODE 9-14, rainbow swirl
230 // MODE 21-23, knight
232 // MODE 25-34, static rainbow
234 #ifdef RGBLIGHT_ANIMATIONS
235 rgblight_timer_enable();
237 } else if (rgblight_config.mode >= 25 && rgblight_config.mode <= 34) {
238 // MODE 25-34, static gradient
240 #ifdef RGBLIGHT_ANIMATIONS
241 rgblight_timer_disable();
244 rgblight_sethsv(rgblight_config.hue, rgblight_config.sat, rgblight_config.val);
247 void rgblight_toggle(void) {
248 xprintf("rgblight toggle: rgblight_config.enable = %u\n", !rgblight_config.enable);
249 if (rgblight_config.enable) {
257 void rgblight_enable(void) {
258 rgblight_config.enable = 1;
259 eeconfig_update_rgblight(rgblight_config.raw);
260 xprintf("rgblight enable: rgblight_config.enable = %u\n", rgblight_config.enable);
261 rgblight_mode(rgblight_config.mode);
264 void rgblight_disable(void) {
265 rgblight_config.enable = 0;
266 eeconfig_update_rgblight(rgblight_config.raw);
267 xprintf("rgblight disable: rgblight_config.enable = %u\n", rgblight_config.enable);
268 #ifdef RGBLIGHT_ANIMATIONS
269 rgblight_timer_disable();
276 void rgblight_increase_hue(void) {
278 hue = (rgblight_config.hue+RGBLIGHT_HUE_STEP) % 360;
279 rgblight_sethsv(hue, rgblight_config.sat, rgblight_config.val);
281 void rgblight_decrease_hue(void) {
283 if (rgblight_config.hue-RGBLIGHT_HUE_STEP < 0) {
284 hue = (rgblight_config.hue + 360 - RGBLIGHT_HUE_STEP) % 360;
286 hue = (rgblight_config.hue - RGBLIGHT_HUE_STEP) % 360;
288 rgblight_sethsv(hue, rgblight_config.sat, rgblight_config.val);
290 void rgblight_increase_sat(void) {
292 if (rgblight_config.sat + RGBLIGHT_SAT_STEP > 255) {
295 sat = rgblight_config.sat + RGBLIGHT_SAT_STEP;
297 rgblight_sethsv(rgblight_config.hue, sat, rgblight_config.val);
299 void rgblight_decrease_sat(void) {
301 if (rgblight_config.sat - RGBLIGHT_SAT_STEP < 0) {
304 sat = rgblight_config.sat - RGBLIGHT_SAT_STEP;
306 rgblight_sethsv(rgblight_config.hue, sat, rgblight_config.val);
308 void rgblight_increase_val(void) {
310 if (rgblight_config.val + RGBLIGHT_VAL_STEP > 255) {
313 val = rgblight_config.val + RGBLIGHT_VAL_STEP;
315 rgblight_sethsv(rgblight_config.hue, rgblight_config.sat, val);
317 void rgblight_decrease_val(void) {
319 if (rgblight_config.val - RGBLIGHT_VAL_STEP < 0) {
322 val = rgblight_config.val - RGBLIGHT_VAL_STEP;
324 rgblight_sethsv(rgblight_config.hue, rgblight_config.sat, val);
327 void rgblight_sethsv_noeeprom(uint16_t hue, uint8_t sat, uint8_t val) {
328 inmem_config.raw = rgblight_config.raw;
329 if (rgblight_config.enable) {
331 sethsv(hue, sat, val, &tmp_led);
332 inmem_config.hue = hue;
333 inmem_config.sat = sat;
334 inmem_config.val = val;
335 // dprintf("rgblight set hue [MEMORY]: %u,%u,%u\n", inmem_config.hue, inmem_config.sat, inmem_config.val);
336 rgblight_setrgb(tmp_led.r, tmp_led.g, tmp_led.b);
339 void rgblight_sethsv(uint16_t hue, uint8_t sat, uint8_t val) {
340 if (rgblight_config.enable) {
341 if (rgblight_config.mode == 1) {
343 rgblight_sethsv_noeeprom(hue, sat, val);
345 // all LEDs in same color
346 if (rgblight_config.mode >= 2 && rgblight_config.mode <= 5) {
347 // breathing mode, ignore the change of val, use in memory value instead
348 val = rgblight_config.val;
349 } else if (rgblight_config.mode >= 6 && rgblight_config.mode <= 14) {
350 // rainbow mood and rainbow swirl, ignore the change of hue
351 hue = rgblight_config.hue;
352 } else if (rgblight_config.mode >= 25 && rgblight_config.mode <= 34) {
355 int8_t direction = ((rgblight_config.mode - 25) % 2) ? -1 : 1;
356 uint16_t range = pgm_read_word(&RGBLED_GRADIENT_RANGES[(rgblight_config.mode - 25) / 2]);
357 for (uint8_t i = 0; i < RGBLED_NUM; i++) {
358 _hue = (range / RGBLED_NUM * i * direction + hue + 360) % 360;
359 dprintf("rgblight rainbow set hsv: %u,%u,%d,%u\n", i, _hue, direction, range);
360 sethsv(_hue, sat, val, (LED_TYPE *)&led[i]);
365 rgblight_config.hue = hue;
366 rgblight_config.sat = sat;
367 rgblight_config.val = val;
368 eeconfig_update_rgblight(rgblight_config.raw);
369 xprintf("rgblight set hsv [EEPROM]: %u,%u,%u\n", rgblight_config.hue, rgblight_config.sat, rgblight_config.val);
373 uint16_t rgblight_get_hue(void) {
374 return rgblight_config.hue;
377 uint8_t rgblight_get_sat(void) {
378 return rgblight_config.sat;
381 uint8_t rgblight_get_val(void) {
382 return rgblight_config.val;
385 void rgblight_setrgb(uint8_t r, uint8_t g, uint8_t b) {
386 if (!rgblight_config.enable) { return; }
388 for (uint8_t i = 0; i < RGBLED_NUM; i++) {
396 void rgblight_setrgb_at(uint8_t r, uint8_t g, uint8_t b, uint8_t index) {
397 if (!rgblight_config.enable || index >= RGBLED_NUM) { return; }
405 void rgblight_sethsv_at(uint16_t hue, uint8_t sat, uint8_t val, uint8_t index) {
406 if (!rgblight_config.enable) { return; }
409 sethsv(hue, sat, val, &tmp_led);
410 rgblight_setrgb_at(tmp_led.r, tmp_led.g, tmp_led.b, index);
413 #ifndef RGBLIGHT_CUSTOM_DRIVER
414 void rgblight_set(void) {
415 if (rgblight_config.enable) {
417 ws2812_setleds_rgbw(led, RGBLED_NUM);
419 ws2812_setleds(led, RGBLED_NUM);
422 for (uint8_t i = 0; i < RGBLED_NUM; i++) {
428 ws2812_setleds_rgbw(led, RGBLED_NUM);
430 ws2812_setleds(led, RGBLED_NUM);
436 #ifdef RGBLIGHT_ANIMATIONS
438 // Animation timer -- AVR Timer3
439 void rgblight_timer_init(void) {
440 // static uint8_t rgblight_timer_is_init = 0;
441 // if (rgblight_timer_is_init) {
444 // rgblight_timer_is_init = 1;
445 // /* Timer 3 setup */
446 // TCCR3B = _BV(WGM32) // CTC mode OCR3A as TOP
447 // | _BV(CS30); // Clock selelct: clk/1
448 // /* Set TOP value */
449 // uint8_t sreg = SREG;
451 // OCR3AH = (RGBLED_TIMER_TOP >> 8) & 0xff;
452 // OCR3AL = RGBLED_TIMER_TOP & 0xff;
455 rgblight_timer_enabled = true;
457 void rgblight_timer_enable(void) {
458 rgblight_timer_enabled = true;
459 dprintf("TIMER3 enabled.\n");
461 void rgblight_timer_disable(void) {
462 rgblight_timer_enabled = false;
463 dprintf("TIMER3 disabled.\n");
465 void rgblight_timer_toggle(void) {
466 rgblight_timer_enabled ^= rgblight_timer_enabled;
467 dprintf("TIMER3 toggled.\n");
470 void rgblight_show_solid_color(uint8_t r, uint8_t g, uint8_t b) {
473 rgblight_setrgb(r, g, b);
476 void rgblight_task(void) {
477 if (rgblight_timer_enabled) {
478 // mode = 1, static light, do nothing here
479 if (rgblight_config.mode >= 2 && rgblight_config.mode <= 5) {
480 // mode = 2 to 5, breathing mode
481 rgblight_effect_breathing(rgblight_config.mode - 2);
482 } else if (rgblight_config.mode >= 6 && rgblight_config.mode <= 8) {
483 // mode = 6 to 8, rainbow mood mod
484 rgblight_effect_rainbow_mood(rgblight_config.mode - 6);
485 } else if (rgblight_config.mode >= 9 && rgblight_config.mode <= 14) {
486 // mode = 9 to 14, rainbow swirl mode
487 rgblight_effect_rainbow_swirl(rgblight_config.mode - 9);
488 } else if (rgblight_config.mode >= 15 && rgblight_config.mode <= 20) {
489 // mode = 15 to 20, snake mode
490 rgblight_effect_snake(rgblight_config.mode - 15);
491 } else if (rgblight_config.mode >= 21 && rgblight_config.mode <= 23) {
492 // mode = 21 to 23, knight mode
493 rgblight_effect_knight(rgblight_config.mode - 21);
494 } else if (rgblight_config.mode == 24) {
495 // mode = 24, christmas mode
496 rgblight_effect_christmas();
502 void rgblight_effect_breathing(uint8_t interval) {
503 static uint8_t pos = 0;
504 static uint16_t last_timer = 0;
507 if (timer_elapsed(last_timer) < pgm_read_byte(&RGBLED_BREATHING_INTERVALS[interval])) {
510 last_timer = timer_read();
513 // http://sean.voisen.org/blog/2011/10/breathing-led-with-arduino/
514 val = (exp(sin((pos/255.0)*M_PI)) - RGBLIGHT_EFFECT_BREATHE_CENTER/M_E)*(RGBLIGHT_EFFECT_BREATHE_MAX/(M_E-1/M_E));
515 rgblight_sethsv_noeeprom(rgblight_config.hue, rgblight_config.sat, val);
516 pos = (pos + 1) % 256;
518 void rgblight_effect_rainbow_mood(uint8_t interval) {
519 static uint16_t current_hue = 0;
520 static uint16_t last_timer = 0;
522 if (timer_elapsed(last_timer) < pgm_read_byte(&RGBLED_RAINBOW_MOOD_INTERVALS[interval])) {
525 last_timer = timer_read();
526 rgblight_sethsv_noeeprom(current_hue, rgblight_config.sat, rgblight_config.val);
527 current_hue = (current_hue + 1) % 360;
529 void rgblight_effect_rainbow_swirl(uint8_t interval) {
530 static uint16_t current_hue = 0;
531 static uint16_t last_timer = 0;
534 if (timer_elapsed(last_timer) < pgm_read_byte(&RGBLED_RAINBOW_SWIRL_INTERVALS[interval / 2])) {
537 last_timer = timer_read();
538 for (i = 0; i < RGBLED_NUM; i++) {
539 hue = (360 / RGBLED_NUM * i + current_hue) % 360;
540 sethsv(hue, rgblight_config.sat, rgblight_config.val, (LED_TYPE *)&led[i]);
545 current_hue = (current_hue + 1) % 360;
547 if (current_hue - 1 < 0) {
550 current_hue = current_hue - 1;
554 void rgblight_effect_snake(uint8_t interval) {
555 static uint8_t pos = 0;
556 static uint16_t last_timer = 0;
559 int8_t increment = 1;
563 if (timer_elapsed(last_timer) < pgm_read_byte(&RGBLED_SNAKE_INTERVALS[interval / 2])) {
566 last_timer = timer_read();
567 for (i = 0; i < RGBLED_NUM; i++) {
571 for (j = 0; j < RGBLIGHT_EFFECT_SNAKE_LENGTH; j++) {
572 k = pos + j * increment;
577 sethsv(rgblight_config.hue, rgblight_config.sat, (uint8_t)(rgblight_config.val*(RGBLIGHT_EFFECT_SNAKE_LENGTH-j)/RGBLIGHT_EFFECT_SNAKE_LENGTH), (LED_TYPE *)&led[i]);
582 if (increment == 1) {
584 pos = RGBLED_NUM - 1;
589 pos = (pos + 1) % RGBLED_NUM;
592 void rgblight_effect_knight(uint8_t interval) {
593 static uint16_t last_timer = 0;
594 if (timer_elapsed(last_timer) < pgm_read_byte(&RGBLED_KNIGHT_INTERVALS[interval])) {
597 last_timer = timer_read();
599 static int8_t low_bound = 0;
600 static int8_t high_bound = RGBLIGHT_EFFECT_KNIGHT_LENGTH - 1;
601 static int8_t increment = 1;
604 // Set all the LEDs to 0
605 for (i = 0; i < RGBLED_NUM; i++) {
610 // Determine which LEDs should be lit up
611 for (i = 0; i < RGBLIGHT_EFFECT_KNIGHT_LED_NUM; i++) {
612 cur = (i + RGBLIGHT_EFFECT_KNIGHT_OFFSET) % RGBLED_NUM;
614 if (i >= low_bound && i <= high_bound) {
615 sethsv(rgblight_config.hue, rgblight_config.sat, rgblight_config.val, (LED_TYPE *)&led[cur]);
624 // Move from low_bound to high_bound changing the direction we increment each
625 // time a boundary is hit.
626 low_bound += increment;
627 high_bound += increment;
629 if (high_bound <= 0 || low_bound >= RGBLIGHT_EFFECT_KNIGHT_LED_NUM - 1) {
630 increment = -increment;
635 void rgblight_effect_christmas(void) {
636 static uint16_t current_offset = 0;
637 static uint16_t last_timer = 0;
640 if (timer_elapsed(last_timer) < RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL) {
643 last_timer = timer_read();
644 current_offset = (current_offset + 1) % 2;
645 for (i = 0; i < RGBLED_NUM; i++) {
646 hue = 0 + ((i/RGBLIGHT_EFFECT_CHRISTMAS_STEP + current_offset) % 2) * 120;
647 sethsv(hue, rgblight_config.sat, rgblight_config.val, (LED_TYPE *)&led[i]);