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