]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/ergodox_infinity/simple_visualizer.h
Keyboard: Port over the x268 Noxary Firmware (#4339)
[qmk_firmware.git] / keyboards / ergodox_infinity / simple_visualizer.h
1 /* Copyright 2017 Fred Sundvik
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 #ifndef KEYBOARDS_ERGODOX_INFINITY_SIMPLE_VISUALIZER_H_
18 #define KEYBOARDS_ERGODOX_INFINITY_SIMPLE_VISUALIZER_H_
19
20 // Currently we are assuming that both the backlight and LCD are enabled
21 // But it's entirely possible to write a custom visualizer that use only
22 // one of them
23 #ifndef LCD_BACKLIGHT_ENABLE
24 #error This visualizer needs that LCD backlight is enabled
25 #endif
26
27 #ifndef LCD_ENABLE
28 #error This visualizer needs that LCD is enabled
29 #endif
30
31 #include "visualizer.h"
32 #include "visualizer_keyframes.h"
33 #include "lcd_keyframes.h"
34 #include "lcd_backlight_keyframes.h"
35 #include "system/serial_link.h"
36 #include "led.h"
37 #include "default_animations.h"
38
39 static const uint32_t logo_background_color = LCD_COLOR(0x00, 0x00, 0xFF);
40 static const uint32_t initial_color = LCD_COLOR(0, 0, 0);
41
42 static bool initial_update = true;
43
44 // Feel free to modify the animations below, or even add new ones if needed
45
46 static keyframe_animation_t lcd_layer_display = {
47     .num_frames = 1,
48     .loop = false,
49     .frame_lengths = {gfxMillisecondsToTicks(0)},
50     .frame_functions = {lcd_keyframe_display_layer_and_led_states}
51 };
52
53 // The color animation animates the LCD color when you change layers
54 static keyframe_animation_t color_animation = {
55     .num_frames = 2,
56     .loop = false,
57     // Note that there's a 200 ms no-operation frame,
58     // this prevents the color from changing when activating the layer
59     // momentarily
60     .frame_lengths = {gfxMillisecondsToTicks(200), gfxMillisecondsToTicks(500)},
61     .frame_functions = {keyframe_no_operation, lcd_backlight_keyframe_animate_color},
62 };
63
64 void initialize_user_visualizer(visualizer_state_t* state) {
65     // The brightness will be dynamically adjustable in the future
66     // But for now, change it here.
67     lcd_backlight_brightness(130);
68     state->current_lcd_color = initial_color;
69     state->target_lcd_color = logo_background_color;
70     initial_update = true;
71     start_keyframe_animation(&default_startup_animation);
72 }
73
74
75 // This function should be implemented by the keymap visualizer
76 // Don't change anything else than state->target_lcd_color and state->layer_text as that's the only thing
77 // that the simple_visualizer assumes that you are updating
78 // Also make sure that the buffer passed to state->layer_text remains valid until the previous animation is
79 // stopped. This can be done by either double buffering it or by using constant strings
80 static void get_visualizer_layer_and_color(visualizer_state_t* state);
81
82 void update_user_visualizer_state(visualizer_state_t* state, visualizer_keyboard_status_t* prev_status) {
83     // Add more tests, change the colors and layer texts here
84     // Usually you want to check the high bits (higher layers first)
85     // because that's the order layers are processed for keypresses
86     // You can for check for example:
87     // state->status.layer
88     // state->status.default_layer
89     // state->status.leds (see led.h for available statuses)
90
91     uint32_t prev_color = state->target_lcd_color;
92     const char* prev_layer_text = state->layer_text;
93
94     get_visualizer_layer_and_color(state);
95
96     if (initial_update || prev_color != state->target_lcd_color) {
97         start_keyframe_animation(&color_animation);
98     }
99
100     if (initial_update || prev_layer_text != state->layer_text) {
101         start_keyframe_animation(&lcd_layer_display);
102     }
103     // You can also stop existing animations, and start your custom ones here
104     // remember that you should normally have only one animation for the LCD
105     // and one for the background. But you can also combine them if you want.
106 }
107
108 void user_visualizer_suspend(visualizer_state_t* state) {
109     state->layer_text = "Suspending...";
110     uint8_t hue = LCD_HUE(state->current_lcd_color);
111     uint8_t sat = LCD_SAT(state->current_lcd_color);
112     state->target_lcd_color = LCD_COLOR(hue, sat, 0);
113     start_keyframe_animation(&default_suspend_animation);
114 }
115
116 void user_visualizer_resume(visualizer_state_t* state) {
117     state->current_lcd_color = initial_color;
118     state->target_lcd_color = logo_background_color;
119     initial_update = true;
120     start_keyframe_animation(&default_startup_animation);
121 }
122
123 #endif /* KEYBOARDS_ERGODOX_INFINITY_SIMPLE_VISUALIZER_H_ */