sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
4d297e6ab2
kmk_firmware/docs
History
xs5871 1700aff408 implements scanner with rotaryio
2022-04-17 18:33:34 -07:00
..
ja update docs and examples 2022-04-09 14:40:40 -07:00
ptBR update docs and examples 2022-04-09 14:40:40 -07:00
adns9800.md adns9800_firmware.py removed 2021-09-21 15:09:56 +08:00
ble_hid.md add ble_name option to KMKKeyboard.go method 2021-09-17 16:14:11 +02:00
boot.md updates to boot.py docs to bring it more in-line with docs style 2022-03-14 17:36:42 -07:00
capsword.md updated doc based on the presentation on github 2022-04-09 15:19:02 -07:00
cg_swap.md Updated doc to show the keys usage 2022-04-08 21:03:36 -07:00
combos.md implement combo/chord/sequence module 2022-03-14 19:27:12 -07:00
config_and_keymap.md update docs and examples 2022-04-09 14:40:40 -07:00
contributing.md fix typo 2022-03-18 17:15:01 -07:00
debugging.md feat(extensions): most of the extensions implementation, by kdb424 2021-06-20 13:55:16 -07:00
easypoint.md add vendor 2022-03-20 15:22:57 -07:00
encoder.md update docs and examples 2022-04-09 14:40:40 -07:00
extension_statusled.md Change documentation changing the original LED code to statusLED 2022-02-20 12:10:04 -08:00
extensions.md Add doc index 2022-02-25 13:41:08 -08:00
flashing.md feat(extensions): most of the extensions implementation, by kdb424 2021-06-20 13:55:16 -07:00
Getting_Started.md update docs and examples 2022-04-09 14:40:40 -07:00
handwiring.md chore: Fix URL and added a space for cleaner look 2021-08-23 23:06:04 -07:00
international.md docs and typos 2021-06-25 10:53:58 -07:00
keycodes.md fix doc typos and switched description for keycodes NUBS and NUHS 2021-09-17 08:54:22 -07:00
keys.md Update keys.md 2022-02-27 18:06:01 -08:00
kmkpython_vs_circuitpython.md Remove KMKpython reference 2022-02-27 16:04:38 -08:00
layers.md changes per https://github.com/KMKfw/kmk_firmware/pull/350\#issuecomment-1059061967 2022-03-05 10:40:09 -08:00
led.md update documentation 2022-02-07 16:25:45 -08:00
lock_status.md implement keyboard lock status reader API 2022-01-22 08:55:40 -08:00
media_keys.md docs and typos 2021-06-25 10:53:58 -07:00
midi.md Fix MIDI PR files 2022-03-06 00:56:05 -08:00
modtap.md add at least some kind of documentation 2022-02-13 14:47:02 -08:00
modules.md Implement easypoint 2022-03-20 15:22:57 -07:00
mouse_keys.md added ADNS9800 and mouse keys/mouse buttons/mouse wheel support 2021-09-15 20:14:12 +08:00
Officially_Supported_Microcontrollers.md Update Officially_Supported_Microcontrollers.md 2022-04-14 10:57:42 +00:00
oneshot.md fix table formatting in docs. 2022-02-15 08:24:33 -08:00
pimoroni_trackball.md Small pimoroni_trackball.py refactors 2022-02-08 13:23:35 -08:00
pins56.jpg cleaner and smaller pins56.jpg 2022-01-02 07:08:22 +00:00
porting_to_kmk.md update docs and examples 2022-04-09 14:40:40 -07:00
power.md docs and typos 2021-06-25 10:53:58 -07:00
README.md documentation about documentation 2022-03-18 17:15:01 -07:00
rgb.md base animation speed on system timer 2022-02-25 16:04:09 -08:00
scanners.md implements scanner with rotaryio 2022-04-17 18:33:34 -07:00
sequences.md Add example of simple_key_sequence 2022-02-25 16:04:20 -08:00
split_keyboards.md Add simple PIO manual to split doc 2022-02-16 17:59:59 -08:00
support.md feat(extensions): most of the extensions implementation, by kdb424 2021-06-20 13:55:16 -07:00
tapdance.md make TapDance a module (#281) 2022-01-18 05:21:05 +00:00

README.md

Documentation index

Before you look further, you probably want to start with our getting started guide

Basics

Advanced

Modules

  • Combos: Adds chords and sequences
  • Layers: Adds layer support (Fn key) to allow many more keys to be put on your keyboard
  • ModTap: Adds support for augmented modifier keys to act as one key when tapped, and modifier when held.
  • Mouse keys: Adds mouse keycodes
  • OneShot: Adds support for oneshot/sticky keys.
  • Power: Power saving features. This is mostly useful when on battery power.
  • Split: Keyboards split in two. Seems ergonomic!
  • TapDance: Different key actions depending on how often it is pressed.

Peripherals

Extensions

  • International: Adds international keycodes
  • LED: Adds backlight support. This is for monocolor backlight, not RGB
  • LockStatus: Exposes host-side locks like caps or num lock.
  • MediaKeys: Adds support for media keys such as volume
  • RGB: RGB lighting for underglow. Will work on most matrix RGB as will be treated the same as underglow.
  • Status LED: Indicates which layer you are on with an array of single leds.

Language versions