James Young 26eef35f07 2020 February 29 Breaking Changes Update (#8064) hace 5 años
..
resources b624f32f94 clang-format changes hace 5 años
LICENSE.md 9f33a5593c Add 'quantum/visualizer/' from commit 'bde869aa7ec8601459bc63b9636081d21108d1be' hace 9 años
common_gfxconf.h 26eef35f07 2020 February 29 Breaking Changes Update (#8064) hace 5 años
default_animations.c b624f32f94 clang-format changes hace 5 años
default_animations.h 4da3b19603 Shared default animations hace 8 años
lcd_backlight.c b624f32f94 clang-format changes hace 5 años
lcd_backlight.h b624f32f94 clang-format changes hace 5 años
lcd_backlight_keyframes.c b624f32f94 clang-format changes hace 5 años
lcd_backlight_keyframes.h bba871df2f move lcd_backlight_keyframes to correct location hace 7 años
lcd_keyframes.c b624f32f94 clang-format changes hace 5 años
lcd_keyframes.h b624f32f94 clang-format changes hace 5 años
led_backlight_keyframes.c b624f32f94 clang-format changes hace 5 años
led_backlight_keyframes.h b624f32f94 clang-format changes hace 5 años
readme.md 3f4d706c98 Fixing dead links (#5503) hace 6 años
visualizer.c 26eef35f07 2020 February 29 Breaking Changes Update (#8064) hace 5 años
visualizer.h 26eef35f07 2020 February 29 Breaking Changes Update (#8064) hace 5 años
visualizer.mk 800ec55dfc Make arguments redo, subproject elimination (#1784) hace 7 años
visualizer_keyframes.c b7041d06ae Move common visualizer keyframes into visualizer_keyframes.h hace 8 años
visualizer_keyframes.h b7041d06ae Move common visualizer keyframes into visualizer_keyframes.h hace 8 años

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.