quantum/rgblight.h

   1 /* Copyright 2017 Yang Liu
   2  *
   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.
   7  *
   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.
  12  *
  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/>.
  15  */
  16 #ifndef RGBLIGHT_H
  17 #define RGBLIGHT_H
  18
  19 #ifdef RGBLIGHT_ANIMATIONS
  20         #define RGBLIGHT_MODES 34
  21 #else
  22         #define RGBLIGHT_MODES 1
  23 #endif
  24
  25 #ifndef RGBLIGHT_EFFECT_SNAKE_LENGTH
  26 #define RGBLIGHT_EFFECT_SNAKE_LENGTH 7
  27 #endif
  28
  29 #ifndef RGBLIGHT_EFFECT_KNIGHT_LENGTH
  30 #define RGBLIGHT_EFFECT_KNIGHT_LENGTH 7
  31 #endif
  32 #ifndef RGBLIGHT_EFFECT_KNIGHT_OFFSET
  33 #define RGBLIGHT_EFFECT_KNIGHT_OFFSET 9
  34 #endif
  35
  36 #ifndef RGBLIGHT_EFFECT_DUALKNIGHT_LENGTH
  37 #define RGBLIGHT_EFFECT_DUALKNIGHT_LENGTH 4
  38 #endif
  39
  40 #ifndef RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL
  41 #define RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL 1000
  42 #endif
  43
  44 #ifndef RGBLIGHT_EFFECT_CHRISTMAS_STEP
  45 #define RGBLIGHT_EFFECT_CHRISTMAS_STEP 2
  46 #endif
  47
  48 #ifndef RGBLIGHT_HUE_STEP
  49 #define RGBLIGHT_HUE_STEP 10
  50 #endif
  51 #ifndef RGBLIGHT_SAT_STEP
  52 #define RGBLIGHT_SAT_STEP 17
  53 #endif
  54 #ifndef RGBLIGHT_VAL_STEP
  55 #define RGBLIGHT_VAL_STEP 17
  56 #endif
  57
  58 #define RGBLED_TIMER_TOP F_CPU/(256*64)
  59 // #define RGBLED_TIMER_TOP 0xFF10
  60
  61 #include <stdint.h>
  62 #include <stdbool.h>
  63 #include "eeconfig.h"
  64 #include "light_ws2812.h"
  65
  66 extern LED_TYPE led[RGBLED_NUM];
  67
  68 extern const uint8_t RGBLED_BREATHING_INTERVALS[4] PROGMEM;
  69 extern const uint8_t RGBLED_RAINBOW_MOOD_INTERVALS[3] PROGMEM;
  70 extern const uint8_t RGBLED_RAINBOW_SWIRL_INTERVALS[3] PROGMEM;
  71 extern const uint8_t RGBLED_SNAKE_INTERVALS[3] PROGMEM;
  72 extern const uint8_t RGBLED_KNIGHT_INTERVALS[3] PROGMEM;
  73
  74 typedef union {
  75   uint32_t raw;
  76   struct {
  77     bool     enable  :1;
  78     uint8_t  mode    :6;
  79     uint16_t hue     :9;
  80     uint8_t  sat     :8;
  81     uint8_t  val     :8;
  82   };
  83 } rgblight_config_t;
  84
  85 void rgblight_init(void);
  86 void rgblight_increase(void);
  87 void rgblight_decrease(void);
  88 void rgblight_toggle(void);
  89 void rgblight_enable(void);
  90 void rgblight_step(void);
  91 void rgblight_step_reverse(void);
  92 void rgblight_mode(uint8_t mode);
  93 void rgblight_set(void);
  94 void rgblight_update_dword(uint32_t dword);
  95 void rgblight_increase_hue(void);
  96 void rgblight_decrease_hue(void);
  97 void rgblight_increase_sat(void);
  98 void rgblight_decrease_sat(void);
  99 void rgblight_increase_val(void);
 100 void rgblight_decrease_val(void);
 101 void rgblight_sethsv(uint16_t hue, uint8_t sat, uint8_t val);
 102 void rgblight_setrgb(uint8_t r, uint8_t g, uint8_t b);
 103
 104 uint32_t eeconfig_read_rgblight(void);
 105 void eeconfig_update_rgblight(uint32_t val);
 106 void eeconfig_update_rgblight_default(void);
 107 void eeconfig_debug_rgblight(void);
 108
 109 void sethsv(uint16_t hue, uint8_t sat, uint8_t val, LED_TYPE *led1);
 110 void setrgb(uint8_t r, uint8_t g, uint8_t b, LED_TYPE *led1);
 111 void rgblight_sethsv_noeeprom(uint16_t hue, uint8_t sat, uint8_t val);
 112
 113 #define EZ_RGB(val) rgblight_show_solid_color((val >> 16) & 0xFF, (val >> 8) & 0xFF, val & 0xFF)
 114 void rgblight_show_solid_color(uint8_t r, uint8_t g, uint8_t b);
 115
 116 void rgblight_task(void);
 117
 118 void rgblight_timer_init(void);
 119 void rgblight_timer_enable(void);
 120 void rgblight_timer_disable(void);
 121 void rgblight_timer_toggle(void);
 122 void rgblight_effect_breathing(uint8_t interval);
 123 void rgblight_effect_rainbow_mood(uint8_t interval);
 124 void rgblight_effect_rainbow_swirl(uint8_t interval);
 125 void rgblight_effect_snake(uint8_t interval);
 126 void rgblight_effect_knight(uint8_t interval);
 127 void rgblight_effect_christmas(void);
 128
 129 #endif