]> git.donarmstrong.com Git - qmk_firmware.git/blob - quantum/rgblight.h
Improve RGB lighting documentation (#3580)
[qmk_firmware.git] / 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 36
21 #else
22         #define RGBLIGHT_MODES 1
23 #endif
24
25 #ifndef RGBLIGHT_EFFECT_BREATHE_CENTER
26 #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85  // 1-2.7
27 #endif
28
29 #ifndef RGBLIGHT_EFFECT_BREATHE_MAX
30 #define RGBLIGHT_EFFECT_BREATHE_MAX 255   // 0-255
31 #endif
32
33 #ifndef RGBLIGHT_EFFECT_SNAKE_LENGTH
34 #define RGBLIGHT_EFFECT_SNAKE_LENGTH 4
35 #endif
36
37 #ifndef RGBLIGHT_EFFECT_KNIGHT_LENGTH
38 #define RGBLIGHT_EFFECT_KNIGHT_LENGTH 3
39 #endif
40
41 #ifndef RGBLIGHT_EFFECT_KNIGHT_OFFSET
42 #define RGBLIGHT_EFFECT_KNIGHT_OFFSET 0
43 #endif
44
45 #ifndef RGBLIGHT_EFFECT_KNIGHT_LED_NUM
46 #define RGBLIGHT_EFFECT_KNIGHT_LED_NUM RGBLED_NUM
47 #endif
48
49 #ifndef RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL
50 #define RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL 1000
51 #endif
52
53 #ifndef RGBLIGHT_EFFECT_CHRISTMAS_STEP
54 #define RGBLIGHT_EFFECT_CHRISTMAS_STEP 2
55 #endif
56
57 #ifndef RGBLIGHT_HUE_STEP
58 #define RGBLIGHT_HUE_STEP 10
59 #endif
60 #ifndef RGBLIGHT_SAT_STEP
61 #define RGBLIGHT_SAT_STEP 17
62 #endif
63 #ifndef RGBLIGHT_VAL_STEP
64 #define RGBLIGHT_VAL_STEP 17
65 #endif
66
67 #define RGBLED_TIMER_TOP F_CPU/(256*64)
68 // #define RGBLED_TIMER_TOP 0xFF10
69
70 #include <stdint.h>
71 #include <stdbool.h>
72 #include "eeconfig.h"
73 #ifndef RGBLIGHT_CUSTOM_DRIVER
74 #include "ws2812.h"
75 #endif
76 #include "rgblight_types.h"
77 #include "rgblight_list.h"
78
79 #if defined(__AVR__)
80     #include <avr/pgmspace.h>
81 #endif
82
83 extern LED_TYPE led[RGBLED_NUM];
84
85 extern const uint8_t RGBLED_BREATHING_INTERVALS[4] PROGMEM;
86 extern const uint8_t RGBLED_RAINBOW_MOOD_INTERVALS[3] PROGMEM;
87 extern const uint8_t RGBLED_RAINBOW_SWIRL_INTERVALS[3] PROGMEM;
88 extern const uint8_t RGBLED_SNAKE_INTERVALS[3] PROGMEM;
89 extern const uint8_t RGBLED_KNIGHT_INTERVALS[3] PROGMEM;
90 extern const uint16_t RGBLED_RGBTEST_INTERVALS[1] PROGMEM;
91
92 typedef union {
93   uint32_t raw;
94   struct {
95     bool     enable  :1;
96     uint8_t  mode    :6;
97     uint16_t hue     :9;
98     uint8_t  sat     :8;
99     uint8_t  val     :8;
100     uint8_t  speed   :8;//EECONFIG needs to be increased to support this
101   };
102 } rgblight_config_t;
103
104 void rgblight_init(void);
105 void rgblight_increase(void);
106 void rgblight_decrease(void);
107 void rgblight_toggle(void);
108 void rgblight_enable(void);
109 void rgblight_disable(void);
110 void rgblight_step(void);
111 void rgblight_step_reverse(void);
112 uint32_t rgblight_get_mode(void);
113 void rgblight_mode(uint8_t mode);
114 void rgblight_set(void);
115 void rgblight_update_dword(uint32_t dword);
116 void rgblight_increase_hue(void);
117 void rgblight_decrease_hue(void);
118 void rgblight_increase_sat(void);
119 void rgblight_decrease_sat(void);
120 void rgblight_increase_val(void);
121 void rgblight_decrease_val(void);
122 void rgblight_increase_speed(void);
123 void rgblight_decrease_speed(void);
124 void rgblight_sethsv(uint16_t hue, uint8_t sat, uint8_t val);
125 uint16_t rgblight_get_hue(void);
126 uint8_t rgblight_get_sat(void);
127 uint8_t rgblight_get_val(void);
128 void rgblight_setrgb(uint8_t r, uint8_t g, uint8_t b);
129 void rgblight_setrgb_at(uint8_t r, uint8_t g, uint8_t b, uint8_t index);
130 void rgblight_sethsv_at(uint16_t hue, uint8_t sat, uint8_t val, uint8_t index);
131
132 uint32_t eeconfig_read_rgblight(void);
133 void eeconfig_update_rgblight(uint32_t val);
134 void eeconfig_update_rgblight_default(void);
135 void eeconfig_debug_rgblight(void);
136
137 void rgb_matrix_increase(void);
138 void rgb_matrix_decrease(void);
139
140 void sethsv(uint16_t hue, uint8_t sat, uint8_t val, LED_TYPE *led1);
141 void setrgb(uint8_t r, uint8_t g, uint8_t b, LED_TYPE *led1);
142
143 void rgblight_sethsv_noeeprom(uint16_t hue, uint8_t sat, uint8_t val);
144 void rgblight_mode_noeeprom(uint8_t mode);
145 void rgblight_toggle_noeeprom(void);
146 void rgblight_enable_noeeprom(void);
147 void rgblight_disable_noeeprom(void);
148
149 void rgblight_sethsv_eeprom_helper(uint16_t hue, uint8_t sat, uint8_t val, bool write_to_eeprom);
150 void rgblight_mode_eeprom_helper(uint8_t mode, bool write_to_eeprom);
151
152
153 #define EZ_RGB(val) rgblight_show_solid_color((val >> 16) & 0xFF, (val >> 8) & 0xFF, val & 0xFF)
154 void rgblight_show_solid_color(uint8_t r, uint8_t g, uint8_t b);
155
156 void rgblight_task(void);
157
158 void rgblight_timer_init(void);
159 void rgblight_timer_enable(void);
160 void rgblight_timer_disable(void);
161 void rgblight_timer_toggle(void);
162 void rgblight_effect_breathing(uint8_t interval);
163 void rgblight_effect_rainbow_mood(uint8_t interval);
164 void rgblight_effect_rainbow_swirl(uint8_t interval);
165 void rgblight_effect_snake(uint8_t interval);
166 void rgblight_effect_knight(uint8_t interval);
167 void rgblight_effect_christmas(void);
168 void rgblight_effect_rgbtest(void);
169 void rgblight_effect_alternating(void);
170
171 #endif