sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

requested changes

Browse Source
This commit is contained in:
Kyle Brown
2020-11-06 01:16:29 -08:00
parent 7a2bed8cdd
commit dea771fd7f
28 changed files with 263 additions and 158 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/split_keyboards.md
View File

@@ -3,7 +3,8 @@ Split keyboards are mostly the same as unsplit. Wired UART and Bluetooth are sup
## Wired UART
Wired connections can use UART over 1 or 2 wires. With 2 wires, you will be able to syncronize the halves allowing additional features in some extentions.
Wired connections can use UART over 1 or 2 wires. With 2 wires, you will be able
to syncronize the halves allowing additional features in some extentions.
```python
import board
from kmk.extensions.split import Split
@@ -21,7 +22,7 @@ Useful config options:
extra_data_pin=None, # Second uart pin to allow 2 way communication
split_offset=None, # Default is column pins but allows an override
split_flip=True, # If both halves are the same, but flipped, set this True
split_side=None, # Sets if this is the left or right
split_side=None, # Sets if this is to 0 if left, 1 if right, or use EE hands
split_type=SplitType.UART, # Defaults to UART
target_left=True, # Assumes that left will be the one on USB. Set to folse if it will be the right
uart_flip=True, # Reverses the RX and TX pins if both are provided
@@ -34,8 +35,9 @@ Useful config options:
## Bluetooth split (aka no TRRS)
Wireless splits are fully featured with 2 way communication allowing all extentions to work 100%.
```python
split_side = 'Left'
split_side = 'Right'
split_side = 0 # Left
OR
split_side = 1 # Right
split = BLE_Split(split_side=split_side)
keyboard.extensions.append(split)
@@ -53,15 +55,18 @@ Useful config options:
```
### EE HANDS
If you want to plug USB in on either side, or are using bluetooth, this is for you. Pick one of the 2 options but not both.
If you want to plug USB in on either side, or are using bluetooth, this is for
you. Pick one of the 2 options but not both.
## Renaming CIRCUITPY Drive
The easiest way is to rename your CIRCUITPY drive to something. The left side must end in L, the right must in in R.
The name must be 11 characters or less! This is a limitation of the filesystem. You will receive an error if you choose a
name longer than 11 characters. Instructions on how to do that are [here](https://learn.adafruit.com/welcome-to-circuitpython/the-circuitpy-drive).
The easiest way is to rename your CIRCUITPY drive to something. The left side must
end in L, the right must is in R. The name must be 11 characters or less! This is
a limitation of the filesystem. You will receive an error if you choose a name
longer than 11 characters. Instructions on how to do that are
[here](https://learn.adafruit.com/welcome-to-circuitpython/the-circuitpy-drive).
For example on NYQUISTL for left and NYQUISTR for the right.
For wired connections you are done. For bluetooth, remove the `split_side` like tihs
For wired connections you are done. For bluetooth, remove the `split_side` like this
```python
split = BLE_Split()
@@ -74,9 +79,9 @@ If you have changed the name of the drive as stated above, do not follow this se
On each half of your keyboard make a file called kmk_side.py and add one of these lines to the file
depending on where each piece is physically located.
```python
split_side = "Left"
split_side = 0 # Left
OR
split_side = "Right"
split_side = 1 # Right
```
and then in your keymap, add the line