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