drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

[MERGE] Consolidate EE Hands with MASTER_LEFT/RIGHT and simplify behavior (24162)

Browse source
This commit is contained in:
Drashna Jael're 2024-07-20 17:20:01 -07:00
parent 9e7acf446f
commit 70b56b2074
Signed by: drashna
GPG key ID: DBA1FD3A860D1B11
143 changed files with 159 additions and 1220 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/features/bootmagic.md
View file

@ -25,7 +25,7 @@ Using Bootmagic will **always reset** the EEPROM, so you will lose any settings
## Split Keyboards
When [handedness](split_keyboard#setting-handedness) is predetermined via options like `SPLIT_HAND_PIN` or `EE_HANDS`, you might need to configure a different key between halves. To identify the correct key for the right half, examine the split key matrix defined in the `<keyboard>.h` file, e.g.:
When [handedness](split_keyboard#setting-handedness) is predetermined via options like `SPLIT_HAND_PIN` or EEPROM, you might need to configure a different key between halves. To identify the correct key for the right half, examine the split key matrix defined in the `<keyboard>.h` file, e.g.:
```c
#define LAYOUT_split_3x5_2( \

2
docs/features/pointing_device.md
View file

@ -463,7 +463,7 @@ The following configuration options are only available when using `SPLIT_POINTIN
| `POINTING_DEVICE_INVERT_Y_RIGHT` | (Optional) Inverts the Y axis report. | _not defined_ |
::: warning
If there is a `_RIGHT` configuration option or callback, the [common configuration](pointing_device#common-configuration) option will work for the left. For correct left/right detection you should setup a [handedness option](split_keyboard#setting-handedness), `EE_HANDS` is usually a good option for an existing board that doesn't do handedness by hardware.
If there is a `_RIGHT` configuration option or callback, the [common configuration](pointing_device#common-configuration) option will work for the left. For correct left/right detection you should setup a [handedness option](split_keyboard#setting-handedness), Using EEPROM is usually a good option for an existing board that doesn't do handedness by hardware.
:::

26
docs/features/split_keyboard.md
View file

@ -143,13 +143,6 @@ While `MATRIX_MASKED` isn't necessary to use `SPLIT_HAND_MATRIX_GRID` successful
This method sets the keyboard's handedness by setting a flag in the persistent storage (`EEPROM`). This is checked when the controller first starts up, and determines what half the keyboard is, and how to orient the keyboard layout.
To enable this method, add the following to your `config.h` file:
```c
#define EE_HANDS
```
Next, you will have to flash the correct handedness option to the controller on each halve. You can do this manually with the following bootloader targets using `qmk flash -kb <keyboard> -km <keymap> -bl <bootloader>` command to flash:
|Microcontroller Type|Bootloader Parameter|
@ -181,25 +174,6 @@ This setting is not changed when re-initializing the EEPROM using the `EE_CLR` k
You can find the `EEPROM` files in the QMK firmware repo, [here](https://github.com/qmk/qmk_firmware/tree/master/quantum/split_common).
#### Handedness by `#define`
You can use this option when USB cable is always connected to just one side of the split keyboard.
If the USB cable is always connected to the right side, add the following to your `config.h` file and flash both sides with this option:
```c
#define MASTER_RIGHT
```
If the USB cable is always connected to the left side, add the following to your `config.h` file and flash both sides with this option:
```c
#define MASTER_LEFT
```
::: tip
If neither options are defined, the handedness defaults to `MASTER_LEFT`.
:::
### Communication Options
Because not every split keyboard is identical, there are a number of additional options that can be configured in your `config.h` file.