336 lines
10 KiB
Python
336 lines
10 KiB
Python
# There's a chance doing preload RAM hacks this late will cause recursion
|
|
# errors, but we'll see. I'd rather do it here than require everyone copy-paste
|
|
# a line into their keymaps.
|
|
import kmk.preload_imports # isort:skip # NOQA
|
|
|
|
import busio
|
|
import gc
|
|
|
|
from kmk import led, rgb
|
|
|
|
try:
|
|
from kmk.ble import BLEHID
|
|
except ImportError:
|
|
print('Bluetooth is unsupported ')
|
|
|
|
from kmk.consts import KMK_RELEASE, LeaderMode, UnicodeMode
|
|
from kmk.hid import USBHID, AbstractHID, HIDModes
|
|
from kmk.internal_state import InternalState
|
|
from kmk.keys import KC
|
|
from kmk.kmktime import sleep_ms
|
|
from kmk.matrix import MatrixScanner
|
|
from kmk.matrix import intify_coordinate as ic
|
|
|
|
|
|
class KMKKeyboard:
|
|
debug_enabled = False
|
|
|
|
keymap = None
|
|
coord_mapping = None
|
|
|
|
row_pins = None
|
|
col_pins = None
|
|
diode_orientation = None
|
|
matrix_scanner = MatrixScanner
|
|
uart_buffer = []
|
|
|
|
unicode_mode = UnicodeMode.NOOP
|
|
tap_time = 300
|
|
leader_mode = LeaderMode.TIMEOUT
|
|
leader_dictionary = {}
|
|
leader_timeout = 1000
|
|
|
|
# Split config
|
|
extra_data_pin = None
|
|
split_offsets = ()
|
|
split_flip = False
|
|
split_side = None
|
|
split_type = None
|
|
split_master_left = True
|
|
is_master = None
|
|
uart = None
|
|
uart_flip = True
|
|
uart_pin = None
|
|
|
|
# RGB config
|
|
rgb_pixel_pin = None
|
|
rgb_config = rgb.rgb_config
|
|
|
|
# led config (mono color)
|
|
led_pin = None
|
|
led_config = led.led_config
|
|
|
|
def __repr__(self):
|
|
return (
|
|
'KMKKeyboard('
|
|
'debug_enabled={} '
|
|
'keymap=truncated '
|
|
'coord_mapping=truncated '
|
|
'row_pins=truncated '
|
|
'col_pins=truncated '
|
|
'diode_orientation={} '
|
|
'matrix_scanner={} '
|
|
'unicode_mode={} '
|
|
'tap_time={} '
|
|
'leader_mode={} '
|
|
'leader_dictionary=truncated '
|
|
'leader_timeout={} '
|
|
'hid_helper={} '
|
|
'extra_data_pin={} '
|
|
'split_offsets={} '
|
|
'split_flip={} '
|
|
'split_side={} '
|
|
'split_type={} '
|
|
'split_master_left={} '
|
|
'is_master={} '
|
|
'uart={} '
|
|
'uart_flip={} '
|
|
'uart_pin={}'
|
|
')'
|
|
).format(
|
|
self.debug_enabled,
|
|
# self.keymap,
|
|
# self.coord_mapping,
|
|
# self.row_pins,
|
|
# self.col_pins,
|
|
self.diode_orientation,
|
|
self.matrix_scanner,
|
|
self.unicode_mode,
|
|
self.tap_time,
|
|
self.leader_mode,
|
|
# self.leader_dictionary,
|
|
self.leader_timeout,
|
|
self.hid_helper.__name__,
|
|
self.extra_data_pin,
|
|
self.split_offsets,
|
|
self.split_flip,
|
|
self.split_side,
|
|
self.split_type,
|
|
self.split_master_left,
|
|
self.is_master,
|
|
self.uart,
|
|
self.uart_flip,
|
|
self.uart_pin,
|
|
)
|
|
|
|
def _print_debug_cycle(self, init=False):
|
|
pre_alloc = gc.mem_alloc()
|
|
pre_free = gc.mem_free()
|
|
|
|
if self.debug_enabled:
|
|
if init:
|
|
print('KMKInit(release={})'.format(KMK_RELEASE))
|
|
|
|
print(self)
|
|
print(self._state)
|
|
print(
|
|
'GCStats(pre_alloc={} pre_free={} alloc={} free={})'.format(
|
|
pre_alloc, pre_free, gc.mem_alloc(), gc.mem_free()
|
|
)
|
|
)
|
|
|
|
def _send_hid(self):
|
|
self._hid_helper_inst.create_report(self._state.keys_pressed).send()
|
|
self._state.resolve_hid()
|
|
|
|
def _send_key(self, key):
|
|
if not getattr(key, 'no_press', None):
|
|
self._state.add_key(key)
|
|
self._send_hid()
|
|
|
|
if not getattr(key, 'no_release', None):
|
|
self._state.remove_key(key)
|
|
self._send_hid()
|
|
|
|
def _handle_matrix_report(self, update=None):
|
|
'''
|
|
Bulk processing of update code for each cycle
|
|
:param update:
|
|
'''
|
|
if update is not None:
|
|
|
|
self._state.matrix_changed(update[0], update[1], update[2])
|
|
|
|
def _send_to_master(self, update):
|
|
if self.split_master_left:
|
|
update[1] += self.split_offsets[update[0]]
|
|
else:
|
|
update[1] -= self.split_offsets[update[0]]
|
|
if self.uart is not None:
|
|
self.uart.write(update)
|
|
|
|
def _receive_from_slave(self):
|
|
if self.uart is not None and self.uart.in_waiting > 0 or self.uart_buffer:
|
|
if self.uart.in_waiting >= 60:
|
|
# This is a dirty hack to prevent crashes in unrealistic cases
|
|
import microcontroller
|
|
|
|
microcontroller.reset()
|
|
|
|
while self.uart.in_waiting >= 3:
|
|
self.uart_buffer.append(self.uart.read(3))
|
|
if self.uart_buffer:
|
|
update = bytearray(self.uart_buffer.pop(0))
|
|
|
|
# Built in debug mode switch
|
|
if update == b'DEB':
|
|
print(self.uart.readline())
|
|
return None
|
|
return update
|
|
|
|
return None
|
|
|
|
def _send_debug(self, message):
|
|
'''
|
|
Prepends DEB and appends a newline to allow debug messages to
|
|
be detected and handled differently than typical keypresses.
|
|
:param message: Debug message
|
|
'''
|
|
if self.uart is not None:
|
|
self.uart.write('DEB')
|
|
self.uart.write(message, '\n')
|
|
|
|
def init_uart(self, pin, timeout=20):
|
|
if self.is_master:
|
|
return busio.UART(tx=None, rx=pin, timeout=timeout)
|
|
else:
|
|
return busio.UART(tx=pin, rx=None, timeout=timeout)
|
|
|
|
def go(self, hid_type=HIDModes.USB, **kwargs):
|
|
assert self.keymap, 'must define a keymap with at least one row'
|
|
assert self.row_pins, 'no GPIO pins defined for matrix rows'
|
|
assert self.col_pins, 'no GPIO pins defined for matrix columns'
|
|
assert self.diode_orientation is not None, 'diode orientation must be defined'
|
|
assert (
|
|
hid_type in HIDModes.ALL_MODES
|
|
), 'hid_type must be a value from kmk.consts.HIDModes'
|
|
|
|
# Attempt to sanely guess a coord_mapping if one is not provided
|
|
|
|
if not self.coord_mapping:
|
|
self.coord_mapping = []
|
|
|
|
rows_to_calc = len(self.row_pins)
|
|
cols_to_calc = len(self.col_pins)
|
|
|
|
if self.split_offsets:
|
|
rows_to_calc *= 2
|
|
cols_to_calc *= 2
|
|
|
|
for ridx in range(rows_to_calc):
|
|
for cidx in range(cols_to_calc):
|
|
self.coord_mapping.append(ic(ridx, cidx))
|
|
|
|
self._state = InternalState(self)
|
|
|
|
if hid_type == HIDModes.NOOP:
|
|
self.hid_helper = AbstractHID
|
|
elif hid_type == HIDModes.USB:
|
|
self.hid_helper = USBHID
|
|
elif hid_type == HIDModes.BLE:
|
|
self.hid_helper = BLEHID
|
|
|
|
self._hid_helper_inst = self.hid_helper(**kwargs)
|
|
|
|
# Split keyboard Init
|
|
if self.split_type is not None:
|
|
try:
|
|
# Working around https://github.com/adafruit/circuitpython/issues/1769
|
|
self._hid_helper_inst.create_report([]).send()
|
|
self.is_master = True
|
|
|
|
# Sleep 2s so master portion doesn't "appear" to boot quicker than
|
|
# dependent portions (which will take ~2s to time out on the HID send)
|
|
sleep_ms(2000)
|
|
except OSError:
|
|
self.is_master = False
|
|
|
|
if self.split_flip and not self.is_master:
|
|
self.col_pins = list(reversed(self.col_pins))
|
|
if self.split_side == 'Left':
|
|
self.split_master_left = self.is_master
|
|
elif self.split_side == 'Right':
|
|
self.split_master_left = not self.is_master
|
|
else:
|
|
self.is_master = True
|
|
|
|
if self.uart_pin is not None:
|
|
self.uart = self.init_uart(self.uart_pin)
|
|
|
|
if self.rgb_pixel_pin:
|
|
self.pixels = rgb.RGB(self.rgb_config, self.rgb_pixel_pin)
|
|
self.rgb_config = None # No longer needed
|
|
self.pixels.loopcounter = 0
|
|
else:
|
|
self.pixels = None
|
|
|
|
if self.led_pin:
|
|
self.led = led.led(self.led_pin, self.led_config)
|
|
self.led_config = None # No longer needed
|
|
else:
|
|
self.led = None
|
|
|
|
self.matrix = self.matrix_scanner(
|
|
cols=self.col_pins,
|
|
rows=self.row_pins,
|
|
diode_orientation=self.diode_orientation,
|
|
rollover_cols_every_rows=getattr(self, 'rollover_cols_every_rows', None),
|
|
)
|
|
|
|
# Compile string leader sequences
|
|
for k, v in self.leader_dictionary.items():
|
|
if not isinstance(k, tuple):
|
|
new_key = tuple(KC[c] for c in k)
|
|
self.leader_dictionary[new_key] = v
|
|
|
|
for k, v in self.leader_dictionary.items():
|
|
if not isinstance(k, tuple):
|
|
del self.leader_dictionary[k]
|
|
|
|
gc.collect()
|
|
self._print_debug_cycle(init=True)
|
|
|
|
while True:
|
|
state_changed = False
|
|
|
|
if self.split_type is not None and self.is_master:
|
|
update = self._receive_from_slave()
|
|
if update is not None:
|
|
self._handle_matrix_report(update)
|
|
state_changed = True
|
|
|
|
update = self.matrix.scan_for_changes()
|
|
|
|
if update is not None:
|
|
if self.is_master:
|
|
self._handle_matrix_report(update)
|
|
state_changed = True
|
|
else:
|
|
# This keyboard is a slave, and needs to send data to master
|
|
self._send_to_master(update)
|
|
|
|
if self._state.hid_pending:
|
|
self._send_hid()
|
|
|
|
old_timeouts_len = len(self._state.timeouts)
|
|
self._state.process_timeouts()
|
|
new_timeouts_len = len(self._state.timeouts)
|
|
|
|
if old_timeouts_len != new_timeouts_len:
|
|
state_changed = True
|
|
|
|
if self._state.hid_pending:
|
|
self._send_hid()
|
|
|
|
if self.pixels and self.pixels.animation_mode:
|
|
self.pixels.loopcounter += 1
|
|
if self.pixels.loopcounter >= 7:
|
|
self.pixels = self.pixels.animate()
|
|
self.pixels.loopcounter = 0
|
|
|
|
if self.led and self.led.enabled and self.led.animation_mode:
|
|
self.led = self.led.animate()
|
|
|
|
if state_changed:
|
|
self._print_debug_cycle()
|