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 /***** rgblight_mode(mode)/rgblight_mode_noeeprom(mode) ****
  22
  23  old mode number (before 0.6.117) to new mode name table
  24
  25 |-----------------|-----------------------------------|
  26 | old mode number | new mode name                     |
  27 |-----------------|-----------------------------------|
  28 |        1        | RGBLIGHT_MODE_STATIC_LIGHT        |
  29 |        2        | RGBLIGHT_MODE_BREATHING           |
  30 |        3        | RGBLIGHT_MODE_BREATHING + 1       |
  31 |        4        | RGBLIGHT_MODE_BREATHING + 2       |
  32 |        5        | RGBLIGHT_MODE_BREATHING + 3       |
  33 |        6        | RGBLIGHT_MODE_RAINBOW_MOOD        |
  34 |        7        | RGBLIGHT_MODE_RAINBOW_MOOD + 1    |
  35 |        8        | RGBLIGHT_MODE_RAINBOW_MOOD + 2    |
  36 |        9        | RGBLIGHT_MODE_RAINBOW_SWIRL       |
  37 |       10        | RGBLIGHT_MODE_RAINBOW_SWIRL + 1   |
  38 |       11        | RGBLIGHT_MODE_RAINBOW_SWIRL + 2   |
  39 |       12        | RGBLIGHT_MODE_RAINBOW_SWIRL + 3   |
  40 |       13        | RGBLIGHT_MODE_RAINBOW_SWIRL + 4   |
  41 |       14        | RGBLIGHT_MODE_RAINBOW_SWIRL + 5   |
  42 |       15        | RGBLIGHT_MODE_SNAKE               |
  43 |       16        | RGBLIGHT_MODE_SNAKE + 1           |
  44 |       17        | RGBLIGHT_MODE_SNAKE + 2           |
  45 |       18        | RGBLIGHT_MODE_SNAKE + 3           |
  46 |       19        | RGBLIGHT_MODE_SNAKE + 4           |
  47 |       20        | RGBLIGHT_MODE_SNAKE + 5           |
  48 |       21        | RGBLIGHT_MODE_KNIGHT              |
  49 |       22        | RGBLIGHT_MODE_KNIGHT + 1          |
  50 |       23        | RGBLIGHT_MODE_KNIGHT + 2          |
  51 |       24        | RGBLIGHT_MODE_CHRISTMAS           |
  52 |       25        | RGBLIGHT_MODE_STATIC_GRADIENT     |
  53 |       26        | RGBLIGHT_MODE_STATIC_GRADIENT + 1 |
  54 |       27        | RGBLIGHT_MODE_STATIC_GRADIENT + 2 |
  55 |       28        | RGBLIGHT_MODE_STATIC_GRADIENT + 3 |
  56 |       29        | RGBLIGHT_MODE_STATIC_GRADIENT + 4 |
  57 |       30        | RGBLIGHT_MODE_STATIC_GRADIENT + 5 |
  58 |       31        | RGBLIGHT_MODE_STATIC_GRADIENT + 6 |
  59 |       32        | RGBLIGHT_MODE_STATIC_GRADIENT + 7 |
  60 |       33        | RGBLIGHT_MODE_STATIC_GRADIENT + 8 |
  61 |       34        | RGBLIGHT_MODE_STATIC_GRADIENT + 9 |
  62 |       35        | RGBLIGHT_MODE_RGB_TEST            |
  63 |       36        | RGBLIGHT_MODE_ALTERNATING         |
  64 |-----------------|-----------------------------------|
  65  *****/
  66
  67 #define _RGBM_SINGLE_STATIC(sym)   RGBLIGHT_MODE_ ## sym,
  68 #define _RGBM_SINGLE_DYNAMIC(sym)  RGBLIGHT_MODE_ ## sym,
  69 #define _RGBM_MULTI_STATIC(sym)    RGBLIGHT_MODE_ ## sym,
  70 #define _RGBM_MULTI_DYNAMIC(sym)   RGBLIGHT_MODE_ ## sym,
  71 #define _RGBM_TMP_STATIC(sym)      RGBLIGHT_MODE_ ## sym,
  72 #define _RGBM_TMP_DYNAMIC(sym)     RGBLIGHT_MODE_ ## sym,
  73 enum RGBLIGHT_EFFECT_MODE {
  74     RGBLIGHT_MODE_zero = 0,
  75 #include "rgblight.h"
  76     RGBLIGHT_MODE_last
  77 };
  78
  79 #ifndef RGBLIGHT_H_DUMMY_DEFINE
  80
  81 #define RGBLIGHT_MODES (RGBLIGHT_MODE_last-1)
  82
  83 #ifndef RGBLIGHT_EFFECT_BREATHE_CENTER
  84 #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85  // 1-2.7
  85 #endif
  86
  87 #ifndef RGBLIGHT_EFFECT_BREATHE_MAX
  88 #define RGBLIGHT_EFFECT_BREATHE_MAX 255   // 0-255
  89 #endif
  90
  91 #ifndef RGBLIGHT_EFFECT_SNAKE_LENGTH
  92 #define RGBLIGHT_EFFECT_SNAKE_LENGTH 4
  93 #endif
  94
  95 #ifndef RGBLIGHT_EFFECT_KNIGHT_LENGTH
  96 #define RGBLIGHT_EFFECT_KNIGHT_LENGTH 3
  97 #endif
  98
  99 #ifndef RGBLIGHT_EFFECT_KNIGHT_OFFSET
 100 #define RGBLIGHT_EFFECT_KNIGHT_OFFSET 0
 101 #endif
 102
 103 #ifndef RGBLIGHT_EFFECT_KNIGHT_LED_NUM
 104 #define RGBLIGHT_EFFECT_KNIGHT_LED_NUM RGBLED_NUM
 105 #endif
 106
 107 #ifndef RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL
 108 #define RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL 1000
 109 #endif
 110
 111 #ifndef RGBLIGHT_EFFECT_CHRISTMAS_STEP
 112 #define RGBLIGHT_EFFECT_CHRISTMAS_STEP 2
 113 #endif
 114
 115 #ifndef RGBLIGHT_HUE_STEP
 116 #define RGBLIGHT_HUE_STEP 10
 117 #endif
 118 #ifndef RGBLIGHT_SAT_STEP
 119 #define RGBLIGHT_SAT_STEP 17
 120 #endif
 121 #ifndef RGBLIGHT_VAL_STEP
 122 #define RGBLIGHT_VAL_STEP 17
 123 #endif
 124 #ifndef RGBLIGHT_LIMIT_VAL
 125 #define RGBLIGHT_LIMIT_VAL 255
 126 #endif
 127
 128 #define RGBLED_TIMER_TOP F_CPU/(256*64)
 129 // #define RGBLED_TIMER_TOP 0xFF10
 130
 131 #include <stdint.h>
 132 #include <stdbool.h>
 133 #include "eeconfig.h"
 134 #ifndef RGBLIGHT_CUSTOM_DRIVER
 135 #include "ws2812.h"
 136 #endif
 137 #include "rgblight_types.h"
 138 #include "rgblight_list.h"
 139
 140 #if defined(__AVR__)
 141     #include <avr/pgmspace.h>
 142 #endif
 143
 144 extern LED_TYPE led[RGBLED_NUM];
 145
 146 extern const uint8_t RGBLED_BREATHING_INTERVALS[4] PROGMEM;
 147 extern const uint8_t RGBLED_RAINBOW_MOOD_INTERVALS[3] PROGMEM;
 148 extern const uint8_t RGBLED_RAINBOW_SWIRL_INTERVALS[3] PROGMEM;
 149 extern const uint8_t RGBLED_SNAKE_INTERVALS[3] PROGMEM;
 150 extern const uint8_t RGBLED_KNIGHT_INTERVALS[3] PROGMEM;
 151 extern const uint16_t RGBLED_RGBTEST_INTERVALS[1] PROGMEM;
 152 extern bool is_rgblight_initialized;
 153
 154 typedef union {
 155   uint32_t raw;
 156   struct {
 157     bool     enable  :1;
 158     uint8_t  mode    :6;
 159     uint16_t hue     :9;
 160     uint8_t  sat     :8;
 161     uint8_t  val     :8;
 162     uint8_t  speed   :8;//EECONFIG needs to be increased to support this
 163   };
 164 } rgblight_config_t;
 165
 166 void rgblight_init(void);
 167 void rgblight_increase(void);
 168 void rgblight_decrease(void);
 169 void rgblight_toggle(void);
 170 void rgblight_enable(void);
 171 void rgblight_disable(void);
 172 void rgblight_step(void);
 173 void rgblight_step_reverse(void);
 174 uint8_t rgblight_get_mode(void);
 175 void rgblight_mode(uint8_t mode);
 176 void rgblight_set(void);
 177 uint32_t rgblight_read_dword(void);
 178 void rgblight_update_dword(uint32_t dword);
 179 void rgblight_increase_hue(void);
 180 void rgblight_decrease_hue(void);
 181 void rgblight_increase_sat(void);
 182 void rgblight_decrease_sat(void);
 183 void rgblight_increase_val(void);
 184 void rgblight_decrease_val(void);
 185 void rgblight_increase_speed(void);
 186 void rgblight_decrease_speed(void);
 187 void rgblight_sethsv(uint16_t hue, uint8_t sat, uint8_t val);
 188 uint16_t rgblight_get_hue(void);
 189 uint8_t rgblight_get_sat(void);
 190 uint8_t rgblight_get_val(void);
 191 void rgblight_setrgb(uint8_t r, uint8_t g, uint8_t b);
 192 void rgblight_setrgb_at(uint8_t r, uint8_t g, uint8_t b, uint8_t index);
 193 void rgblight_sethsv_at(uint16_t hue, uint8_t sat, uint8_t val, uint8_t index);
 194 void rgblight_setrgb_range(uint8_t r, uint8_t g, uint8_t b, uint8_t start, uint8_t end);
 195 void rgblight_sethsv_range(uint16_t hue, uint8_t sat, uint8_t val, uint8_t start, uint8_t end);
 196 void rgblight_setrgb_master(uint8_t r, uint8_t g, uint8_t b);
 197 void rgblight_setrgb_slave(uint8_t r, uint8_t g, uint8_t b);
 198 void rgblight_sethsv_master(uint16_t hue, uint8_t sat, uint8_t val);
 199 void rgblight_sethsv_slave(uint16_t hue, uint8_t sat, uint8_t val);
 200 void rgblight_set_clipping_range(uint8_t start_pos, uint8_t num_leds);
 201
 202 uint32_t eeconfig_read_rgblight(void);
 203 void eeconfig_update_rgblight(uint32_t val);
 204 void eeconfig_update_rgblight_default(void);
 205 void eeconfig_debug_rgblight(void);
 206
 207 void rgb_matrix_increase(void);
 208 void rgb_matrix_decrease(void);
 209
 210 void sethsv(uint16_t hue, uint8_t sat, uint8_t val, LED_TYPE *led1);
 211 void setrgb(uint8_t r, uint8_t g, uint8_t b, LED_TYPE *led1);
 212
 213 void rgblight_sethsv_noeeprom(uint16_t hue, uint8_t sat, uint8_t val);
 214 void rgblight_mode_noeeprom(uint8_t mode);
 215 void rgblight_toggle_noeeprom(void);
 216 void rgblight_enable_noeeprom(void);
 217 void rgblight_disable_noeeprom(void);
 218 void rgblight_step_noeeprom(void);
 219 void rgblight_step_reverse_noeeprom(void);
 220 void rgblight_increase_hue_noeeprom(void);
 221 void rgblight_decrease_hue_noeeprom(void);
 222 void rgblight_increase_sat_noeeprom(void);
 223 void rgblight_decrease_sat_noeeprom(void);
 224 void rgblight_increase_val_noeeprom(void);
 225 void rgblight_decrease_val_noeeprom(void);
 226
 227 void rgblight_sethsv_eeprom_helper(uint16_t hue, uint8_t sat, uint8_t val, bool write_to_eeprom);
 228 void rgblight_mode_eeprom_helper(uint8_t mode, bool write_to_eeprom);
 229
 230
 231 #define EZ_RGB(val) rgblight_show_solid_color((val >> 16) & 0xFF, (val >> 8) & 0xFF, val & 0xFF)
 232 void rgblight_show_solid_color(uint8_t r, uint8_t g, uint8_t b);
 233
 234 void rgblight_task(void);
 235
 236 void rgblight_timer_init(void);
 237 void rgblight_timer_enable(void);
 238 void rgblight_timer_disable(void);
 239 void rgblight_timer_toggle(void);
 240 void rgblight_effect_breathing(uint8_t interval);
 241 void rgblight_effect_rainbow_mood(uint8_t interval);
 242 void rgblight_effect_rainbow_swirl(uint8_t interval);
 243 void rgblight_effect_snake(uint8_t interval);
 244 void rgblight_effect_knight(uint8_t interval);
 245 void rgblight_effect_christmas(void);
 246 void rgblight_effect_rgbtest(void);
 247 void rgblight_effect_alternating(void);
 248
 249 #endif // #ifndef RGBLIGHT_H_DUMMY_DEFINE
 250 #endif // RGBLIGHT_H
 251
 252 #ifdef _RGBM_SINGLE_STATIC
 253   _RGBM_SINGLE_STATIC( STATIC_LIGHT )
 254   #ifdef RGBLIGHT_EFFECT_BREATHING
 255     _RGBM_MULTI_DYNAMIC( BREATHING )
 256     _RGBM_TMP_DYNAMIC( breathing_3 )
 257     _RGBM_TMP_DYNAMIC( breathing_4 )
 258     _RGBM_TMP_DYNAMIC( BREATHING_end )
 259   #endif
 260   #ifdef RGBLIGHT_EFFECT_RAINBOW_MOOD
 261     _RGBM_MULTI_DYNAMIC( RAINBOW_MOOD )
 262     _RGBM_TMP_DYNAMIC( rainbow_mood_7 )
 263     _RGBM_TMP_DYNAMIC( RAINBOW_MOOD_end )
 264   #endif
 265   #ifdef RGBLIGHT_EFFECT_RAINBOW_SWIRL
 266     _RGBM_MULTI_DYNAMIC( RAINBOW_SWIRL )
 267     _RGBM_TMP_DYNAMIC( rainbow_swirl_10 )
 268     _RGBM_TMP_DYNAMIC( rainbow_swirl_11 )
 269     _RGBM_TMP_DYNAMIC( rainbow_swirl_12 )
 270     _RGBM_TMP_DYNAMIC( rainbow_swirl_13 )
 271     _RGBM_TMP_DYNAMIC( RAINBOW_SWIRL_end )
 272   #endif
 273   #ifdef RGBLIGHT_EFFECT_SNAKE
 274     _RGBM_MULTI_DYNAMIC( SNAKE )
 275     _RGBM_TMP_DYNAMIC( snake_16 )
 276     _RGBM_TMP_DYNAMIC( snake_17 )
 277     _RGBM_TMP_DYNAMIC( snake_18 )
 278     _RGBM_TMP_DYNAMIC( snake_19 )
 279     _RGBM_TMP_DYNAMIC( SNAKE_end )
 280   #endif
 281   #ifdef RGBLIGHT_EFFECT_KNIGHT
 282     _RGBM_MULTI_DYNAMIC( KNIGHT )
 283     _RGBM_TMP_DYNAMIC( knight_22 )
 284     _RGBM_TMP_DYNAMIC( KNIGHT_end )
 285   #endif
 286   #ifdef RGBLIGHT_EFFECT_CHRISTMAS
 287     _RGBM_SINGLE_DYNAMIC( CHRISTMAS )
 288   #endif
 289   #ifdef RGBLIGHT_EFFECT_STATIC_GRADIENT
 290     _RGBM_MULTI_STATIC( STATIC_GRADIENT )
 291     _RGBM_TMP_STATIC( static_gradient_26 )
 292     _RGBM_TMP_STATIC( static_gradient_27 )
 293     _RGBM_TMP_STATIC( static_gradient_28 )
 294     _RGBM_TMP_STATIC( static_gradient_29 )
 295     _RGBM_TMP_STATIC( static_gradient_30 )
 296     _RGBM_TMP_STATIC( static_gradient_31 )
 297     _RGBM_TMP_STATIC( static_gradient_32 )
 298     _RGBM_TMP_STATIC( static_gradient_33 )
 299     _RGBM_TMP_STATIC( STATIC_GRADIENT_end )
 300   #endif
 301   #ifdef RGBLIGHT_EFFECT_RGB_TEST
 302     _RGBM_SINGLE_DYNAMIC( RGB_TEST )
 303   #endif
 304   #ifdef RGBLIGHT_EFFECT_ALTERNATING
 305     _RGBM_SINGLE_DYNAMIC( ALTERNATING )
 306   #endif
 307   ////  Add a new mode here.
 308   // #ifdef RGBLIGHT_EFFECT_<name>
 309   //    _RGBM_<SINGLE|MULTI>_<STATIC|DYNAMIC>( <name> )
 310   // #endif
 311 #endif
 312
 313 #undef _RGBM_SINGLE_STATIC
 314 #undef _RGBM_SINGLE_DYNAMIC
 315 #undef _RGBM_MULTI_STATIC
 316 #undef _RGBM_MULTI_DYNAMIC
 317 #undef _RGBM_TMP_STATIC
 318 #undef _RGBM_TMP_DYNAMIC