mirrors/keychron_qmk_firmware
mirrors/keychron_qmk_firmware
0
0
Fork 0
mirror of https://github.com/Keychron/qmk_firmware.git synced 2024-11-23 00:47:02 +06:00
Code Issues Packages Projects Releases Wiki Activity
48933811c5
keychron_qmk_firmware/quantum/visualizer
History
Jack Humbert bba871df2f move lcd_backlight_keyframes to correct location
2017-12-07 12:41:13 -05:00
..
resources make it easy to customize logo image 2017-11-06 12:10:17 -05:00
common_gfxconf.h Shared gfxconf 2017-07-10 09:01:59 -04:00
default_animations.c Shared default animations 2017-07-10 09:01:59 -04:00
default_animations.h Shared default animations 2017-07-10 09:01:59 -04:00
lcd_backlight_keyframes.c Clarify naming between LCD_BACKLIGHT and LED_BACKLIGHT 2017-07-10 09:01:59 -04:00
lcd_backlight_keyframes.h move lcd_backlight_keyframes to correct location 2017-12-07 12:41:13 -05:00
lcd_backlight.c Add function for getting the LCD backlight brightness 2017-06-24 00:34:16 +03:00
lcd_backlight.h Change inline to static inline 2017-06-24 00:34:16 +03:00
lcd_keyframes.c Make it easier to use drivers 2017-07-10 09:01:59 -04:00
lcd_keyframes.h Move the logo drawing keyframe to lcd_keyframes 2017-04-09 18:34:59 +03:00
led_backlight_keyframes.c Make it easier to use drivers 2017-07-10 09:01:59 -04:00
led_backlight_keyframes.h Clarify naming between LCD_BACKLIGHT and LED_BACKLIGHT 2017-07-10 09:01:59 -04:00
LICENSE.md
readme.md
visualizer_keyframes.c Move common visualizer keyframes into visualizer_keyframes.h 2017-04-09 18:34:59 +03:00
visualizer_keyframes.h Move common visualizer keyframes into visualizer_keyframes.h 2017-04-09 18:34:59 +03:00
visualizer.c Fix uninitialized backlight_level in the Visualizer 2017-07-10 09:02:36 -04:00
visualizer.h Include config.h from visualizer.h 2017-06-24 00:34:16 +03:00
visualizer.mk Make arguments redo, subproject elimination (#1784) 2017-10-14 11:32:19 -10: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.