Halaman utama Jelajahi Bantuan
Daftar Masuk
HuiJun
/
qmk_firmware
1
0
Fork 0
Berkas Masalah 0 Permintaan Tarik 0 Wiki
Pohon: ccc0b23a75
Ranting Tag
qmk_firmware
/
quantum
/
visualizer
Ryan 48f4768d33 Change include guards in quantum/ to pragma once (#11239) 4 tahun lalu
..
resources 48f4768d33 Change include guards in quantum/ to pragma once (#11239) 4 tahun lalu
LICENSE.md 9f33a5593c Add 'quantum/visualizer/' from commit 'bde869aa7ec8601459bc63b9636081d21108d1be' 9 tahun lalu
common_gfxconf.h 48f4768d33 Change include guards in quantum/ to pragma once (#11239) 4 tahun lalu
default_animations.c b624f32f94 clang-format changes 5 tahun lalu
default_animations.h 48f4768d33 Change include guards in quantum/ to pragma once (#11239) 4 tahun lalu
lcd_backlight.c b624f32f94 clang-format changes 5 tahun lalu
lcd_backlight.h 48f4768d33 Change include guards in quantum/ to pragma once (#11239) 4 tahun lalu
lcd_backlight_keyframes.c b624f32f94 clang-format changes 5 tahun lalu
lcd_backlight_keyframes.h 48f4768d33 Change include guards in quantum/ to pragma once (#11239) 4 tahun lalu
lcd_keyframes.c 3afe0ea9b9 ST7565 tidyup (#10907) 4 tahun lalu
lcd_keyframes.h 48f4768d33 Change include guards in quantum/ to pragma once (#11239) 4 tahun lalu
led_backlight_keyframes.c 501f2fdef1 Normalise include statements in core code (#11153) 4 tahun lalu
led_backlight_keyframes.h 48f4768d33 Change include guards in quantum/ to pragma once (#11239) 4 tahun lalu
readme.md 3f4d706c98 Fixing dead links (#5503) 6 tahun lalu
visualizer.c 501f2fdef1 Normalise include statements in core code (#11153) 4 tahun lalu
visualizer.h 48f4768d33 Change include guards in quantum/ to pragma once (#11239) 4 tahun lalu
visualizer.mk 3afe0ea9b9 ST7565 tidyup (#10907) 4 tahun lalu
visualizer_keyframes.c b7041d06ae Move common visualizer keyframes into visualizer_keyframes.h 8 tahun lalu
visualizer_keyframes.h 48f4768d33 Change include guards in quantum/ to pragma once (#11239) 4 tahun lalu

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.