]> git.donarmstrong.com Git - qmk_firmware.git/blob - quantum/rgblight.c
RGBW lights
[qmk_firmware.git] / quantum / rgblight.c
1 #include <avr/eeprom.h>
2 #include <avr/interrupt.h>
3 #include <util/delay.h>
4 #include "progmem.h"
5 #include "timer.h"
6 #include "rgblight.h"
7 #include "debug.h"
8
9 const uint8_t DIM_CURVE[] PROGMEM = {
10   0, 1, 1, 2, 2, 2, 2, 2, 2, 3, 3, 3, 3, 3, 3, 3,
11   3, 3, 3, 3, 3, 3, 3, 4, 4, 4, 4, 4, 4, 4, 4, 4,
12   4, 4, 4, 5, 5, 5, 5, 5, 5, 5, 5, 5, 5, 6, 6, 6,
13   6, 6, 6, 6, 6, 7, 7, 7, 7, 7, 7, 7, 8, 8, 8, 8,
14   8, 8, 9, 9, 9, 9, 9, 9, 10, 10, 10, 10, 10, 11, 11, 11,
15   11, 11, 12, 12, 12, 12, 12, 13, 13, 13, 13, 14, 14, 14, 14, 15,
16   15, 15, 16, 16, 16, 16, 17, 17, 17, 18, 18, 18, 19, 19, 19, 20,
17   20, 20, 21, 21, 22, 22, 22, 23, 23, 24, 24, 25, 25, 25, 26, 26,
18   27, 27, 28, 28, 29, 29, 30, 30, 31, 32, 32, 33, 33, 34, 35, 35,
19   36, 36, 37, 38, 38, 39, 40, 40, 41, 42, 43, 43, 44, 45, 46, 47,
20   48, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62,
21   63, 64, 65, 66, 68, 69, 70, 71, 73, 74, 75, 76, 78, 79, 81, 82,
22   83, 85, 86, 88, 90, 91, 93, 94, 96, 98, 99, 101, 103, 105, 107, 109,
23   110, 112, 114, 116, 118, 121, 123, 125, 127, 129, 132, 134, 136, 139, 141, 144,
24   146, 149, 151, 154, 157, 159, 162, 165, 168, 171, 174, 177, 180, 183, 186, 190,
25   193, 196, 200, 203, 207, 211, 214, 218, 222, 226, 230, 234, 238, 242, 248, 255
26 };
27 const uint8_t RGBLED_BREATHING_TABLE[] PROGMEM = {
28   0, 0, 0, 0, 1, 1, 1, 2, 2, 3, 4, 5, 5, 6, 7, 9,
29   10, 11, 12, 14, 15, 17, 18, 20, 21, 23, 25, 27, 29, 31, 33, 35,
30   37, 40, 42, 44, 47, 49, 52, 54, 57, 59, 62, 65, 67, 70, 73, 76,
31   79, 82, 85, 88, 90, 93, 97, 100, 103, 106, 109, 112, 115, 118, 121, 124,
32   127, 131, 134, 137, 140, 143, 146, 149, 152, 155, 158, 162, 165, 167, 170, 173,
33   176, 179, 182, 185, 188, 190, 193, 196, 198, 201, 203, 206, 208, 211, 213, 215,
34   218, 220, 222, 224, 226, 228, 230, 232, 234, 235, 237, 238, 240, 241, 243, 244,
35   245, 246, 248, 249, 250, 250, 251, 252, 253, 253, 254, 254, 254, 255, 255, 255,
36   255, 255, 255, 255, 254, 254, 254, 253, 253, 252, 251, 250, 250, 249, 248, 246,
37   245, 244, 243, 241, 240, 238, 237, 235, 234, 232, 230, 228, 226, 224, 222, 220,
38   218, 215, 213, 211, 208, 206, 203, 201, 198, 196, 193, 190, 188, 185, 182, 179,
39   176, 173, 170, 167, 165, 162, 158, 155, 152, 149, 146, 143, 140, 137, 134, 131,
40   128, 124, 121, 118, 115, 112, 109, 106, 103, 100, 97, 93, 90, 88, 85, 82,
41   79, 76, 73, 70, 67, 65, 62, 59, 57, 54, 52, 49, 47, 44, 42, 40,
42   37, 35, 33, 31, 29, 27, 25, 23, 21, 20, 18, 17, 15, 14, 12, 11,
43   10, 9, 7, 6, 5, 5, 4, 3, 2, 2, 1, 1, 1, 0, 0, 0
44 };
45 const uint8_t RGBLED_BREATHING_INTERVALS[] PROGMEM = {30, 20, 10, 5};
46 const uint8_t RGBLED_RAINBOW_MOOD_INTERVALS[] PROGMEM = {120, 60, 30};
47 const uint8_t RGBLED_RAINBOW_SWIRL_INTERVALS[] PROGMEM = {100, 50, 20};
48 const uint8_t RGBLED_SNAKE_INTERVALS[] PROGMEM = {100, 50, 20};
49 const uint8_t RGBLED_KNIGHT_INTERVALS[] PROGMEM = {100, 50, 20};
50
51 rgblight_config_t rgblight_config;
52 rgblight_config_t inmem_config;
53 #ifdef RGBW
54   struct cRGBW led[RGBLED_NUM];
55 #else
56   struct cRGB led[RGBLED_NUM];
57 #endif
58 uint8_t rgblight_inited = 0;
59
60
61 void sethsv(uint16_t hue, uint8_t sat, uint8_t val, struct cRGB *led1) {
62   // Convert hue, saturation, and value (HSV/HSB) to RGB. DIM_CURVE is used only
63   // on value and saturation (inverted). This looks the most natural.
64   uint8_t r = 0, g = 0, b = 0, base, color;
65
66   val = pgm_read_byte(&DIM_CURVE[val]);
67   sat = 255 - pgm_read_byte(&DIM_CURVE[255 - sat]);
68
69   if (sat == 0) { // Acromatic color (gray). Hue doesn't mind.
70     r = val;
71     g = val;
72     b = val;
73   } else {
74     base = ((255 - sat) * val) >> 8;
75     color = (val - base) * (hue % 60) / 60;
76
77     switch (hue / 60) {
78       case 0:
79         r = val;
80         g = base + color;
81         b = base;
82         break;
83       case 1:
84         r = val - color;
85         g = val;
86         b = base;
87         break;
88       case 2:
89         r = base;
90         g = val;
91         b = base + color;
92         break;
93       case 3:
94         r = base;
95         g = val - color;
96         b = val;
97         break;
98       case 4:
99         r = base + color;
100         g = base;
101         b = val;
102         break;
103       case 5:
104         r = val;
105         g = base;
106         b = val - color;
107         break;
108     }
109   }
110
111   setrgb(r, g, b, led1);
112 }
113
114 void setrgb(uint8_t r, uint8_t g, uint8_t b, struct cRGB *led1) {
115   (*led1).r = r;
116   (*led1).g = g;
117   (*led1).b = b;
118 }
119
120
121 uint32_t eeconfig_read_rgblight(void) {
122   return eeprom_read_dword(EECONFIG_RGBLIGHT);
123 }
124 void eeconfig_update_rgblight(uint32_t val) {
125   eeprom_update_dword(EECONFIG_RGBLIGHT, val);
126 }
127 void eeconfig_update_rgblight_default(void) {
128   dprintf("eeconfig_update_rgblight_default\n");
129   rgblight_config.enable = 1;
130   rgblight_config.mode = 1;
131   rgblight_config.hue = 200;
132   rgblight_config.sat = 204;
133   rgblight_config.val = 204;
134   eeconfig_update_rgblight(rgblight_config.raw);
135 }
136 void eeconfig_debug_rgblight(void) {
137   dprintf("rgblight_config eprom\n");
138   dprintf("rgblight_config.enable = %d\n", rgblight_config.enable);
139   dprintf("rghlight_config.mode = %d\n", rgblight_config.mode);
140   dprintf("rgblight_config.hue = %d\n", rgblight_config.hue);
141   dprintf("rgblight_config.sat = %d\n", rgblight_config.sat);
142   dprintf("rgblight_config.val = %d\n", rgblight_config.val);
143 }
144
145 void rgblight_init(void) {
146   debug_enable = 1; // Debug ON!
147   dprintf("rgblight_init called.\n");
148   rgblight_inited = 1;
149   dprintf("rgblight_init start!\n");
150   if (!eeconfig_is_enabled()) {
151     dprintf("rgblight_init eeconfig is not enabled.\n");
152     eeconfig_init();
153     eeconfig_update_rgblight_default();
154   }
155   rgblight_config.raw = eeconfig_read_rgblight();
156   if (!rgblight_config.mode) {
157     dprintf("rgblight_init rgblight_config.mode = 0. Write default values to EEPROM.\n");
158     eeconfig_update_rgblight_default();
159     rgblight_config.raw = eeconfig_read_rgblight();
160   }
161   eeconfig_debug_rgblight(); // display current eeprom values
162
163   #if !defined(AUDIO_ENABLE) && defined(RGBLIGHT_TIMER)
164     rgblight_timer_init(); // setup the timer
165   #endif
166
167   if (rgblight_config.enable) {
168     rgblight_mode(rgblight_config.mode);
169   }
170 }
171
172 void rgblight_increase(void) {
173   uint8_t mode = 0;
174   if (rgblight_config.mode < RGBLIGHT_MODES) {
175     mode = rgblight_config.mode + 1;
176   }
177   rgblight_mode(mode);
178 }
179 void rgblight_decrease(void) {
180   uint8_t mode = 0;
181   // Mode will never be < 1. If it ever is, eeprom needs to be initialized.
182   if (rgblight_config.mode > 1) {
183     mode = rgblight_config.mode - 1;
184   }
185   rgblight_mode(mode);
186 }
187 void rgblight_step(void) {
188   uint8_t mode = 0;
189   mode = rgblight_config.mode + 1;
190   if (mode > RGBLIGHT_MODES) {
191     mode = 1;
192   }
193   rgblight_mode(mode);
194 }
195
196 void rgblight_mode(uint8_t mode) {
197   if (!rgblight_config.enable) {
198     return;
199   }
200   if (mode < 1) {
201     rgblight_config.mode = 1;
202   } else if (mode > RGBLIGHT_MODES) {
203     rgblight_config.mode = RGBLIGHT_MODES;
204   } else {
205     rgblight_config.mode = mode;
206   }
207   eeconfig_update_rgblight(rgblight_config.raw);
208   xprintf("rgblight mode: %u\n", rgblight_config.mode);
209   if (rgblight_config.mode == 1) {
210     #if !defined(AUDIO_ENABLE) && defined(RGBLIGHT_TIMER)
211       rgblight_timer_disable();
212     #endif
213   } else if (rgblight_config.mode >= 2 && rgblight_config.mode <= 23) {
214     // MODE 2-5, breathing
215     // MODE 6-8, rainbow mood
216     // MODE 9-14, rainbow swirl
217     // MODE 15-20, snake
218     // MODE 21-23, knight
219
220     #if !defined(AUDIO_ENABLE) && defined(RGBLIGHT_TIMER)
221       rgblight_timer_enable();
222     #endif
223   }
224   rgblight_sethsv(rgblight_config.hue, rgblight_config.sat, rgblight_config.val);
225 }
226
227 void rgblight_toggle(void) {
228   rgblight_config.enable ^= 1;
229   eeconfig_update_rgblight(rgblight_config.raw);
230   xprintf("rgblight toggle: rgblight_config.enable = %u\n", rgblight_config.enable);
231   if (rgblight_config.enable) {
232     rgblight_mode(rgblight_config.mode);
233   } else {
234     #if !defined(AUDIO_ENABLE) && defined(RGBLIGHT_TIMER)
235       rgblight_timer_disable();
236     #endif
237     _delay_ms(50);
238     rgblight_set();
239   }
240 }
241
242
243 void rgblight_increase_hue(void) {
244   uint16_t hue;
245   hue = (rgblight_config.hue+RGBLIGHT_HUE_STEP) % 360;
246   rgblight_sethsv(hue, rgblight_config.sat, rgblight_config.val);
247 }
248 void rgblight_decrease_hue(void) {
249   uint16_t hue;
250   if (rgblight_config.hue-RGBLIGHT_HUE_STEP < 0) {
251     hue = (rgblight_config.hue + 360 - RGBLIGHT_HUE_STEP) % 360;
252   } else {
253     hue = (rgblight_config.hue - RGBLIGHT_HUE_STEP) % 360;
254   }
255   rgblight_sethsv(hue, rgblight_config.sat, rgblight_config.val);
256 }
257 void rgblight_increase_sat(void) {
258   uint8_t sat;
259   if (rgblight_config.sat + RGBLIGHT_SAT_STEP > 255) {
260     sat = 255;
261   } else {
262     sat = rgblight_config.sat + RGBLIGHT_SAT_STEP;
263   }
264   rgblight_sethsv(rgblight_config.hue, sat, rgblight_config.val);
265 }
266 void rgblight_decrease_sat(void) {
267   uint8_t sat;
268   if (rgblight_config.sat - RGBLIGHT_SAT_STEP < 0) {
269     sat = 0;
270   } else {
271     sat = rgblight_config.sat - RGBLIGHT_SAT_STEP;
272   }
273   rgblight_sethsv(rgblight_config.hue, sat, rgblight_config.val);
274 }
275 void rgblight_increase_val(void) {
276   uint8_t val;
277   if (rgblight_config.val + RGBLIGHT_VAL_STEP > 255) {
278     val = 255;
279   } else {
280     val = rgblight_config.val + RGBLIGHT_VAL_STEP;
281   }
282   rgblight_sethsv(rgblight_config.hue, rgblight_config.sat, val);
283 }
284 void rgblight_decrease_val(void) {
285   uint8_t val;
286   if (rgblight_config.val - RGBLIGHT_VAL_STEP < 0) {
287     val = 0;
288   } else {
289     val = rgblight_config.val - RGBLIGHT_VAL_STEP;
290   }
291   rgblight_sethsv(rgblight_config.hue, rgblight_config.sat, val);
292 }
293
294 void rgblight_sethsv_noeeprom(uint16_t hue, uint8_t sat, uint8_t val) {
295   inmem_config.raw = rgblight_config.raw;
296   if (rgblight_config.enable) {
297     struct cRGB tmp_led;
298     sethsv(hue, sat, val, &tmp_led);
299     inmem_config.hue = hue;
300     inmem_config.sat = sat;
301     inmem_config.val = val;
302     // dprintf("rgblight set hue [MEMORY]: %u,%u,%u\n", inmem_config.hue, inmem_config.sat, inmem_config.val);
303     rgblight_setrgb(tmp_led.r, tmp_led.g, tmp_led.b);
304   }
305 }
306 void rgblight_sethsv(uint16_t hue, uint8_t sat, uint8_t val) {
307   if (rgblight_config.enable) {
308     if (rgblight_config.mode == 1) {
309       // same static color
310       rgblight_sethsv_noeeprom(hue, sat, val);
311     } else {
312       // all LEDs in same color
313       if (rgblight_config.mode >= 2 && rgblight_config.mode <= 5) {
314         // breathing mode, ignore the change of val, use in memory value instead
315         val = rgblight_config.val;
316       } else if (rgblight_config.mode >= 6 && rgblight_config.mode <= 14) {
317         // rainbow mood and rainbow swirl, ignore the change of hue
318         hue = rgblight_config.hue;
319       }
320     }
321     rgblight_config.hue = hue;
322     rgblight_config.sat = sat;
323     rgblight_config.val = val;
324     eeconfig_update_rgblight(rgblight_config.raw);
325     xprintf("rgblight set hsv [EEPROM]: %u,%u,%u\n", rgblight_config.hue, rgblight_config.sat, rgblight_config.val);
326   }
327 }
328
329 void rgblight_setrgb(uint8_t r, uint8_t g, uint8_t b) {
330   // dprintf("rgblight set rgb: %u,%u,%u\n", r,g,b);
331   for (uint8_t i = 0; i < RGBLED_NUM; i++) {
332     led[i].r = r;
333     led[i].g = g;
334     led[i].b = b;
335   }
336   rgblight_set();
337 }
338
339 void rgblight_set(void) {
340   if (rgblight_config.enable) {
341     #ifdef RGBW
342       ws2812_setleds_rgbw(led, RGBLED_NUM);
343     #else
344       ws2812_setleds(led, RGBLED_NUM);
345     #endif
346   } else {
347     for (uint8_t i = 0; i < RGBLED_NUM; i++) {
348       led[i].r = 0;
349       led[i].g = 0;
350       led[i].b = 0;
351     }
352     #ifdef RGBW
353       ws2812_setleds_rgbw(led, RGBLED_NUM);
354     #else
355       ws2812_setleds(led, RGBLED_NUM);
356     #endif
357   }
358 }
359
360 #if !defined(AUDIO_ENABLE) && defined(RGBLIGHT_TIMER)
361
362 // Animation timer -- AVR Timer3
363 void rgblight_timer_init(void) {
364   static uint8_t rgblight_timer_is_init = 0;
365   if (rgblight_timer_is_init) {
366     return;
367   }
368   rgblight_timer_is_init = 1;
369   /* Timer 3 setup */
370   TCCR3B = _BV(WGM32) //CTC mode OCR3A as TOP
371         | _BV(CS30); //Clock selelct: clk/1
372   /* Set TOP value */
373   uint8_t sreg = SREG;
374   cli();
375   OCR3AH = (RGBLED_TIMER_TOP >> 8) & 0xff;
376   OCR3AL = RGBLED_TIMER_TOP & 0xff;
377   SREG = sreg;
378 }
379 void rgblight_timer_enable(void) {
380   TIMSK3 |= _BV(OCIE3A);
381   dprintf("TIMER3 enabled.\n");
382 }
383 void rgblight_timer_disable(void) {
384   TIMSK3 &= ~_BV(OCIE3A);
385   dprintf("TIMER3 disabled.\n");
386 }
387 void rgblight_timer_toggle(void) {
388   TIMSK3 ^= _BV(OCIE3A);
389   dprintf("TIMER3 toggled.\n");
390 }
391
392 ISR(TIMER3_COMPA_vect) {
393   // mode = 1, static light, do nothing here
394   if (rgblight_config.mode >= 2 && rgblight_config.mode <= 5) {
395     // mode = 2 to 5, breathing mode
396     rgblight_effect_breathing(rgblight_config.mode - 2);
397   } else if (rgblight_config.mode >= 6 && rgblight_config.mode <= 8) {
398     // mode = 6 to 8, rainbow mood mod
399     rgblight_effect_rainbow_mood(rgblight_config.mode - 6);
400   } else if (rgblight_config.mode >= 9 && rgblight_config.mode <= 14) {
401     // mode = 9 to 14, rainbow swirl mode
402     rgblight_effect_rainbow_swirl(rgblight_config.mode - 9);
403   } else if (rgblight_config.mode >= 15 && rgblight_config.mode <= 20) {
404     // mode = 15 to 20, snake mode
405     rgblight_effect_snake(rgblight_config.mode - 15);
406   } else if (rgblight_config.mode >= 21 && rgblight_config.mode <= 23) {
407     // mode = 21 to 23, knight mode
408     rgblight_effect_knight(rgblight_config.mode - 21);
409   }
410 }
411
412 // Effects
413 void rgblight_effect_breathing(uint8_t interval) {
414   static uint8_t pos = 0;
415   static uint16_t last_timer = 0;
416
417   if (timer_elapsed(last_timer) < pgm_read_byte(&RGBLED_BREATHING_INTERVALS[interval])) {
418     return;
419   }
420   last_timer = timer_read();
421
422   rgblight_sethsv_noeeprom(rgblight_config.hue, rgblight_config.sat, pgm_read_byte(&RGBLED_BREATHING_TABLE[pos]));
423   pos = (pos + 1) % 256;
424 }
425 void rgblight_effect_rainbow_mood(uint8_t interval) {
426   static uint16_t current_hue = 0;
427   static uint16_t last_timer = 0;
428
429   if (timer_elapsed(last_timer) < pgm_read_byte(&RGBLED_RAINBOW_MOOD_INTERVALS[interval])) {
430     return;
431   }
432   last_timer = timer_read();
433   rgblight_sethsv_noeeprom(current_hue, rgblight_config.sat, rgblight_config.val);
434   current_hue = (current_hue + 1) % 360;
435 }
436 void rgblight_effect_rainbow_swirl(uint8_t interval) {
437   static uint16_t current_hue = 0;
438   static uint16_t last_timer = 0;
439   uint16_t hue;
440   uint8_t i;
441   if (timer_elapsed(last_timer) < pgm_read_byte(&RGBLED_RAINBOW_MOOD_INTERVALS[interval / 2])) {
442     return;
443   }
444   last_timer = timer_read();
445   for (i = 0; i < RGBLED_NUM; i++) {
446     hue = (360 / RGBLED_NUM * i + current_hue) % 360;
447     sethsv(hue, rgblight_config.sat, rgblight_config.val, &led[i]);
448   }
449   rgblight_set();
450
451   if (interval % 2) {
452     current_hue = (current_hue + 1) % 360;
453   } else {
454     if (current_hue - 1 < 0) {
455       current_hue = 359;
456     } else {
457       current_hue = current_hue - 1;
458     }
459   }
460 }
461 void rgblight_effect_snake(uint8_t interval) {
462   static uint8_t pos = 0;
463   static uint16_t last_timer = 0;
464   uint8_t i, j;
465   int8_t k;
466   int8_t increment = 1;
467   if (interval % 2) {
468     increment = -1;
469   }
470   if (timer_elapsed(last_timer) < pgm_read_byte(&RGBLED_SNAKE_INTERVALS[interval / 2])) {
471     return;
472   }
473   last_timer = timer_read();
474   for (i = 0; i < RGBLED_NUM; i++) {
475     led[i].r = 0;
476     led[i].g = 0;
477     led[i].b = 0;
478     for (j = 0; j < RGBLIGHT_EFFECT_SNAKE_LENGTH; j++) {
479       k = pos + j * increment;
480       if (k < 0) {
481         k = k + RGBLED_NUM;
482       }
483       if (i == k) {
484         sethsv(rgblight_config.hue, rgblight_config.sat, (uint8_t)(rgblight_config.val*(RGBLIGHT_EFFECT_SNAKE_LENGTH-j)/RGBLIGHT_EFFECT_SNAKE_LENGTH), &led[i]);
485       }
486     }
487   }
488   rgblight_set();
489   if (increment == 1) {
490     if (pos - 1 < 0) {
491       pos = RGBLED_NUM - 1;
492     } else {
493       pos -= 1;
494     }
495   } else {
496     pos = (pos + 1) % RGBLED_NUM;
497   }
498 }
499 void rgblight_effect_knight(uint8_t interval) {
500   static int8_t pos = 0;
501   static uint16_t last_timer = 0;
502   uint8_t i, j, cur;
503   int8_t k;
504   struct cRGB preled[RGBLED_NUM];
505   static int8_t increment = -1;
506   if (timer_elapsed(last_timer) < pgm_read_byte(&RGBLED_KNIGHT_INTERVALS[interval])) {
507     return;
508   }
509   last_timer = timer_read();
510   for (i = 0; i < RGBLED_NUM; i++) {
511     preled[i].r = 0;
512     preled[i].g = 0;
513     preled[i].b = 0;
514     for (j = 0; j < RGBLIGHT_EFFECT_KNIGHT_LENGTH; j++) {
515       k = pos + j * increment;
516       if (k < 0) {
517         k = 0;
518       }
519       if (k >= RGBLED_NUM) {
520         k = RGBLED_NUM - 1;
521       }
522       if (i == k) {
523         sethsv(rgblight_config.hue, rgblight_config.sat, rgblight_config.val, &preled[i]);
524       }
525     }
526   }
527   if (RGBLIGHT_EFFECT_KNIGHT_OFFSET) {
528     for (i = 0; i < RGBLED_NUM; i++) {
529       cur = (i + RGBLIGHT_EFFECT_KNIGHT_OFFSET) % RGBLED_NUM;
530       led[i].r = preled[cur].r;
531       led[i].g = preled[cur].g;
532       led[i].b = preled[cur].b;
533     }
534   }
535   rgblight_set();
536   if (increment == 1) {
537     if (pos - 1 < 0 - RGBLIGHT_EFFECT_KNIGHT_LENGTH) {
538       pos = 0 - RGBLIGHT_EFFECT_KNIGHT_LENGTH;
539       increment = -1;
540     } else {
541       pos -= 1;
542     }
543   } else {
544     if (pos + 1 > RGBLED_NUM + RGBLIGHT_EFFECT_KNIGHT_LENGTH) {
545       pos = RGBLED_NUM + RGBLIGHT_EFFECT_KNIGHT_LENGTH - 1;
546       increment = 1;
547     } else {
548       pos += 1;
549     }
550   }
551 }
552
553 #endif