Fred Sundvik 1e6a3f9e17 Change M_2_PI to 2 * PI as it should be 8 anni fa
..
resources df67169d42 Move LCD logo to visualizer resources 8 anni fa
LICENSE.md 9f33a5593c Add 'quantum/visualizer/' from commit 'bde869aa7ec8601459bc63b9636081d21108d1be' 9 anni fa
lcd_backlight.c da19852964 Add function for getting the LCD backlight brightness 8 anni fa
lcd_backlight.h f912c74fe7 Change inline to static inline 8 anni fa
lcd_backlight_keyframes.c 1e7585e767 Separated backlight and LCD disable/enable 8 anni fa
lcd_backlight_keyframes.h 1e7585e767 Separated backlight and LCD disable/enable 8 anni fa
lcd_keyframes.c 5c251b5575 Fix buffer overrun in lcd_keyframes 8 anni fa
lcd_keyframes.h 3074269c4a Move the logo drawing keyframe to lcd_keyframes 8 anni fa
led_keyframes.c 1e6a3f9e17 Change M_2_PI to 2 * PI as it should be 8 anni fa
led_keyframes.h b51a0db6ed Add backlight support to the default Ergodox Infinity animations 8 anni fa
readme.md 9f33a5593c Add 'quantum/visualizer/' from commit 'bde869aa7ec8601459bc63b9636081d21108d1be' 9 anni fa
visualizer.c 6c9b4743f7 Include config.h before visualizer.h 8 anni fa
visualizer.h ff49259a1a Include config.h from visualizer.h 8 anni fa
visualizer.mk a916f4e8b8 Let BACKLIGHT_ENABLE control the Infinity LEDs 8 anni fa
visualizer_keyframes.c b7041d06ae Move common visualizer keyframes into visualizer_keyframes.h 8 anni fa
visualizer_keyframes.h b7041d06ae Move common visualizer keyframes into visualizer_keyframes.h 8 anni fa

readme.md

A visualization library for the TMK keyboard firmware

This library is designed to work together with the TMK keyboard firmware. Currently it only works for Chibios flavors, but it would be possible to add support for other configurations as well. The LCD display functionality is provided by the uGFX library.

To use this library as a user

You can and should modify the visualizer_user.c file. Check the comments in the file for more information.

To add this library to custom keyboard projects

  1. Add tmk_visualizer as a submodule to your project
  2. Set VISUALIZER_DIR in the main keyboard project makefile to point to the submodule
  3. Define LCD_ENABLE and/or LCD_BACKLIGHT_ENABLE, to enable support
  4. Include the visualizer.mk make file
  5. Copy the files in the example_integration folder to your keyboard project
  6. All other files than the callback.c file are included automatically, so you will need to add callback.c to your makefile manually. If you already have a similar file in your project, you can just copy the functions instead of the whole file.
  7. Edit the files to match your hardware. You might might want to read the Chibios and UGfx documentation, for more information.
  8. If you enable LCD support you might also have to write a custom uGFX display driver, check the uGFX documentation for that. You probably also want to enable SPI support in your Chibios configuration.