You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
qmk_firmware/quantum/visualizer
Jack Humbert 800ec55dfc
Make arguments redo, subproject elimination (#1784)
7 years ago
..
resources Move LCD logo to visualizer resources 8 years ago
LICENSE.md Add 'quantum/visualizer/' from commit 'bde869aa7ec8601459bc63b9636081d21108d1be' 8 years ago
common_gfxconf.h Shared gfxconf 7 years ago
default_animations.c Shared default animations 7 years ago
default_animations.h Shared default animations 7 years ago
lcd_backlight.c Add function for getting the LCD backlight brightness 7 years ago
lcd_backlight.h Change inline to static inline 7 years ago
lcd_backlight_keyframes.c Clarify naming between LCD_BACKLIGHT and LED_BACKLIGHT 7 years ago
lcd_keyframes.c Make it easier to use drivers 7 years ago
lcd_keyframes.h Move the logo drawing keyframe to lcd_keyframes 8 years ago
led_backlight_keyframes.c Make it easier to use drivers 7 years ago
led_backlight_keyframes.h Clarify naming between LCD_BACKLIGHT and LED_BACKLIGHT 7 years ago
readme.md Add 'quantum/visualizer/' from commit 'bde869aa7ec8601459bc63b9636081d21108d1be' 8 years ago
visualizer.c Fix uninitialized backlight_level in the Visualizer 7 years ago
visualizer.h Include config.h from visualizer.h 7 years ago
visualizer.mk Make arguments redo, subproject elimination (#1784) 7 years ago
visualizer_keyframes.c Move common visualizer keyframes into visualizer_keyframes.h 8 years ago
visualizer_keyframes.h Move common visualizer keyframes into visualizer_keyframes.h 8 years ago

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.