aboutsummaryrefslogtreecommitdiff
path: root/quantum/rgblight/rgblight.h
diff options
context:
space:
mode:
Diffstat (limited to 'quantum/rgblight/rgblight.h')
-rw-r--r--quantum/rgblight/rgblight.h442
1 files changed, 442 insertions, 0 deletions
diff --git a/quantum/rgblight/rgblight.h b/quantum/rgblight/rgblight.h
new file mode 100644
index 000000000..bec2c6695
--- /dev/null
+++ b/quantum/rgblight/rgblight.h
@@ -0,0 +1,442 @@
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
17#pragma once
18
19/***** rgblight_mode(mode)/rgblight_mode_noeeprom(mode) ****
20
21 old mode number (before 0.6.117) to new mode name table
22
23|-----------------|-----------------------------------|
24| old mode number | new mode name |
25|-----------------|-----------------------------------|
26| 1 | RGBLIGHT_MODE_STATIC_LIGHT |
27| 2 | RGBLIGHT_MODE_BREATHING |
28| 3 | RGBLIGHT_MODE_BREATHING + 1 |
29| 4 | RGBLIGHT_MODE_BREATHING + 2 |
30| 5 | RGBLIGHT_MODE_BREATHING + 3 |
31| 6 | RGBLIGHT_MODE_RAINBOW_MOOD |
32| 7 | RGBLIGHT_MODE_RAINBOW_MOOD + 1 |
33| 8 | RGBLIGHT_MODE_RAINBOW_MOOD + 2 |
34| 9 | RGBLIGHT_MODE_RAINBOW_SWIRL |
35| 10 | RGBLIGHT_MODE_RAINBOW_SWIRL + 1 |
36| 11 | RGBLIGHT_MODE_RAINBOW_SWIRL + 2 |
37| 12 | RGBLIGHT_MODE_RAINBOW_SWIRL + 3 |
38| 13 | RGBLIGHT_MODE_RAINBOW_SWIRL + 4 |
39| 14 | RGBLIGHT_MODE_RAINBOW_SWIRL + 5 |
40| 15 | RGBLIGHT_MODE_SNAKE |
41| 16 | RGBLIGHT_MODE_SNAKE + 1 |
42| 17 | RGBLIGHT_MODE_SNAKE + 2 |
43| 18 | RGBLIGHT_MODE_SNAKE + 3 |
44| 19 | RGBLIGHT_MODE_SNAKE + 4 |
45| 20 | RGBLIGHT_MODE_SNAKE + 5 |
46| 21 | RGBLIGHT_MODE_KNIGHT |
47| 22 | RGBLIGHT_MODE_KNIGHT + 1 |
48| 23 | RGBLIGHT_MODE_KNIGHT + 2 |
49| 24 | RGBLIGHT_MODE_CHRISTMAS |
50| 25 | RGBLIGHT_MODE_STATIC_GRADIENT |
51| 26 | RGBLIGHT_MODE_STATIC_GRADIENT + 1 |
52| 27 | RGBLIGHT_MODE_STATIC_GRADIENT + 2 |
53| 28 | RGBLIGHT_MODE_STATIC_GRADIENT + 3 |
54| 29 | RGBLIGHT_MODE_STATIC_GRADIENT + 4 |
55| 30 | RGBLIGHT_MODE_STATIC_GRADIENT + 5 |
56| 31 | RGBLIGHT_MODE_STATIC_GRADIENT + 6 |
57| 32 | RGBLIGHT_MODE_STATIC_GRADIENT + 7 |
58| 33 | RGBLIGHT_MODE_STATIC_GRADIENT + 8 |
59| 34 | RGBLIGHT_MODE_STATIC_GRADIENT + 9 |
60| 35 | RGBLIGHT_MODE_RGB_TEST |
61| 36 | RGBLIGHT_MODE_ALTERNATING |
62| 37 | RGBLIGHT_MODE_TWINKLE |
63| 38 | RGBLIGHT_MODE_TWINKLE + 1 |
64| 39 | RGBLIGHT_MODE_TWINKLE + 2 |
65| 40 | RGBLIGHT_MODE_TWINKLE + 3 |
66| 41 | RGBLIGHT_MODE_TWINKLE + 4 |
67| 42 | RGBLIGHT_MODE_TWINKLE + 5 |
68|-----------------|-----------------------------------|
69 *****/
70
71#ifdef RGBLIGHT_ANIMATIONS
72// for backward compatibility
73# define RGBLIGHT_EFFECT_BREATHING
74# define RGBLIGHT_EFFECT_RAINBOW_MOOD
75# define RGBLIGHT_EFFECT_RAINBOW_SWIRL
76# define RGBLIGHT_EFFECT_SNAKE
77# define RGBLIGHT_EFFECT_KNIGHT
78# define RGBLIGHT_EFFECT_CHRISTMAS
79# define RGBLIGHT_EFFECT_STATIC_GRADIENT
80# define RGBLIGHT_EFFECT_RGB_TEST
81# define RGBLIGHT_EFFECT_ALTERNATING
82# define RGBLIGHT_EFFECT_TWINKLE
83#endif
84
85#ifdef RGBLIGHT_STATIC_PATTERNS
86# define RGBLIGHT_EFFECT_STATIC_GRADIENT
87#endif
88
89// clang-format off
90
91// check dynamic animation effects chose ?
92#if defined(RGBLIGHT_EFFECT_BREATHING) \
93 || defined(RGBLIGHT_EFFECT_RAINBOW_MOOD) \
94 || defined(RGBLIGHT_EFFECT_RAINBOW_SWIRL) \
95 || defined(RGBLIGHT_EFFECT_SNAKE) \
96 || defined(RGBLIGHT_EFFECT_KNIGHT) \
97 || defined(RGBLIGHT_EFFECT_CHRISTMAS) \
98 || defined(RGBLIGHT_EFFECT_RGB_TEST) \
99 || defined(RGBLIGHT_EFFECT_ALTERNATING) \
100 || defined(RGBLIGHT_EFFECT_TWINKLE)
101# define RGBLIGHT_USE_TIMER
102#endif
103
104// clang-format on
105
106#define _RGBM_SINGLE_STATIC(sym) RGBLIGHT_MODE_##sym,
107#define _RGBM_SINGLE_DYNAMIC(sym) RGBLIGHT_MODE_##sym,
108#define _RGBM_MULTI_STATIC(sym) RGBLIGHT_MODE_##sym,
109#define _RGBM_MULTI_DYNAMIC(sym) RGBLIGHT_MODE_##sym,
110#define _RGBM_TMP_STATIC(sym, msym) RGBLIGHT_MODE_##sym,
111#define _RGBM_TMP_DYNAMIC(sym, msym) RGBLIGHT_MODE_##sym,
112enum RGBLIGHT_EFFECT_MODE {
113 RGBLIGHT_MODE_zero = 0,
114#include "rgblight_modes.h"
115 RGBLIGHT_MODE_last
116};
117
118#ifndef RGBLIGHT_H_DUMMY_DEFINE
119
120# define RGBLIGHT_MODES (RGBLIGHT_MODE_last - 1)
121
122// sample: #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85
123
124# ifndef RGBLIGHT_EFFECT_BREATHE_MAX
125# define RGBLIGHT_EFFECT_BREATHE_MAX 255 // 0-255
126# endif
127
128# ifndef RGBLIGHT_EFFECT_SNAKE_LENGTH
129# define RGBLIGHT_EFFECT_SNAKE_LENGTH 4
130# endif
131
132# ifndef RGBLIGHT_EFFECT_KNIGHT_LENGTH
133# define RGBLIGHT_EFFECT_KNIGHT_LENGTH 3
134# endif
135
136# ifndef RGBLIGHT_EFFECT_KNIGHT_OFFSET
137# define RGBLIGHT_EFFECT_KNIGHT_OFFSET 0
138# endif
139
140# ifndef RGBLIGHT_EFFECT_KNIGHT_LED_NUM
141# define RGBLIGHT_EFFECT_KNIGHT_LED_NUM (rgblight_ranges.effect_num_leds)
142# endif
143
144# ifndef RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL
145# define RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL 40
146# endif
147
148# ifndef RGBLIGHT_EFFECT_CHRISTMAS_STEP
149# define RGBLIGHT_EFFECT_CHRISTMAS_STEP 2
150# endif
151
152# ifndef RGBLIGHT_EFFECT_TWINKLE_LIFE
153# define RGBLIGHT_EFFECT_TWINKLE_LIFE 200
154# endif
155
156# ifndef RGBLIGHT_EFFECT_TWINKLE_PROBABILITY
157# define RGBLIGHT_EFFECT_TWINKLE_PROBABILITY 1 / 127
158# endif
159
160# ifndef RGBLIGHT_HUE_STEP
161# define RGBLIGHT_HUE_STEP 8
162# endif
163# ifndef RGBLIGHT_SAT_STEP
164# define RGBLIGHT_SAT_STEP 17
165# endif
166# ifndef RGBLIGHT_VAL_STEP
167# define RGBLIGHT_VAL_STEP 17
168# endif
169# ifndef RGBLIGHT_LIMIT_VAL
170# define RGBLIGHT_LIMIT_VAL 255
171# endif
172
173# include <stdint.h>
174# include <stdbool.h>
175# include "eeconfig.h"
176# include "ws2812.h"
177# include "color.h"
178# include "rgblight_list.h"
179
180# if defined(__AVR__)
181# include <avr/pgmspace.h>
182# endif
183
184# ifdef RGBLIGHT_LAYERS
185typedef struct {
186 uint8_t index; // The first LED to light
187 uint8_t count; // The number of LEDs to light
188 uint8_t hue;
189 uint8_t sat;
190 uint8_t val;
191} rgblight_segment_t;
192
193# define RGBLIGHT_END_SEGMENT_INDEX (255)
194# define RGBLIGHT_END_SEGMENTS \
195 { RGBLIGHT_END_SEGMENT_INDEX, 0, 0, 0 }
196# ifndef RGBLIGHT_MAX_LAYERS
197# define RGBLIGHT_MAX_LAYERS 8
198# endif
199# if RGBLIGHT_MAX_LAYERS <= 0
200# error invalid RGBLIGHT_MAX_LAYERS value (must be >= 1)
201# elif RGBLIGHT_MAX_LAYERS <= 8
202typedef uint8_t rgblight_layer_mask_t;
203# elif RGBLIGHT_MAX_LAYERS <= 16
204typedef uint16_t rgblight_layer_mask_t;
205# elif RGBLIGHT_MAX_LAYERS <= 32
206typedef uint32_t rgblight_layer_mask_t;
207# else
208# error invalid RGBLIGHT_MAX_LAYERS value (must be <= 32)
209# endif
210# define RGBLIGHT_LAYER_SEGMENTS(...) \
211 { __VA_ARGS__, RGBLIGHT_END_SEGMENTS }
212# define RGBLIGHT_LAYERS_LIST(...) \
213 { __VA_ARGS__, NULL }
214
215// Get/set enabled rgblight layers
216void rgblight_set_layer_state(uint8_t layer, bool enabled);
217bool rgblight_get_layer_state(uint8_t layer);
218
219// Point this to an array of rgblight_segment_t arrays in keyboard_post_init_user to use rgblight layers
220extern const rgblight_segment_t *const *rgblight_layers;
221
222# ifdef RGBLIGHT_LAYER_BLINK
223# define RGBLIGHT_USE_TIMER
224void rgblight_blink_layer(uint8_t layer, uint16_t duration_ms);
225void rgblight_blink_layer_repeat(uint8_t layer, uint16_t duration_ms, uint8_t times);
226# endif
227
228# endif
229
230extern LED_TYPE led[RGBLED_NUM];
231
232extern const uint8_t RGBLED_BREATHING_INTERVALS[4] PROGMEM;
233extern const uint8_t RGBLED_RAINBOW_MOOD_INTERVALS[3] PROGMEM;
234extern const uint8_t RGBLED_RAINBOW_SWIRL_INTERVALS[3] PROGMEM;
235extern const uint8_t RGBLED_SNAKE_INTERVALS[3] PROGMEM;
236extern const uint8_t RGBLED_KNIGHT_INTERVALS[3] PROGMEM;
237extern const uint16_t RGBLED_RGBTEST_INTERVALS[1] PROGMEM;
238extern const uint8_t RGBLED_TWINKLE_INTERVALS[3] PROGMEM;
239extern bool is_rgblight_initialized;
240
241// Should stay in sycn with rgb matrix config as we reuse eeprom storage for both (for now)
242typedef union {
243 uint32_t raw;
244 struct {
245 bool enable : 1;
246 uint8_t mode : 7;
247 uint8_t hue : 8;
248 uint8_t sat : 8;
249 uint8_t val : 8;
250 uint8_t speed : 8; // EECONFIG needs to be increased to support this
251 };
252} rgblight_config_t;
253
254typedef struct _rgblight_status_t {
255 uint8_t base_mode;
256 bool timer_enabled;
257# ifdef RGBLIGHT_SPLIT
258 uint8_t change_flags;
259# endif
260# ifdef RGBLIGHT_LAYERS
261 rgblight_layer_mask_t enabled_layer_mask;
262# endif
263} rgblight_status_t;
264
265/*
266 * Structure for RGB Light clipping ranges
267 */
268typedef struct _rgblight_ranges_t {
269 uint8_t clipping_start_pos;
270 uint8_t clipping_num_leds;
271 uint8_t effect_start_pos;
272 uint8_t effect_end_pos;
273 uint8_t effect_num_leds;
274} rgblight_ranges_t;
275
276extern rgblight_ranges_t rgblight_ranges;
277
278/* === Utility Functions ===*/
279void sethsv(uint8_t hue, uint8_t sat, uint8_t val, LED_TYPE *led1);
280void sethsv_raw(uint8_t hue, uint8_t sat, uint8_t val, LED_TYPE *led1); // without RGBLIGHT_LIMIT_VAL check
281void setrgb(uint8_t r, uint8_t g, uint8_t b, LED_TYPE *led1);
282
283/* === Low level Functions === */
284void rgblight_set(void);
285void rgblight_set_clipping_range(uint8_t start_pos, uint8_t num_leds);
286
287/* === Effects and Animations Functions === */
288/* effect range setting */
289void rgblight_set_effect_range(uint8_t start_pos, uint8_t num_leds);
290
291/* direct operation */
292void rgblight_setrgb_at(uint8_t r, uint8_t g, uint8_t b, uint8_t index);
293void rgblight_sethsv_at(uint8_t hue, uint8_t sat, uint8_t val, uint8_t index);
294void rgblight_setrgb_range(uint8_t r, uint8_t g, uint8_t b, uint8_t start, uint8_t end);
295void rgblight_sethsv_range(uint8_t hue, uint8_t sat, uint8_t val, uint8_t start, uint8_t end);
296void rgblight_setrgb(uint8_t r, uint8_t g, uint8_t b);
297
298# ifndef RGBLIGHT_SPLIT
299void rgblight_setrgb_master(uint8_t r, uint8_t g, uint8_t b);
300void rgblight_setrgb_slave(uint8_t r, uint8_t g, uint8_t b);
301void rgblight_sethsv_master(uint8_t hue, uint8_t sat, uint8_t val);
302void rgblight_sethsv_slave(uint8_t hue, uint8_t sat, uint8_t val);
303# endif
304
305/* effect mode change */
306void rgblight_mode(uint8_t mode);
307void rgblight_mode_noeeprom(uint8_t mode);
308void rgblight_increase(void);
309void rgblight_decrease(void);
310void rgblight_step(void);
311void rgblight_step_noeeprom(void);
312void rgblight_step_reverse(void);
313void rgblight_step_reverse_noeeprom(void);
314
315/* effects mode disable/enable */
316void rgblight_toggle(void);
317void rgblight_toggle_noeeprom(void);
318void rgblight_enable(void);
319void rgblight_enable_noeeprom(void);
320void rgblight_disable(void);
321void rgblight_disable_noeeprom(void);
322
323/* hue, sat, val change */
324void rgblight_increase_hue(void);
325void rgblight_increase_hue_noeeprom(void);
326void rgblight_decrease_hue(void);
327void rgblight_decrease_hue_noeeprom(void);
328void rgblight_increase_sat(void);
329void rgblight_increase_sat_noeeprom(void);
330void rgblight_decrease_sat(void);
331void rgblight_decrease_sat_noeeprom(void);
332void rgblight_increase_val(void);
333void rgblight_increase_val_noeeprom(void);
334void rgblight_decrease_val(void);
335void rgblight_decrease_val_noeeprom(void);
336void rgblight_increase_speed(void);
337void rgblight_increase_speed_noeeprom(void);
338void rgblight_decrease_speed(void);
339void rgblight_decrease_speed_noeeprom(void);
340void rgblight_sethsv(uint8_t hue, uint8_t sat, uint8_t val);
341void rgblight_sethsv_noeeprom(uint8_t hue, uint8_t sat, uint8_t val);
342
343/* effect speed */
344uint8_t rgblight_get_speed(void);
345void rgblight_set_speed(uint8_t speed);
346void rgblight_set_speed_noeeprom(uint8_t speed);
347
348/* reset */
349void rgblight_reload_from_eeprom(void);
350
351/* query */
352uint8_t rgblight_get_mode(void);
353uint8_t rgblight_get_hue(void);
354uint8_t rgblight_get_sat(void);
355uint8_t rgblight_get_val(void);
356bool rgblight_is_enabled(void);
357HSV rgblight_get_hsv(void);
358
359/* === qmk_firmware (core)internal Functions === */
360void rgblight_init(void);
361void rgblight_suspend(void);
362void rgblight_wakeup(void);
363uint32_t rgblight_read_dword(void);
364void rgblight_update_dword(uint32_t dword);
365uint32_t eeconfig_read_rgblight(void);
366void eeconfig_update_rgblight(uint32_t val);
367void eeconfig_update_rgblight_current(void);
368void eeconfig_update_rgblight_default(void);
369void eeconfig_debug_rgblight(void);
370
371void rgb_matrix_increase(void);
372void rgb_matrix_decrease(void);
373
374void rgblight_sethsv_eeprom_helper(uint8_t hue, uint8_t sat, uint8_t val, bool write_to_eeprom);
375void rgblight_mode_eeprom_helper(uint8_t mode, bool write_to_eeprom);
376
377# define EZ_RGB(val) rgblight_show_solid_color((val >> 16) & 0xFF, (val >> 8) & 0xFF, val & 0xFF)
378void rgblight_show_solid_color(uint8_t r, uint8_t g, uint8_t b);
379
380# ifdef RGBLIGHT_USE_TIMER
381void rgblight_task(void);
382void rgblight_timer_init(void);
383void rgblight_timer_enable(void);
384void rgblight_timer_disable(void);
385void rgblight_timer_toggle(void);
386# else
387# define rgblight_task()
388# define rgblight_timer_init()
389# define rgblight_timer_enable()
390# define rgblight_timer_disable()
391# define rgblight_timer_toggle()
392# endif
393
394# ifdef RGBLIGHT_SPLIT
395# define RGBLIGHT_STATUS_CHANGE_MODE (1 << 0)
396# define RGBLIGHT_STATUS_CHANGE_HSVS (1 << 1)
397# define RGBLIGHT_STATUS_CHANGE_TIMER (1 << 2)
398# define RGBLIGHT_STATUS_ANIMATION_TICK (1 << 3)
399# define RGBLIGHT_STATUS_CHANGE_LAYERS (1 << 4)
400
401typedef struct _rgblight_syncinfo_t {
402 rgblight_config_t config;
403 rgblight_status_t status;
404} rgblight_syncinfo_t;
405
406/* for split keyboard master side */
407uint8_t rgblight_get_change_flags(void);
408void rgblight_clear_change_flags(void);
409void rgblight_get_syncinfo(rgblight_syncinfo_t *syncinfo);
410/* for split keyboard slave side */
411void rgblight_update_sync(rgblight_syncinfo_t *syncinfo, bool write_to_eeprom);
412# endif
413
414# ifdef RGBLIGHT_USE_TIMER
415
416typedef struct _animation_status_t {
417 uint16_t last_timer;
418 uint8_t delta; /* mode - base_mode */
419 bool restart;
420 union {
421 uint16_t pos16;
422 uint8_t pos;
423 int8_t current_hue;
424 uint16_t current_offset;
425 };
426} animation_status_t;
427
428extern animation_status_t animation_status;
429
430void rgblight_effect_breathing(animation_status_t *anim);
431void rgblight_effect_rainbow_mood(animation_status_t *anim);
432void rgblight_effect_rainbow_swirl(animation_status_t *anim);
433void rgblight_effect_snake(animation_status_t *anim);
434void rgblight_effect_knight(animation_status_t *anim);
435void rgblight_effect_christmas(animation_status_t *anim);
436void rgblight_effect_rgbtest(animation_status_t *anim);
437void rgblight_effect_alternating(animation_status_t *anim);
438void rgblight_effect_twinkle(animation_status_t *anim);
439
440# endif
441
442#endif // #ifndef RGBLIGHT_H_DUMMY_DEFINE
generated by cgit v1.2.3 (git 2.25.1) at 2025-07-16 11:24:40 +0000