Skip to main content

Split Keyboards

Split keyboards are mostly the same as unsplit. Wired UART is fully supported, and testing of Bluetooth splits, though we don't currently offer support for this.

Notice that this Split module must be added after the ModTap module to the keyboard.modules.

Wired UART

Wired connections can use UART over 1 or 2 wires. With 2 wires, you will be able to synchronize the halves allowing additional features in some extensions.

from kb import data_pin
from kmk.modules.split import Split, SplitSide

split = Split(split_side=SplitSide.LEFT)
keyboard.modules.append(split)

Bluetooth split (aka no TRRS) [Currently in testing]

Wireless splits are fully featured with 2 way communication allowing all extensions to work 100%.

from kb import data_pin
from kmk.modules.split import Split, SplitType, SplitSide


split = Split(split_type=SplitType.BLE, split_side=SplitSide.LEFT)
OR
split = Split(split_type=SplitType.BLE, split_side=SplitSide.LEFT)
keyboard.modules.append(split)

Config

Useful config options:

split = Split(
split_flip=True, # If both halves are the same, but flipped, set this True
split_side=None, # Sets if this is to SplitSide.LEFT or SplitSide.RIGHT, or use EE hands
split_type=SplitType.UART, # Defaults to UART
split_target_left=True, # If you want the right to be the target, change this to false
uart_interval=20, # Sets the uarts delay. Lower numbers draw more power
data_pin=None, # The primary data pin to talk to the secondary device with
data_pin2=None, # Second uart pin to allow 2 way communication
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
use_pio=False, # Use RP2040 PIO implementation of UART. Required if you want to use other pins than RX/TX
)

EE HANDS

If you want to plug USB in on either side, or are using Bluetooth, this is for you.

Rename your CIRCUITPY drive to something different. 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. For example on NYQUISTL for left and NYQUISTR for the right.

For wired connections you don't need to pass anything. For Bluetooth, remove the split_side like this

# Wired
split = Split()
# Wireless
split = Split(split_type=SplitType.BLE)

RP2040 PIO implementation

If you're using RP2040 based board and want to use other pins that the one with hardware support of RX/TX, you can try using PIO implementation of two-way wire protocol. Typical use cases for it are premade boards, made with QMK's bitbanging protocols in mind.

In order to enable it, you must:

  • install Circuit Python in 7.2+ version
  • add adafruit_pioasm.mpy library to lib or root folder of a board
  • pass use_pio=True into Split() constructor