keyboards/ergodox/keymaps/default/visualizer.c

   1 /*
   2 Copyright 2017 Fred Sundvik
   3
   4 This program is free software: you can redistribute it and/or modify
   5 it under the terms of the GNU General Public License as published by
   6 the Free Software Foundation, either version 2 of the License, or
   7 (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 */
  17
  18 // Currently we are assuming that both the backlight and LCD are enabled
  19 // But it's entirely possible to write a custom visualizer that use only
  20 // one of them
  21 #ifndef LCD_BACKLIGHT_ENABLE
  22 #error This visualizer needs that LCD backlight is enabled
  23 #endif
  24
  25 #ifndef LCD_ENABLE
  26 #error This visualizer needs that LCD is enabled
  27 #endif
  28
  29 #include "visualizer.h"
  30 #include "visualizer_keyframes.h"
  31 #include "lcd_keyframes.h"
  32 #include "lcd_backlight_keyframes.h"
  33 #include "system/serial_link.h"
  34 #include "led.h"
  35 #include "animations.h"
  36
  37 static const uint32_t logo_background_color = LCD_COLOR(0x00, 0x00, 0xFF);
  38 static const uint32_t initial_color = LCD_COLOR(0, 0, 0);
  39
  40 typedef enum {
  41     LCD_STATE_INITIAL,
  42     LCD_STATE_LAYER_BITMAP,
  43     LCD_STATE_BITMAP_AND_LEDS,
  44 } lcd_state_t;
  45
  46 static lcd_state_t lcd_state = LCD_STATE_INITIAL;
  47
  48 // Feel free to modify the animations below, or even add new ones if needed
  49
  50 static keyframe_animation_t lcd_layer_display = {
  51     .num_frames = 1,
  52     .loop = false,
  53     .frame_lengths = {gfxMillisecondsToTicks(0)},
  54     .frame_functions = {lcd_keyframe_display_layer_and_led_states}
  55 };
  56
  57 // The color animation animates the LCD color when you change layers
  58 static keyframe_animation_t color_animation = {
  59     .num_frames = 2,
  60     .loop = false,
  61     // Note that there's a 200 ms no-operation frame,
  62     // this prevents the color from changing when activating the layer
  63     // momentarily
  64     .frame_lengths = {gfxMillisecondsToTicks(200), gfxMillisecondsToTicks(500)},
  65     .frame_functions = {keyframe_no_operation, backlight_keyframe_animate_color},
  66 };
  67
  68 void initialize_user_visualizer(visualizer_state_t* state) {
  69     // The brightness will be dynamically adjustable in the future
  70     // But for now, change it here.
  71     lcd_backlight_brightness(130);
  72     state->current_lcd_color = initial_color;
  73     state->target_lcd_color = logo_background_color;
  74     lcd_state = LCD_STATE_INITIAL;
  75     start_keyframe_animation(&default_startup_animation);
  76 }
  77
  78 void update_user_visualizer_state(visualizer_state_t* state, visualizer_keyboard_status_t* prev_status) {
  79     // Add more tests, change the colors and layer texts here
  80     // Usually you want to check the high bits (higher layers first)
  81     // because that's the order layers are processed for keypresses
  82     // You can for check for example:
  83     // state->status.layer
  84     // state->status.default_layer
  85     // state->status.leds (see led.h for available statuses)
  86
  87     uint8_t saturation = 60;
  88     if (state->status.leds & (1u << USB_LED_CAPS_LOCK)) {
  89         saturation = 255;
  90     }
  91     if (state->status.layer & 0x4) {
  92         state->target_lcd_color = LCD_COLOR(0, saturation, 0xFF);
  93         state->layer_text = "Media & Mouse";
  94     }
  95     else if (state->status.layer & 0x2) {
  96         state->target_lcd_color = LCD_COLOR(168, saturation, 0xFF);
  97         state->layer_text = "Symbol";
  98     }
  99     else {
 100         state->target_lcd_color = LCD_COLOR(84, saturation, 0xFF);
 101         state->layer_text = "Default";
 102     }
 103
 104     if (lcd_state == LCD_STATE_INITIAL ||
 105             state->status.layer != prev_status->layer ||
 106             state->status.default_layer != prev_status->default_layer ||
 107             state->status.leds != prev_status->leds) {
 108         start_keyframe_animation(&color_animation);
 109         start_keyframe_animation(&lcd_layer_display);
 110     }
 111
 112     // You can also stop existing animations, and start your custom ones here
 113     // remember that you should normally have only one animation for the LCD
 114     // and one for the background. But you can also combine them if you want.
 115 }
 116
 117 void user_visualizer_suspend(visualizer_state_t* state) {
 118     state->layer_text = "Suspending...";
 119     uint8_t hue = LCD_HUE(state->current_lcd_color);
 120     uint8_t sat = LCD_SAT(state->current_lcd_color);
 121     state->target_lcd_color = LCD_COLOR(hue, sat, 0);
 122     start_keyframe_animation(&default_suspend_animation);
 123 }
 124
 125 void user_visualizer_resume(visualizer_state_t* state) {
 126     state->current_lcd_color = initial_color;
 127     state->target_lcd_color = logo_background_color;
 128     lcd_state = LCD_STATE_INITIAL;
 129     start_keyframe_animation(&default_startup_animation);
 130 }