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 #include "rgblight_reconfig.h"
  20
  21 #define _RGBM_SINGLE_STATIC(sym)   RGBLIGHT_MODE_ ## sym,
  22 #define _RGBM_SINGLE_DYNAMIC(sym)  RGBLIGHT_MODE_ ## sym,
  23 #define _RGBM_MULTI_STATIC(sym)    RGBLIGHT_MODE_ ## sym,
  24 #define _RGBM_MULTI_DYNAMIC(sym)   RGBLIGHT_MODE_ ## sym,
  25 #define _RGBM_TMP_STATIC(sym)      RGBLIGHT_MODE_ ## sym,
  26 #define _RGBM_TMP_DYNAMIC(sym)     RGBLIGHT_MODE_ ## sym,
  27 enum RGBLIGHT_EFFECT_MODE {
  28     RGBLIGHT_MODE_zero = 0,
  29 #include "rgblight.h"
  30     RGBLIGHT_MODE_last
  31 };
  32
  33 #ifndef RGBLIGHT_H_DUMMY_DEFINE
  34
  35 #define RGBLIGHT_MODES (RGBLIGHT_MODE_last-1)
  36
  37 #ifndef RGBLIGHT_EFFECT_BREATHE_CENTER
  38 #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85  // 1-2.7
  39 #endif
  40
  41 #ifndef RGBLIGHT_EFFECT_BREATHE_MAX
  42 #define RGBLIGHT_EFFECT_BREATHE_MAX 255   // 0-255
  43 #endif
  44
  45 #ifndef RGBLIGHT_EFFECT_SNAKE_LENGTH
  46 #define RGBLIGHT_EFFECT_SNAKE_LENGTH 4
  47 #endif
  48
  49 #ifndef RGBLIGHT_EFFECT_KNIGHT_LENGTH
  50 #define RGBLIGHT_EFFECT_KNIGHT_LENGTH 3
  51 #endif
  52
  53 #ifndef RGBLIGHT_EFFECT_KNIGHT_OFFSET
  54 #define RGBLIGHT_EFFECT_KNIGHT_OFFSET 0
  55 #endif
  56
  57 #ifndef RGBLIGHT_EFFECT_KNIGHT_LED_NUM
  58 #define RGBLIGHT_EFFECT_KNIGHT_LED_NUM RGBLED_NUM
  59 #endif
  60
  61 #ifndef RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL
  62 #define RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL 1000
  63 #endif
  64
  65 #ifndef RGBLIGHT_EFFECT_CHRISTMAS_STEP
  66 #define RGBLIGHT_EFFECT_CHRISTMAS_STEP 2
  67 #endif
  68
  69 #ifndef RGBLIGHT_HUE_STEP
  70 #define RGBLIGHT_HUE_STEP 10
  71 #endif
  72 #ifndef RGBLIGHT_SAT_STEP
  73 #define RGBLIGHT_SAT_STEP 17
  74 #endif
  75 #ifndef RGBLIGHT_VAL_STEP
  76 #define RGBLIGHT_VAL_STEP 17
  77 #endif
  78
  79 #define RGBLED_TIMER_TOP F_CPU/(256*64)
  80 // #define RGBLED_TIMER_TOP 0xFF10
  81
  82 #include <stdint.h>
  83 #include <stdbool.h>
  84 #include "eeconfig.h"
  85 #ifndef RGBLIGHT_CUSTOM_DRIVER
  86 #include "ws2812.h"
  87 #endif
  88 #include "rgblight_types.h"
  89 #include "rgblight_list.h"
  90
  91 #if defined(__AVR__)
  92     #include <avr/pgmspace.h>
  93 #endif
  94
  95 extern LED_TYPE led[RGBLED_NUM];
  96
  97 extern const uint8_t RGBLED_BREATHING_INTERVALS[4] PROGMEM;
  98 extern const uint8_t RGBLED_RAINBOW_MOOD_INTERVALS[3] PROGMEM;
  99 extern const uint8_t RGBLED_RAINBOW_SWIRL_INTERVALS[3] PROGMEM;
 100 extern const uint8_t RGBLED_SNAKE_INTERVALS[3] PROGMEM;
 101 extern const uint8_t RGBLED_KNIGHT_INTERVALS[3] PROGMEM;
 102 extern const uint16_t RGBLED_RGBTEST_INTERVALS[1] PROGMEM;
 103
 104 typedef union {
 105   uint32_t raw;
 106   struct {
 107     bool     enable  :1;
 108     uint8_t  mode    :6;
 109     uint16_t hue     :9;
 110     uint8_t  sat     :8;
 111     uint8_t  val     :8;
 112     uint8_t  speed   :8;//EECONFIG needs to be increased to support this
 113   };
 114 } rgblight_config_t;
 115
 116 void rgblight_init(void);
 117 void rgblight_increase(void);
 118 void rgblight_decrease(void);
 119 void rgblight_toggle(void);
 120 void rgblight_enable(void);
 121 void rgblight_disable(void);
 122 void rgblight_step(void);
 123 void rgblight_step_reverse(void);
 124 uint32_t rgblight_get_mode(void);
 125 void rgblight_mode(uint8_t mode);
 126 void rgblight_set(void);
 127 void rgblight_update_dword(uint32_t dword);
 128 void rgblight_increase_hue(void);
 129 void rgblight_decrease_hue(void);
 130 void rgblight_increase_sat(void);
 131 void rgblight_decrease_sat(void);
 132 void rgblight_increase_val(void);
 133 void rgblight_decrease_val(void);
 134 void rgblight_increase_speed(void);
 135 void rgblight_decrease_speed(void);
 136 void rgblight_sethsv(uint16_t hue, uint8_t sat, uint8_t val);
 137 uint16_t rgblight_get_hue(void);
 138 uint8_t rgblight_get_sat(void);
 139 uint8_t rgblight_get_val(void);
 140 void rgblight_setrgb(uint8_t r, uint8_t g, uint8_t b);
 141 void rgblight_setrgb_at(uint8_t r, uint8_t g, uint8_t b, uint8_t index);
 142 void rgblight_sethsv_at(uint16_t hue, uint8_t sat, uint8_t val, uint8_t index);
 143
 144 uint32_t eeconfig_read_rgblight(void);
 145 void eeconfig_update_rgblight(uint32_t val);
 146 void eeconfig_update_rgblight_default(void);
 147 void eeconfig_debug_rgblight(void);
 148
 149 void rgb_matrix_increase(void);
 150 void rgb_matrix_decrease(void);
 151
 152 void sethsv(uint16_t hue, uint8_t sat, uint8_t val, LED_TYPE *led1);
 153 void setrgb(uint8_t r, uint8_t g, uint8_t b, LED_TYPE *led1);
 154
 155 void rgblight_sethsv_noeeprom(uint16_t hue, uint8_t sat, uint8_t val);
 156 void rgblight_mode_noeeprom(uint8_t mode);
 157 void rgblight_toggle_noeeprom(void);
 158 void rgblight_enable_noeeprom(void);
 159 void rgblight_disable_noeeprom(void);
 160
 161 void rgblight_sethsv_eeprom_helper(uint16_t hue, uint8_t sat, uint8_t val, bool write_to_eeprom);
 162 void rgblight_mode_eeprom_helper(uint8_t mode, bool write_to_eeprom);
 163
 164
 165 #define EZ_RGB(val) rgblight_show_solid_color((val >> 16) & 0xFF, (val >> 8) & 0xFF, val & 0xFF)
 166 void rgblight_show_solid_color(uint8_t r, uint8_t g, uint8_t b);
 167
 168 void rgblight_task(void);
 169
 170 void rgblight_timer_init(void);
 171 void rgblight_timer_enable(void);
 172 void rgblight_timer_disable(void);
 173 void rgblight_timer_toggle(void);
 174 void rgblight_effect_breathing(uint8_t interval);
 175 void rgblight_effect_rainbow_mood(uint8_t interval);
 176 void rgblight_effect_rainbow_swirl(uint8_t interval);
 177 void rgblight_effect_snake(uint8_t interval);
 178 void rgblight_effect_knight(uint8_t interval);
 179 void rgblight_effect_christmas(void);
 180 void rgblight_effect_rgbtest(void);
 181 void rgblight_effect_alternating(void);
 182
 183 #endif // #ifndef RGBLIGHT_H_DUMMY_DEFINE
 184 #endif // RGBLIGHT_H
 185
 186 #ifdef _RGBM_SINGLE_STATIC
 187   _RGBM_SINGLE_STATIC( STATIC_LIGHT )
 188   #ifdef RGBLIGHT_EFFECT_BREATHING
 189     _RGBM_MULTI_DYNAMIC( BREATHING )
 190     _RGBM_TMP_DYNAMIC( breathing_3 )
 191     _RGBM_TMP_DYNAMIC( breathing_4 )
 192     _RGBM_TMP_DYNAMIC( BREATHING_end )
 193   #endif
 194   #ifdef RGBLIGHT_EFFECT_RAINBOW_MOOD
 195     _RGBM_MULTI_DYNAMIC( RAINBOW_MOOD )
 196     _RGBM_TMP_DYNAMIC( rainbow_mood_7 )
 197     _RGBM_TMP_DYNAMIC( RAINBOW_MOOD_end )
 198   #endif
 199   #ifdef RGBLIGHT_EFFECT_RAINBOW_SWIRL
 200     _RGBM_MULTI_DYNAMIC( RAINBOW_SWIRL )
 201     _RGBM_TMP_DYNAMIC( rainbow_swirl_10 )
 202     _RGBM_TMP_DYNAMIC( rainbow_swirl_11 )
 203     _RGBM_TMP_DYNAMIC( rainbow_swirl_12 )
 204     _RGBM_TMP_DYNAMIC( rainbow_swirl_13 )
 205     _RGBM_TMP_DYNAMIC( RAINBOW_SWIRL_end )
 206   #endif
 207   #ifdef RGBLIGHT_EFFECT_SNAKE
 208     _RGBM_MULTI_DYNAMIC( SNAKE )
 209     _RGBM_TMP_DYNAMIC( snake_16 )
 210     _RGBM_TMP_DYNAMIC( snake_17 )
 211     _RGBM_TMP_DYNAMIC( snake_18 )
 212     _RGBM_TMP_DYNAMIC( snake_19 )
 213     _RGBM_TMP_DYNAMIC( SNAKE_end )
 214   #endif
 215   #ifdef RGBLIGHT_EFFECT_KNIGHT
 216     _RGBM_MULTI_DYNAMIC( KNIGHT )
 217     _RGBM_TMP_DYNAMIC( knight_22 )
 218     _RGBM_TMP_DYNAMIC( KNIGHT_end )
 219   #endif
 220   #ifdef RGBLIGHT_EFFECT_CHRISTMAS
 221     _RGBM_SINGLE_DYNAMIC( CHRISTMAS )
 222   #endif
 223   #ifdef RGBLIGHT_EFFECT_STATIC_GRADIENT
 224     _RGBM_MULTI_STATIC( STATIC_GRADIENT )
 225     _RGBM_TMP_STATIC( static_gradient_26 )
 226     _RGBM_TMP_STATIC( static_gradient_27 )
 227     _RGBM_TMP_STATIC( static_gradient_28 )
 228     _RGBM_TMP_STATIC( static_gradient_29 )
 229     _RGBM_TMP_STATIC( static_gradient_30 )
 230     _RGBM_TMP_STATIC( static_gradient_31 )
 231     _RGBM_TMP_STATIC( static_gradient_32 )
 232     _RGBM_TMP_STATIC( static_gradient_33 )
 233     _RGBM_TMP_STATIC( STATIC_GRADIENT_end )
 234   #endif
 235   #ifdef RGBLIGHT_EFFECT_RGB_TEST
 236     _RGBM_SINGLE_DYNAMIC( RGB_TEST )
 237   #endif
 238   #ifdef RGBLIGHT_EFFECT_ALTERNATING
 239     _RGBM_SINGLE_DYNAMIC( ALTERNATING )
 240   #endif
 241 #endif
 242
 243 #undef _RGBM_SINGLE_STATIC
 244 #undef _RGBM_SINGLE_DYNAMIC
 245 #undef _RGBM_MULTI_STATIC
 246 #undef _RGBM_MULTI_DYNAMIC
 247 #undef _RGBM_TMP_STATIC
 248 #undef _RGBM_TMP_DYNAMIC