|
1 |
| -# Kiibohd Controller - Scan Modules |
| 1 | +# Kiibohd Controller - Macro Modules |
2 | 2 |
|
3 |
| -Scan Modules are the main control module within the Kiibohd Controller. |
4 |
| -They are given preferential control over the main execution loop. |
5 |
| -This is important for timing sensitive operations such as key matrix scanning and protocol converters. |
| 3 | +Macro Modules are the main event controllers within the Kiibohd Controller. |
| 4 | +This is where keyboard events are processed, queued and resulting actions are generated. |
6 | 5 |
|
7 |
| -There are two types of Scan Modules: main and sub-modules. |
| 6 | +The two main areas for Macro Modules: KLL trigger:result and KLL pixel control. |
8 | 7 |
|
9 |
| -The main modules are what defines the behaviour of the execution loop, such as WhiteFox or K-Type. |
10 |
| - |
11 |
| -The sub-modules are usually found inside the [Devices](Devices) folder. |
12 |
| -Device sub-modules are drivers or sub-functionality that may be used by main Scan Modules. |
| 8 | +PixelMap depends on PartialMap as PixelMap enables support for the Pixel Control aspects of KLL. |
13 | 9 |
|
14 | 10 |
|
15 | 11 | ## Modules
|
16 | 12 |
|
17 | 13 | Brief descriptions of each of the modules.
|
18 | 14 |
|
19 |
| -### Input Club Supported |
20 |
| - |
21 |
| -* [Infinity_60](Infinity_60) - Infinity 60% Scan Module |
22 |
| -* [Infinity_60_LED](Infinity_60_LED) - Infinity 60% with LED support |
23 |
| -* [Infinity_Ergodox](Infinity_Ergodox) - Infinity Ergodox Scan Module |
24 |
| -* [Kira](Kira) - Kira Scan Module |
25 |
| -* [K-Type](K-Type) - K-Type Scan Module |
26 |
| -* [WhiteFox](WhiteFox) - WhiteFox Scan Module |
27 |
| - |
28 |
| - |
29 |
| -### Sub-Modules |
30 |
| - |
31 |
| -* [Devices](Devices) - Sub-module device drivers |
32 |
| - |
| 15 | +* [PartialMap](PartialMap) - trigger:result + layer implementation of KLL (Keyboard Layout Language) |
| 16 | +* [PixelMap](PixelMap) - Pixel control implemenation of KLL |
33 | 17 |
|
34 |
| -### Other |
| 18 | +### Deprecated |
35 | 19 |
|
36 |
| -* [CK3](CK3) - Ghosted matrix keyboard (2KRO) |
37 |
| -* [Deprecated](Deprecated) - Old Scan Modules that are no longer maintained but may still have useful code. |
38 |
| -* [PS2](PS2) - PS/2 Converter using a Teensy 3.2 |
| 20 | +* [buffer](buffer) - Original macro/mapping control for the Kiibohd Controller (pre-dates KLL). |
39 | 21 |
|
0 commit comments