Added docs, and removed some old, not needed docs

This commit is contained in:
Kyle Brown 2018-12-10 18:48:32 -08:00
parent e6acef9648
commit 5ef6a7a96a
3 changed files with 2 additions and 9 deletions

View File

@ -8,12 +8,6 @@ keyboard.split_flip = True # If your boards are identical but one is flipped, t
keyboard.split_offsets = [6, 6, 6, 6] # This is the how many keys are on each column on the "Master" half keyboard.split_offsets = [6, 6, 6, 6] # This is the how many keys are on each column on the "Master" half
``` ```
## Master Half
Choosing the master half can be done one of 2 ways. You can set this true or false if you only pleg in on one side.
```python
keyboard.split_master_left = True
```
## EE HANDS ## EE HANDS
If you want to plug in on either side, it can be done fairly easily but requires setup. If you want to plug in on either side, it can be done fairly easily but requires setup.
@ -34,5 +28,5 @@ from kmk_side import split_side
To enable uart it's as simple as adding this line, of course changing the pin To enable uart it's as simple as adding this line, of course changing the pin
```python ```python
keyboard.split_type = "UART" keyboard.split_type = "UART"
keyboard.uart = keyboard.init_uart(tx=board.SCL) keyboard.uart_pin = board.SCL
``` ```

View File

@ -147,7 +147,6 @@ class Firmware:
assert self.col_pins, 'no GPIO pins defined for matrix columns' assert self.col_pins, 'no GPIO pins defined for matrix columns'
assert self.diode_orientation is not None, 'diode orientation must be defined' assert self.diode_orientation is not None, 'diode orientation must be defined'
# Split keyboard Init # Split keyboard Init
if self.split_flip and not self._master_half(): if self.split_flip and not self._master_half():
self.col_pins = list(reversed(self.col_pins)) self.col_pins = list(reversed(self.col_pins))

View File

@ -24,7 +24,7 @@ keyboard.uart = keyboard.init_uart(tx=board.SDA, rx=board.SCL)
# ------------------User level config variables --------------------------------------- # ------------------User level config variables ---------------------------------------
keyboard.leader_mode = LeaderMode.TIMEOUT keyboard.leader_mode = LeaderMode.TIMEOUT
keyboard.unicode_mode = UnicodeModes.LINUX keyboard.unicode_mode = UnicodeMode.LINUX
keyboard.tap_time = 150 keyboard.tap_time = 150
keyboard.leader_timeout = 2000 keyboard.leader_timeout = 2000
keyboard.debug_enabled = True keyboard.debug_enabled = True