471 lines
15 KiB
Python
471 lines
15 KiB
Python
from supervisor import ticks_ms
|
|
|
|
from kmk.consts import KMK_RELEASE, UnicodeMode
|
|
from kmk.hid import BLEHID, USBHID, AbstractHID, HIDModes
|
|
from kmk.keys import KC
|
|
from kmk.matrix import MatrixScanner, intify_coordinate
|
|
|
|
|
|
class Sandbox:
|
|
matrix_update = None
|
|
secondary_matrix_update = None
|
|
active_layers = None
|
|
|
|
|
|
class KMKKeyboard:
|
|
#####
|
|
# User-configurable
|
|
debug_enabled = False
|
|
|
|
keymap = []
|
|
coord_mapping = None
|
|
|
|
row_pins = None
|
|
col_pins = None
|
|
diode_orientation = None
|
|
matrix = None
|
|
matrix_scanner = MatrixScanner
|
|
uart_buffer = []
|
|
|
|
unicode_mode = UnicodeMode.NOOP
|
|
|
|
modules = []
|
|
extensions = []
|
|
sandbox = Sandbox()
|
|
|
|
#####
|
|
# Internal State
|
|
keys_pressed = set()
|
|
_coordkeys_pressed = {}
|
|
hid_type = HIDModes.USB
|
|
secondary_hid_type = None
|
|
_hid_helper = None
|
|
_hid_send_enabled = False
|
|
hid_pending = False
|
|
current_key = None
|
|
matrix_update = None
|
|
secondary_matrix_update = None
|
|
matrix_update_queue = []
|
|
_matrix_modify = None
|
|
state_changed = False
|
|
_old_timeouts_len = None
|
|
_new_timeouts_len = None
|
|
_trigger_powersave_enable = False
|
|
_trigger_powersave_disable = False
|
|
i2c_deinit_count = 0
|
|
_go_args = None
|
|
|
|
# this should almost always be PREpended to, replaces
|
|
# former use of reversed_active_layers which had pointless
|
|
# overhead (the underlying list was never used anyway)
|
|
active_layers = [0]
|
|
|
|
_timeouts = {}
|
|
|
|
# on some M4 setups (such as klardotsh/klarank_feather_m4, CircuitPython
|
|
# 6.0rc1) this runs out of RAM every cycle and takes down the board. no
|
|
# real known fix yet other than turning off debug, but M4s have always been
|
|
# tight on RAM so....
|
|
def __repr__(self):
|
|
return (
|
|
'KMKKeyboard('
|
|
'debug_enabled={} '
|
|
'diode_orientation={} '
|
|
'matrix_scanner={} '
|
|
'unicode_mode={} '
|
|
'_hid_helper={} '
|
|
'keys_pressed={} '
|
|
'coordkeys_pressed={} '
|
|
'hid_pending={} '
|
|
'active_layers={} '
|
|
'timeouts={} '
|
|
')'
|
|
).format(
|
|
self.debug_enabled,
|
|
self.diode_orientation,
|
|
self.matrix_scanner,
|
|
self.unicode_mode,
|
|
self._hid_helper,
|
|
# internal state
|
|
self.keys_pressed,
|
|
self._coordkeys_pressed,
|
|
self.hid_pending,
|
|
self.active_layers,
|
|
self._timeouts,
|
|
)
|
|
|
|
def _print_debug_cycle(self, init=False):
|
|
if self.debug_enabled:
|
|
if init:
|
|
print('KMKInit(release={})'.format(KMK_RELEASE))
|
|
print(self)
|
|
|
|
def _send_hid(self):
|
|
if self._hid_send_enabled:
|
|
hid_report = self._hid_helper.create_report(self.keys_pressed)
|
|
try:
|
|
hid_report.send()
|
|
except KeyError as e:
|
|
if self.debug_enabled:
|
|
print('HidNotFound(HIDReportType={})'.format(e))
|
|
self.hid_pending = False
|
|
|
|
def _handle_matrix_report(self, update=None):
|
|
if update is not None:
|
|
self._on_matrix_changed(update[0], update[1], update[2])
|
|
self.state_changed = True
|
|
|
|
def _find_key_in_map(self, int_coord, row, col):
|
|
try:
|
|
idx = self.coord_mapping.index(int_coord)
|
|
except ValueError:
|
|
if self.debug_enabled:
|
|
print(
|
|
'CoordMappingNotFound(ic={}, row={}, col={})'.format(
|
|
int_coord, row, col
|
|
)
|
|
)
|
|
|
|
return None
|
|
|
|
for layer in self.active_layers:
|
|
try:
|
|
layer_key = self.keymap[layer][idx]
|
|
except IndexError:
|
|
layer_key = None
|
|
if self.debug_enabled:
|
|
print(f'KeymapIndexError(idx={idx}, layer={layer})')
|
|
|
|
if not layer_key or layer_key == KC.TRNS:
|
|
continue
|
|
|
|
if self.debug_enabled:
|
|
print('KeyResolution(key={})'.format(layer_key))
|
|
|
|
return layer_key
|
|
|
|
def _on_matrix_changed(self, row, col, is_pressed):
|
|
if self.debug_enabled:
|
|
print('MatrixChange(col={} row={} pressed={})'.format(col, row, is_pressed))
|
|
|
|
int_coord = intify_coordinate(row, col)
|
|
|
|
if not is_pressed:
|
|
self.current_key = self._coordkeys_pressed[int_coord]
|
|
if self.debug_enabled:
|
|
print('PressedKeyResolution(key={})'.format(self.current_key))
|
|
|
|
if self.current_key is None:
|
|
self.current_key = self._find_key_in_map(int_coord, row, col)
|
|
|
|
if is_pressed:
|
|
self._coordkeys_pressed[int_coord] = self.current_key
|
|
else:
|
|
self._coordkeys_pressed[int_coord] = None
|
|
|
|
if self.current_key is None:
|
|
print('MatrixUndefinedCoordinate(col={} row={})'.format(col, row))
|
|
return self
|
|
|
|
for module in self.modules:
|
|
try:
|
|
if module.process_key(self, self.current_key, is_pressed) is None:
|
|
break
|
|
except Exception as err:
|
|
if self.debug_enabled:
|
|
print('Failed to run process_key function in module: ', err, module)
|
|
else:
|
|
self.process_key(self.current_key, is_pressed, int_coord, (row, col))
|
|
return self
|
|
|
|
def process_key(self, key, is_pressed, coord_int=None, coord_raw=None):
|
|
if is_pressed:
|
|
key.on_press(self, coord_int, coord_raw)
|
|
else:
|
|
key.on_release(self, coord_int, coord_raw)
|
|
|
|
return self
|
|
|
|
def remove_key(self, keycode):
|
|
self.keys_pressed.discard(keycode)
|
|
return self.process_key(keycode, False)
|
|
|
|
def add_key(self, keycode):
|
|
self.keys_pressed.add(keycode)
|
|
return self.process_key(keycode, True)
|
|
|
|
def tap_key(self, keycode):
|
|
self.add_key(keycode)
|
|
# On the next cycle, we'll remove the key.
|
|
self.set_timeout(False, lambda: self.remove_key(keycode))
|
|
|
|
return self
|
|
|
|
def set_timeout(self, after_ticks, callback):
|
|
if after_ticks is False:
|
|
# We allow passing False as an implicit "run this on the next process timeouts cycle"
|
|
timeout_key = ticks_ms()
|
|
else:
|
|
timeout_key = ticks_ms() + after_ticks
|
|
|
|
while timeout_key in self._timeouts:
|
|
timeout_key += 1
|
|
|
|
self._timeouts[timeout_key] = callback
|
|
return timeout_key
|
|
|
|
def cancel_timeout(self, timeout_key):
|
|
if timeout_key in self._timeouts:
|
|
del self._timeouts[timeout_key]
|
|
|
|
def _process_timeouts(self):
|
|
if not self._timeouts:
|
|
return self
|
|
|
|
current_time = ticks_ms()
|
|
|
|
# cast this to a tuple to ensure that if a callback itself sets
|
|
# timeouts, we do not handle them on the current cycle
|
|
timeouts = tuple(self._timeouts.items())
|
|
|
|
for k, v in timeouts:
|
|
if k <= current_time:
|
|
v()
|
|
del self._timeouts[k]
|
|
|
|
return self
|
|
|
|
def _init_sanity_check(self):
|
|
'''
|
|
Ensure the provided configuration is *probably* bootable
|
|
'''
|
|
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 (
|
|
self.hid_type in HIDModes.ALL_MODES
|
|
), 'hid_type must be a value from kmk.consts.HIDModes'
|
|
|
|
return self
|
|
|
|
def _init_coord_mapping(self):
|
|
'''
|
|
Attempt to sanely guess a coord_mapping if one is not provided. No-op
|
|
if `kmk.extensions.split.Split` is used, it provides equivalent
|
|
functionality in `on_bootup`
|
|
|
|
To save RAM on boards that don't use Split, we don't import Split
|
|
and do an isinstance check, but instead do string detection
|
|
'''
|
|
if any(x.__class__.__module__ == 'kmk.modules.split' for x in self.modules):
|
|
return
|
|
|
|
if not self.coord_mapping:
|
|
self.coord_mapping = []
|
|
|
|
rows_to_calc = len(self.row_pins)
|
|
cols_to_calc = len(self.col_pins)
|
|
|
|
for ridx in range(rows_to_calc):
|
|
for cidx in range(cols_to_calc):
|
|
self.coord_mapping.append(intify_coordinate(ridx, cidx))
|
|
|
|
def _init_hid(self):
|
|
if self.hid_type == HIDModes.NOOP:
|
|
self._hid_helper = AbstractHID
|
|
elif self.hid_type == HIDModes.USB:
|
|
self._hid_helper = USBHID
|
|
elif self.hid_type == HIDModes.BLE:
|
|
self._hid_helper = BLEHID
|
|
else:
|
|
self._hid_helper = AbstractHID
|
|
self._hid_helper = self._hid_helper(**self._go_args)
|
|
self._hid_send_enabled = True
|
|
|
|
def _init_matrix(self):
|
|
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),
|
|
)
|
|
|
|
return self
|
|
|
|
def before_matrix_scan(self):
|
|
for module in self.modules:
|
|
try:
|
|
module.before_matrix_scan(self)
|
|
except Exception as err:
|
|
if self.debug_enabled:
|
|
print('Failed to run pre matrix function in module: ', err, module)
|
|
|
|
for ext in self.extensions:
|
|
try:
|
|
ext.before_matrix_scan(self.sandbox)
|
|
except Exception as err:
|
|
if self.debug_enabled:
|
|
print('Failed to run pre matrix function in extension: ', err, ext)
|
|
|
|
def after_matrix_scan(self):
|
|
for module in self.modules:
|
|
try:
|
|
module.after_matrix_scan(self)
|
|
except Exception as err:
|
|
if self.debug_enabled:
|
|
print('Failed to run post matrix function in module: ', err, module)
|
|
|
|
for ext in self.extensions:
|
|
try:
|
|
ext.after_matrix_scan(self.sandbox)
|
|
except Exception as err:
|
|
if self.debug_enabled:
|
|
print('Failed to run post matrix function in extension: ', err, ext)
|
|
|
|
def before_hid_send(self):
|
|
for module in self.modules:
|
|
try:
|
|
module.before_hid_send(self)
|
|
except Exception as err:
|
|
if self.debug_enabled:
|
|
print('Failed to run pre hid function in module: ', err, module)
|
|
|
|
for ext in self.extensions:
|
|
try:
|
|
ext.before_hid_send(self.sandbox)
|
|
except Exception as err:
|
|
if self.debug_enabled:
|
|
print('Failed to run pre hid function in extension: ', err, ext)
|
|
|
|
def after_hid_send(self):
|
|
for module in self.modules:
|
|
try:
|
|
module.after_hid_send(self)
|
|
except Exception as err:
|
|
if self.debug_enabled:
|
|
print('Failed to run post hid function in module: ', err, module)
|
|
|
|
for ext in self.extensions:
|
|
try:
|
|
ext.after_hid_send(self.sandbox)
|
|
except Exception as err:
|
|
if self.debug_enabled:
|
|
print('Failed to run post hid function in extension: ', err, ext)
|
|
|
|
def powersave_enable(self):
|
|
for module in self.modules:
|
|
try:
|
|
module.on_powersave_enable(self)
|
|
except Exception as err:
|
|
if self.debug_enabled:
|
|
print('Failed to run post hid function in module: ', err, module)
|
|
|
|
for ext in self.extensions:
|
|
try:
|
|
ext.on_powersave_enable(self.sandbox)
|
|
except Exception as err:
|
|
if self.debug_enabled:
|
|
print('Failed to run post hid function in extension: ', err, ext)
|
|
|
|
def powersave_disable(self):
|
|
for module in self.modules:
|
|
try:
|
|
module.on_powersave_disable(self)
|
|
except Exception as err:
|
|
if self.debug_enabled:
|
|
print('Failed to run post hid function in module: ', err, module)
|
|
for ext in self.extensions:
|
|
try:
|
|
ext.on_powersave_disable(self.sandbox)
|
|
except Exception as err:
|
|
if self.debug_enabled:
|
|
print('Failed to run post hid function in extension: ', err, ext)
|
|
|
|
def go(self, hid_type=HIDModes.USB, secondary_hid_type=None, **kwargs):
|
|
self._init(hid_type=hid_type, secondary_hid_type=secondary_hid_type, **kwargs)
|
|
while True:
|
|
self._main_loop()
|
|
|
|
def _init(self, hid_type=HIDModes.USB, secondary_hid_type=None, **kwargs):
|
|
self._go_args = kwargs
|
|
self.hid_type = hid_type
|
|
self.secondary_hid_type = secondary_hid_type
|
|
|
|
self._init_sanity_check()
|
|
self._init_coord_mapping()
|
|
self._init_hid()
|
|
|
|
for module in self.modules:
|
|
try:
|
|
module.during_bootup(self)
|
|
except Exception as err:
|
|
if self.debug_enabled:
|
|
print('Failed to load module', err, module)
|
|
print()
|
|
for ext in self.extensions:
|
|
try:
|
|
ext.during_bootup(self)
|
|
except Exception as err:
|
|
if self.debug_enabled:
|
|
print('Failed to load extension', err, ext)
|
|
|
|
self._init_matrix()
|
|
|
|
self._print_debug_cycle(init=True)
|
|
|
|
def _main_loop(self):
|
|
self.current_key = None
|
|
self.state_changed = False
|
|
self.sandbox.active_layers = self.active_layers.copy()
|
|
|
|
self.before_matrix_scan()
|
|
|
|
self.matrix_update = self.sandbox.matrix_update = self.matrix.scan_for_changes()
|
|
self.sandbox.secondary_matrix_update = self.secondary_matrix_update
|
|
|
|
self.after_matrix_scan()
|
|
|
|
if self.secondary_matrix_update:
|
|
# bytearray constructor here to produce a copy
|
|
# otherwise things get strange when self.secondary_matrix_update
|
|
# gets modified.
|
|
self.matrix_update_queue.append(bytearray(self.secondary_matrix_update))
|
|
self.secondary_matrix_update = None
|
|
|
|
if self.matrix_update:
|
|
# bytearray constructor here to produce a copy
|
|
# otherwise things get strange when self.matrix_update
|
|
# gets modified.
|
|
self.matrix_update_queue.append(bytearray(self.matrix_update))
|
|
self.matrix_update = None
|
|
|
|
# only handle one key per cycle.
|
|
if self.matrix_update_queue:
|
|
self._handle_matrix_report(self.matrix_update_queue.pop(0))
|
|
|
|
self.before_hid_send()
|
|
|
|
if self.hid_pending:
|
|
self._send_hid()
|
|
|
|
self._old_timeouts_len = len(self._timeouts)
|
|
self._process_timeouts()
|
|
self._new_timeouts_len = len(self._timeouts)
|
|
|
|
if self._old_timeouts_len != self._new_timeouts_len:
|
|
self.state_changed = True
|
|
if self.hid_pending:
|
|
self._send_hid()
|
|
|
|
self.after_hid_send()
|
|
|
|
if self._trigger_powersave_enable:
|
|
self.powersave_enable()
|
|
|
|
if self._trigger_powersave_disable:
|
|
self.powersave_disable()
|
|
|
|
if self.state_changed:
|
|
self._print_debug_cycle()
|