_/qmk_firmware
1
0
Fork 0
Code Releases Activity
qmk_firmware/quantum/visualizer
History
SjB 9eb8d05246 added mods status bit to visualizer. 
Since we can't read the real_mods and oneshot_mods static variable
directly within the update_user_visualizer_state
function (Threading and serial link). We are know storing the mods
states in the visualizer_keyboard_status_t structure. We can now
display the status of the modifier keys on the LCD display.
2017-01-17 21:57:32 -05:00
..
example_integration Add 'quantum/visualizer/' from commit 'bde869aa7ec8601459bc63b9636081d21108d1be' 2016-07-06 20:15:45 +03:00
lcd_backlight.c Add 'quantum/visualizer/' from commit 'bde869aa7ec8601459bc63b9636081d21108d1be' 2016-07-06 20:15:45 +03:00
lcd_backlight.h Add 'quantum/visualizer/' from commit 'bde869aa7ec8601459bc63b9636081d21108d1be' 2016-07-06 20:15:45 +03:00
led_test.c Makefile fixes and update of Visualizer 2016-07-07 12:46:10 +03:00
led_test.h Merge commit '73d890a2c9c34b905cd5e74e7146fdd4578dcb96' into add_visualizer 2016-07-06 20:30:58 +03:00
LICENSE.md Add 'quantum/visualizer/' from commit 'bde869aa7ec8601459bc63b9636081d21108d1be' 2016-07-06 20:15:45 +03:00
readme.md Add 'quantum/visualizer/' from commit 'bde869aa7ec8601459bc63b9636081d21108d1be' 2016-07-06 20:15:45 +03:00
visualizer.c added mods status bit to visualizer. 2017-01-17 21:57:32 -05:00
visualizer.h added mods status bit to visualizer. 2017-01-17 21:57:32 -05:00
visualizer.mk Move the visualizer_user file to keymap folder 2016-07-07 14:42:16 +03:00

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.