kmk_firmware/docs/modules.md

# Modules
Modules, unlike extensions, change how your keyboard works. These are meant to have
the ability to alter the core code in any way. Unlike extensions, these are not in a
sandbox, and can make massive changes to normal operation.

## Core Modules
These modules are provided in all builds and can be enabled. Currently offered
modules are

- [Combos](combos.md): Adds chords and sequences
- [Layers](layers.md): Adds layer support (Fn key) to allow many more keys to be
put on your keyboard.
- [ModTap](modtap.md): Adds support for augmented modifier keys to act as one key
when tapped, and modifier when held.
- [Mouse keys](mouse_keys.md): Adds mouse keycodes.
- [OneShot](oneshot.md): Adds support for oneshot/sticky keys.
- [Power](power.md): Power saving features. This is mostly useful when on battery power.
- [Split](split_keyboards.md): Keyboards split in two. Seems ergonomic!
- [SerialACE](serialace.md): Arbitrary Code Execution over the data serial.
- [TapDance](tapdance.md): Different key actions depending on how often it is pressed.
- [Dynamic Sequences](dynamic_sequences.md): Records a sequence of keypresses and plays it back.

### Require Libraries
These modules can be used without specific hardware, but require additional libraries such as the `Adafruit CircuitPython Bundle`.

 - [MIDI](midi.md): Adds sending MIDI data in the form of keymap entries.


### Peripherals
These modules are for specific hardware and may require additional libraries to function.
- [ADNS9800](adns9800.md): Controlling ADNS9800 optical sensor.
- [Encoder](encoder.md): Handling rotary encoders.
- [Pimoroni trackball](pimoroni_trackball.md): Handling a small I2C trackball made by Pimoroni.
- [AS5013 aka EasyPoint](easypoint.md): Handling a small I2C magnetic position sensor made by AMS.
feat(extensions): most of the extensions implementation, by kdb424 2020-10-21 21:19:42 +02:00			`# Modules`
			`Modules, unlike extensions, change how your keyboard works. These are meant to have`
			`the ability to alter the core code in any way. Unlike extensions, these are not in a`
			`sandbox, and can make massive changes to normal operation.`

			`## Core Modules`
MIDI module and docs 2022-03-03 05:22:58 +01:00			`These modules are provided in all builds and can be enabled. Currently offered`
feat(extensions): most of the extensions implementation, by kdb424 2020-10-21 21:19:42 +02:00			`modules are`

implement combo/chord/sequence module 2022-03-09 02:27:56 +01:00			`- [Combos](combos.md): Adds chords and sequences`
feat(extensions): most of the extensions implementation, by kdb424 2020-10-21 21:19:42 +02:00			`- [Layers](layers.md): Adds layer support (Fn key) to allow many more keys to be`
MIDI module and docs 2022-03-03 05:22:58 +01:00			`put on your keyboard.`
feat(extensions): most of the extensions implementation, by kdb424 2020-10-21 21:19:42 +02:00			`- [ModTap](modtap.md): Adds support for augmented modifier keys to act as one key`
			`when tapped, and modifier when held.`
MIDI module and docs 2022-03-03 05:22:58 +01:00			`- [Mouse keys](mouse_keys.md): Adds mouse keycodes.`
implements oneshot/sticky keys. 2022-02-13 23:30:31 +01:00			`- [OneShot](oneshot.md): Adds support for oneshot/sticky keys.`
feat(extensions): most of the extensions implementation, by kdb424 2020-10-21 21:19:42 +02:00			`- [Power](power.md): Power saving features. This is mostly useful when on battery power.`
			`- [Split](split_keyboards.md): Keyboards split in two. Seems ergonomic!`
update and add docs to serialace 2022-08-17 18:35:43 +02:00			`- [SerialACE](serialace.md): Arbitrary Code Execution over the data serial.`
make TapDance a module (#281) * extract tapdance logic into a module * clean out old tapdance code * canonicalize key variable names * split _process_tap_dance into td_pressed and td_released * implement consistent argument order * update documentation * implement Module.process_key for key interception and modification * fix tapdance realesing instead of pressing * fix: default parameters in key handler * cleanup holdtap * add error handling to modules process_key * fix: key released too late Tapped keys didn't release on a "key released" event, but waited for a timeout. Resulted in, for example, modifiers applying to keys after the modifier was released. * fix lint/formatting * fix tap_time reference in modtap + minimal documentation * fix lint 2022-01-18 06:21:05 +01:00			`- [TapDance](tapdance.md): Different key actions depending on how often it is pressed.`
Added Dynamic Sequences to modules.md 2022-05-16 04:26:15 +02:00			`- [Dynamic Sequences](dynamic_sequences.md): Records a sequence of keypresses and plays it back.`
Add doc index 2022-02-24 06:56:33 +01:00
MIDI module and docs 2022-03-03 05:22:58 +01:00			`### Require Libraries`
			These modules can be used without specific hardware, but require additional libraries such as the `Adafruit CircuitPython Bundle`.

			`- [MIDI](midi.md): Adds sending MIDI data in the form of keymap entries.`


Add doc index 2022-02-24 06:56:33 +01:00			`### Peripherals`
MIDI module and docs 2022-03-03 05:22:58 +01:00			`These modules are for specific hardware and may require additional libraries to function.`
			`- [ADNS9800](adns9800.md): Controlling ADNS9800 optical sensor.`
			`- [Encoder](encoder.md): Handling rotary encoders.`
			`- [Pimoroni trackball](pimoroni_trackball.md): Handling a small I2C trackball made by Pimoroni.`
spelling/capitalization/usage on proper nouns correct usage sourced from: * websites of respective trademark holders * Wiktionary * Wikipedia 2022-04-24 21:33:35 +02:00			`- [AS5013 aka EasyPoint](easypoint.md): Handling a small I2C magnetic position sensor made by AMS.`