文件歷史

Fred Sundvik 10546665f4 Fix uninitialized backlight_level in the Visualizer		8 年之前
..
resources	Move LCD logo to visualizer resources	9 年之前
LICENSE.md	Add 'quantum/visualizer/' from commit 'bde869aa7ec8601459bc63b9636081d21108d1be'	9 年之前
common_gfxconf.h	Shared gfxconf	8 年之前
default_animations.c	Shared default animations	8 年之前
default_animations.h	Shared default animations	8 年之前
lcd_backlight.c	Add function for getting the LCD backlight brightness	8 年之前
lcd_backlight.h	Change inline to static inline	8 年之前
lcd_backlight_keyframes.c	Clarify naming between LCD_BACKLIGHT and LED_BACKLIGHT	8 年之前
lcd_keyframes.c	Make it easier to use drivers	8 年之前
lcd_keyframes.h	Move the logo drawing keyframe to lcd_keyframes	9 年之前
led_backlight_keyframes.c	Make it easier to use drivers	8 年之前
led_backlight_keyframes.h	Clarify naming between LCD_BACKLIGHT and LED_BACKLIGHT	8 年之前
readme.md	Add 'quantum/visualizer/' from commit 'bde869aa7ec8601459bc63b9636081d21108d1be'	9 年之前
visualizer.c	Fix uninitialized backlight_level in the Visualizer	8 年之前
visualizer.h	Include config.h from visualizer.h	8 年之前
visualizer.mk	Make it easier to use drivers	8 年之前
visualizer_keyframes.c	Move common visualizer keyframes into visualizer_keyframes.h	9 年之前
visualizer_keyframes.h	Move common visualizer keyframes into visualizer_keyframes.h	9 年之前

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

Add tmk_visualizer as a submodule to your project
Set VISUALIZER_DIR in the main keyboard project makefile to point to the submodule
Define LCD_ENABLE and/or LCD_BACKLIGHT_ENABLE, to enable support
Include the visualizer.mk make file
Copy the files in the example_integration folder to your keyboard project
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.
Edit the files to match your hardware. You might might want to read the Chibios and UGfx documentation, for more information.
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.