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