aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_mouse_keys.md28
-rw-r--r--docs/feature_rgb_matrix.md22
-rw-r--r--docs/feature_rgblight.md11
-rw-r--r--docs/feature_split_keyboard.md10
-rw-r--r--docs/ja/proton_c_conversion.md1
-rw-r--r--docs/proton_c_conversion.md1
-rw-r--r--docs/reference_info_json.md157
-rw-r--r--docs/reference_keymap_extras.md2
-rw-r--r--docs/serial_driver.md1
9 files changed, 210 insertions, 23 deletions
diff --git a/docs/feature_mouse_keys.md b/docs/feature_mouse_keys.md
index ffde13389..a0d02416f 100644
--- a/docs/feature_mouse_keys.md
+++ b/docs/feature_mouse_keys.md
@@ -42,6 +42,7 @@ In your keymap you can use the following keycodes to map key presses to mouse ac
42Mouse keys supports three different modes to move the cursor: 42Mouse keys supports three different modes to move the cursor:
43 43
44* **Accelerated (default):** Holding movement keys accelerates the cursor until it reaches its maximum speed. 44* **Accelerated (default):** Holding movement keys accelerates the cursor until it reaches its maximum speed.
45* **Kinetic:** Holding movement keys accelerates the cursor with its speed following a quadratic curve until it reaches its maximum speed.
45* **Constant:** Holding movement keys moves the cursor at constant speeds. 46* **Constant:** Holding movement keys moves the cursor at constant speeds.
46* **Combined:** Holding movement keys accelerates the cursor until it reaches its maximum speed, but holding acceleration and movement keys simultaneously moves the cursor at constant speeds. 47* **Combined:** Holding movement keys accelerates the cursor until it reaches its maximum speed, but holding acceleration and movement keys simultaneously moves the cursor at constant speeds.
47 48
@@ -56,7 +57,8 @@ This is the default mode. You can adjust the cursor and scrolling acceleration u
56|Define |Default|Description | 57|Define |Default|Description |
57|----------------------------|-------|---------------------------------------------------------| 58|----------------------------|-------|---------------------------------------------------------|
58|`MOUSEKEY_DELAY` |300 |Delay between pressing a movement key and cursor movement| 59|`MOUSEKEY_DELAY` |300 |Delay between pressing a movement key and cursor movement|
59|`MOUSEKEY_INTERVAL` |50 |Time between cursor movements | 60|`MOUSEKEY_INTERVAL` |50 |Time between cursor movements in milliseconds |
61|`MOUSEKEY_MOVE_DELTA` |5 |Step size |
60|`MOUSEKEY_MAX_SPEED` |10 |Maximum cursor speed at which acceleration stops | 62|`MOUSEKEY_MAX_SPEED` |10 |Maximum cursor speed at which acceleration stops |
61|`MOUSEKEY_TIME_TO_MAX` |20 |Time until maximum cursor speed is reached | 63|`MOUSEKEY_TIME_TO_MAX` |20 |Time until maximum cursor speed is reached |
62|`MOUSEKEY_WHEEL_DELAY` |300 |Delay between pressing a wheel key and wheel movement | 64|`MOUSEKEY_WHEEL_DELAY` |300 |Delay between pressing a wheel key and wheel movement |
@@ -73,6 +75,30 @@ Tips:
73 75
74Cursor acceleration uses the same algorithm as the X Window System MouseKeysAccel feature. You can read more about it [on Wikipedia](https://en.wikipedia.org/wiki/Mouse_keys). 76Cursor acceleration uses the same algorithm as the X Window System MouseKeysAccel feature. You can read more about it [on Wikipedia](https://en.wikipedia.org/wiki/Mouse_keys).
75 77
78### Kinetic Mode
79
80This is an extension of the accelerated mode. The kinetic mode uses a quadratic curve on the cursor speed which allows precise movements at the beginning and allows to cover large distances by increasing cursor speed quickly thereafter. You can adjust the cursor and scrolling acceleration using the following settings in your keymap’s `config.h` file:
81
82|Define |Default |Description |
83|--------------------------------------|---------|---------------------------------------------------------------|
84|`MK_KINETIC_SPEED` |undefined|Enable kinetic mode |
85|`MOUSEKEY_DELAY` |8 |Delay between pressing a movement key and cursor movement |
86|`MOUSEKEY_INTERVAL` |8 |Time between cursor movements in milliseconds |
87|`MOUSEKEY_MOVE_DELTA` |25 |Step size for accelerating from initial to base speed |
88|`MOUSEKEY_INITIAL_SPEED` |100 |Initial speed of the cursor in pixel per second |
89|`MOUSEKEY_BASE_SPEED` |1000 |Maximum cursor speed at which acceleration stops |
90|`MOUSEKEY_DECELERATED_SPEED` |400 |Decelerated cursor speed |
91|`MOUSEKEY_ACCELERATED_SPEED` |3000 |Accelerated cursor speed |
92|`MOUSEKEY_WHEEL_INITIAL_MOVEMENTS` |16 |Initial number of movements of the mouse wheel |
93|`MOUSEKEY_WHEEL_BASE_MOVEMENTS` |32 |Maximum number of movements at which acceleration stops |
94|`MOUSEKEY_WHEEL_ACCELERATED_MOVEMENTS`|48 |Accelerated wheel movements |
95|`MOUSEKEY_WHEEL_DECELERATED_MOVEMENTS`|8 |Decelerated wheel movements |
96
97Tips:
98
99* The smoothness of the cursor movement depends on the `MOUSEKEY_INTERVAL` setting. The shorter the interval is set the smoother the movement will be. Setting the value too low makes the cursor unresponsive. Lower settings are possible if the micro processor is fast enough. For example: At an interval of `8` milliseconds, `125` movements per second will be initiated. With a base speed of `1000` each movement will move the cursor by `8` pixels.
100* Mouse wheel movements are implemented differently from cursor movements. While it's okay for the cursor to move multiple pixels at once for the mouse wheel this would lead to jerky movements. Instead, the mouse wheel operates at step size `1`. Setting mouse wheel speed is done by adjusting the number of wheel movements per second.
101
76### Constant mode 102### Constant mode
77 103
78In this mode you can define multiple different speeds for both the cursor and the mouse wheel. There is no acceleration. `KC_ACL0`, `KC_ACL1` and `KC_ACL2` change the cursor and scroll speed to their respective setting. 104In this mode you can define multiple different speeds for both the cursor and the mouse wheel. There is no acceleration. `KC_ACL0`, `KC_ACL1` and `KC_ACL2` change the cursor and scroll speed to their respective setting.
diff --git a/docs/feature_rgb_matrix.md b/docs/feature_rgb_matrix.md
index a9e711c9f..bb0acba3b 100644
--- a/docs/feature_rgb_matrix.md
+++ b/docs/feature_rgb_matrix.md
@@ -129,6 +129,28 @@ Configure the hardware via your `config.h`:
129 129
130--- 130---
131 131
132### APA102 :id=apa102
133
134There is basic support for APA102 based addressable LED strands. To enable it, add this to your `rules.mk`:
135
136```makefile
137RGB_MATRIX_ENABLE = yes
138RGB_MATRIX_DRIVER = APA102
139```
140
141Configure the hardware via your `config.h`:
142
143```c
144// The pin connected to the data pin of the LEDs
145#define RGB_DI_PIN D7
146// The pin connected to the clock pin of the LEDs
147#define RGB_CI_PIN D6
148// The number of LEDs connected
149#define DRIVER_LED_TOTAL 70
150```
151
152---
153
132From this point forward the configuration is the same for all the drivers. The `led_config_t` struct provides a key electrical matrix to led index lookup table, what the physical position of each LED is on the board, and what type of key or usage the LED if the LED represents. Here is a brief example: 154From this point forward the configuration is the same for all the drivers. The `led_config_t` struct provides a key electrical matrix to led index lookup table, what the physical position of each LED is on the board, and what type of key or usage the LED if the LED represents. Here is a brief example:
133 155
134```c 156```c
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md
index 762056b34..f1178c679 100644
--- a/docs/feature_rgblight.md
+++ b/docs/feature_rgblight.md
@@ -10,6 +10,7 @@ Currently QMK supports the following addressable LEDs (however, the white LED in
10 10
11 * WS2811, WS2812, WS2812B, WS2812C, etc. 11 * WS2811, WS2812, WS2812B, WS2812C, etc.
12 * SK6812, SK6812MINI, SK6805 12 * SK6812, SK6812MINI, SK6805
13 * APA102
13 14
14These LEDs are called "addressable" because instead of using a wire per color, each LED contains a small microchip that understands a special protocol sent over a single wire. The chip passes on the remaining data to the next LED, allowing them to be chained together. In this way, you can easily control the color of the individual LEDs. 15These LEDs are called "addressable" because instead of using a wire per color, each LED contains a small microchip that understands a special protocol sent over a single wire. The chip passes on the remaining data to the next LED, allowing them to be chained together. In this way, you can easily control the color of the individual LEDs.
15 16
@@ -21,11 +22,19 @@ On keyboards with onboard RGB LEDs, it is usually enabled by default. If it is n
21RGBLIGHT_ENABLE = yes 22RGBLIGHT_ENABLE = yes
22``` 23```
23 24
24At minimum you must define the data pin your LED strip is connected to, and the number of LEDs in the strip, in your `config.h`. If your keyboard has onboard RGB LEDs, and you are simply creating a keymap, you usually won't need to modify these. 25For APA102 LEDs, add the following to your `rules.mk`:
26
27```make
28RGBLIGHT_ENABLE = yes
29RGBLIGHT_DRIVER = APA102
30```
31
32At minimum you must define the data pin your LED strip is connected to, and the number of LEDs in the strip, in your `config.h`. For APA102 LEDs, you must also define the clock pin. If your keyboard has onboard RGB LEDs, and you are simply creating a keymap, you usually won't need to modify these.
25 33
26|Define |Description | 34|Define |Description |
27|---------------|---------------------------------------------------------------------------------------------------------| 35|---------------|---------------------------------------------------------------------------------------------------------|
28|`RGB_DI_PIN` |The pin connected to the data pin of the LEDs | 36|`RGB_DI_PIN` |The pin connected to the data pin of the LEDs |
37|`RGB_CI_PIN` |The pin connected to the clock pin of the LEDs (APA102 only) |
29|`RGBLED_NUM` |The number of LEDs connected | 38|`RGBLED_NUM` |The number of LEDs connected |
30|`RGBLED_SPLIT` |(Optional) For split keyboards, the number of LEDs connected on each half directly wired to `RGB_DI_PIN` | 39|`RGBLED_SPLIT` |(Optional) For split keyboards, the number of LEDs connected on each half directly wired to `RGB_DI_PIN` |
31 40
diff --git a/docs/feature_split_keyboard.md b/docs/feature_split_keyboard.md
index b23411420..c285e353d 100644
--- a/docs/feature_split_keyboard.md
+++ b/docs/feature_split_keyboard.md
@@ -181,6 +181,16 @@ If you're having issues with serial communication, you can change this value, as
181* **`4`**: about 26kbps 181* **`4`**: about 26kbps
182* **`5`**: about 20kbps 182* **`5`**: about 20kbps
183 183
184```c
185#define SPLIT_MODS_ENABLE
186```
187
188This enables transmitting modifier state (normal, weak and oneshot) to the non
189primary side of the split keyboard. This adds a few bytes of data to the split
190communication protocol and may impact the matrix scan speed when enabled.
191The purpose of this feature is to support cosmetic use of modifer state (e.g.
192displaying status on an OLED screen).
193
184### Hardware Configuration Options 194### Hardware Configuration Options
185 195
186There are some settings that you may need to configure, based on how the hardware is set up. 196There are some settings that you may need to configure, based on how the hardware is set up.
diff --git a/docs/ja/proton_c_conversion.md b/docs/ja/proton_c_conversion.md
index 6e4f7dcb6..e7c07413c 100644
--- a/docs/ja/proton_c_conversion.md
+++ b/docs/ja/proton_c_conversion.md
@@ -51,6 +51,7 @@ Proton C には1つのオンボード LED(C13)しかなく、デフォルトで
51 51
52``` 52```
53MCU = STM32F303 53MCU = STM32F303
54BOARD = QMK_PROTON_C
54``` 55```
55 56
56次の変数が存在する場合は削除します。 57次の変数が存在する場合は削除します。
diff --git a/docs/proton_c_conversion.md b/docs/proton_c_conversion.md
index 1b5e496e7..47511e1b1 100644
--- a/docs/proton_c_conversion.md
+++ b/docs/proton_c_conversion.md
@@ -44,6 +44,7 @@ To use the Proton C natively, without having to specify `CTPC=yes`, you need to
44 44
45``` 45```
46MCU = STM32F303 46MCU = STM32F303
47BOARD = QMK_PROTON_C
47``` 48```
48 49
49Remove these variables if they exist: 50Remove these variables if they exist:
diff --git a/docs/reference_info_json.md b/docs/reference_info_json.md
index 3ca62c719..47506bc92 100644
--- a/docs/reference_info_json.md
+++ b/docs/reference_info_json.md
@@ -19,8 +19,20 @@ The `info.json` file is a JSON formatted dictionary with the following keys avai
19 * Width of the board in Key Units 19 * Width of the board in Key Units
20* `height` 20* `height`
21 * Height of the board in Key Units 21 * Height of the board in Key Units
22* `debounce`
23 * How many milliseconds (ms) to wait for debounce to happen. (Default: 5)
24* `diode_direction`
25 * The direction diodes face. See [`DIRECT_PINS` in the hardware configuration](https://docs.qmk.fm/#/config_options?id=hardware-options) for more details.
26* `layout_aliases`
27 * A dictionary containing layout aliases. The key is the alias and the value is a layout in `layouts` it maps to.
22* `layouts` 28* `layouts`
23 * Physical Layout representations. See the next section for more detail. 29 * Physical Layout representations. See the [Layout Format](#layout_format) section for more detail.
30* `matrix_pins`
31 * Configure the pins corresponding to columns and rows, or direct pins. See [Matrix Pins](#matrix_pins) for more detail.
32* `rgblight`
33 * Configure the [RGB Lighting feature](feature_rgblight.md). See the [RGB Lighting](#rgb_lighting) section for more detail.
34* `usb`
35 * Configure USB VID, PID, and other parameters. See [USB](#USB) for more detail.
24 36
25### Layout Format 37### Layout Format
26 38
@@ -49,25 +61,128 @@ All key positions and rotations are specified in relation to the top-left corner
49 * The width of the key, in Key Units. Ignored if `ks` is provided. Default: `1` 61 * The width of the key, in Key Units. Ignored if `ks` is provided. Default: `1`
50* `h` 62* `h`
51 * The height of the key, in Key Units. Ignored if `ks` is provided. Default: `1` 63 * The height of the key, in Key Units. Ignored if `ks` is provided. Default: `1`
52* `r`
53 * How many degrees clockwise to rotate the key.
54* `rx`
55 * The absolute position of the point to rotate the key around in the horizontal axis. Default: `x`
56* `ry`
57 * The absolute position of the point to rotate the key around in the vertical axis. Default: `y`
58* `ks`
59 * Key Shape: define a polygon by providing a list of points, in Key Units.
60 * **Important**: These are relative to the top-left of the key, not absolute.
61 * Example ISO Enter: `[ [0,0], [1.5,0], [1.5,2], [0.25,2], [0.25,1], [0,1], [0,0] ]`
62* `label` 64* `label`
63 * What to name this position in the matrix. 65 * What to name this position in the matrix.
64 * This should usually be the same name as what is silkscreened on the PCB at this location. 66 * This should usually correspond to the keycode for the first layer of the default keymap.
65 67* `matrix`
66## How is the Metadata Exposed? 68 * A 2 item list describing the row and column location for this key.
67 69
68This metadata is primarily used in two ways: 70### Matrix Pins
69 71
70* To allow web-based configurators to dynamically generate UI 72Currently QMK supports connecting switches either directly to GPIO pins or via a switch matrix. At this time you can not combine these, they are mutually exclusive.
71* To support the new `make keyboard:keymap:qmk` target, which bundles this metadata up with the firmware to allow QMK Toolbox to be smarter. 73
72 74#### Switch Matrix
73Configurator authors can see the [QMK Compiler](https://docs.api.qmk.fm/using-the-api) docs for more information on using the JSON API. 75
76Most keyboards use a switch matrix to connect keyswitches to the MCU. You can define your pin columns and rows to configure your switch matrix. When defining switch matrices you should also define your `diode_direction`.
77
78Example:
79
80```json
81{
82 "diode_direction": "COL2ROW",
83 "matrix_pins": {
84 "cols": ["F4", "E6", "B1", "D2"],
85 "rows": ["B0", "D3", "D5", "D4", "D6"]
86 }
87}
88```
89
90#### Direct Pins
91
92Direct pins are when you connect one side of the switch to GND and the other side to a GPIO pin on your MCU. No diode is required, but there is a 1:1 mapping between switches and pins.
93
94When specifying direct pins you need to arrange them in nested arrays. The outer array consists of rows, while the inner array is a text string corresponding to a pin. You can use `null` to indicate an empty spot in the matrix.
95
96Example:
97
98```json
99{
100 "matrix_pins": {
101 "direct": [
102 ["A10", "A9"],
103 ["A0", "B8"],
104 [null, "B11"],
105 ["B9", "A8"],
106 ["A7", "B1"],
107 [null, "B2"]
108 ]
109}
110```
111
112### RGB Lighting
113
114This section controls the legacy WS2812 support in QMK. This should not be confused with the RGB Matrix feature, which can be used to control both WS2812 and ISSI RGB LEDs.
115
116The following items can be set. Not every value is required.
117
118* `led_count`
119 * The number of LEDs in your strip
120* `pin`
121 * The GPIO pin that your LED strip is connected to
122* `animations`
123 * A dictionary that lists enabled and disabled animations. See [RGB Light Animations](#rgb_light_animations) below.
124* `sleep`
125 * Set to `true` to enable lighting during host sleep
126* `split`
127 * Set to `true` to enable synchronization functionality between split halves
128* `split_count`
129 * For split keyboards, the number of LEDs on each side
130* `max_brightness`
131 * (0-255) What the maxmimum brightness (value) level is
132* `hue_steps`
133 * How many steps of adjustment to have for hue
134* `saturation_steps`
135 * How many steps of adjustment to have for saturation
136* `brightness_steps`
137 * How many steps of adjustment to have for brightness (value)
138
139Example:
140
141```json
142{
143 "rgblight": {
144 "led_count": 4,
145 "pin": "F6",
146 "hue_steps": 10,
147 "saturation_steps": 17,
148 "brightness_steps": 17,
149 "animations": {
150 "all": true
151 }
152 }
153}
154```
155
156#### RGB Light Animations
157
158The following animations can be enabled:
159
160| Key | Description |
161|-----|-------------|
162| `all` | Enable all additional animation modes. |
163| `alternating` | Enable alternating animation mode. |
164| `breathing` | Enable breathing animation mode. |
165| `christmas` | Enable christmas animation mode. |
166| `knight` | Enable knight animation mode. |
167| `rainbow_mood` | Enable rainbow mood animation mode. |
168| `rainbow_swirl` | Enable rainbow swirl animation mode. |
169| `rgb_test` | Enable RGB test animation mode. |
170| `snake` | Enable snake animation mode. |
171| `static_gradient` | Enable static gradient mode. |
172| `twinkle` | Enable twinkle animation mode. |
173
174### USB
175
176Every USB keyboard needs to have its USB parmaters defined. At a minimum you need to set vid, pid, and device version.
177
178Example:
179
180```json
181{
182 "usb": {
183 "vid": "0xC1ED",
184 "pid": "0x23B0",
185 "device_ver": "0x0001"
186 }
187}
188```
diff --git a/docs/reference_keymap_extras.md b/docs/reference_keymap_extras.md
index f2abb4e59..40a195684 100644
--- a/docs/reference_keymap_extras.md
+++ b/docs/reference_keymap_extras.md
@@ -18,7 +18,9 @@ To use these, simply `#include` the corresponding [header file](https://github.c
18|Dutch (Belgium) |`keymap_belgian.h` | 18|Dutch (Belgium) |`keymap_belgian.h` |
19|English (Ireland) |`keymap_irish.h` | 19|English (Ireland) |`keymap_irish.h` |
20|English (UK) |`keymap_uk.h` | 20|English (UK) |`keymap_uk.h` |
21|English (US Extended) |`keymap_us_extended.h` |
21|English (US International) |`keymap_us_international.h` | 22|English (US International) |`keymap_us_international.h` |
23|English (US International, Linux)|`keymap_us_international_linux.h`|
22|Estonian |`keymap_estonian.h` | 24|Estonian |`keymap_estonian.h` |
23|Finnish |`keymap_finnish.h` | 25|Finnish |`keymap_finnish.h` |
24|French |`keymap_french.h` | 26|French |`keymap_french.h` |
diff --git a/docs/serial_driver.md b/docs/serial_driver.md
index bc376b6dd..c98f4c117 100644
--- a/docs/serial_driver.md
+++ b/docs/serial_driver.md
@@ -60,6 +60,7 @@ Configure the hardware via your config.h:
60 // 5: about 19200 baud 60 // 5: about 19200 baud
61#define SERIAL_USART_DRIVER SD1 // USART driver of TX pin. default: SD1 61#define SERIAL_USART_DRIVER SD1 // USART driver of TX pin. default: SD1
62#define SERIAL_USART_TX_PAL_MODE 7 // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 7 62#define SERIAL_USART_TX_PAL_MODE 7 // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 7
63#define SERIAL_USART_TIMEOUT 100 // USART driver timeout. default 100
63``` 64```
64 65
65You must also enable the ChibiOS `SERIAL` feature: 66You must also enable the ChibiOS `SERIAL` feature: