OMEGA REFACTOR! Perf grind basically complete.
Resolves #70, Resolves #67 Still needs some regression testing in general, and a definite regression is that rotary encoders are no longer (for the immediate time being) supported. Moves to a much simpler internal state tracking system, and FAR lighter matrix scan. Removes MicroPython support entirely.
This commit is contained in:
143
kmk/firmware.py
143
kmk/firmware.py
@@ -1,70 +1,111 @@
|
||||
import logging
|
||||
# Welcome to RAM and stack size hacks central, I'm your host, klardotsh!
|
||||
# We really get stuck between a rock and a hard place on CircuitPython
|
||||
# sometimes: our import structure is deeply nested enough that stuff
|
||||
# breaks in some truly bizarre ways, including:
|
||||
# - explicit RuntimeError exceptions, complaining that our
|
||||
# stack depth is too deep
|
||||
#
|
||||
# - silent hard locks of the device (basically unrecoverable without
|
||||
# UF2 flash if done in main.py, fixable with a reboot if done
|
||||
# in REPL)
|
||||
#
|
||||
# However, there's a hackaround that works for us! Because sys.modules
|
||||
# caches everything it sees (and future imports will use that cached
|
||||
# copy of the module), let's take this opportunity _way_ up the import
|
||||
# chain to import _every single thing_ KMK eventually uses in a normal
|
||||
# workflow, in order from fewest to least nested dependencies.
|
||||
|
||||
from kmk.event_defs import init_firmware
|
||||
from kmk.internal_state import Store, kmk_reducer
|
||||
from kmk.leader_mode import LeaderHelper
|
||||
# First, stuff that has no dependencies, or only C/MPY deps
|
||||
import collections
|
||||
import kmk.consts
|
||||
import kmk.kmktime
|
||||
import kmk.types
|
||||
|
||||
# Now stuff that depends on the above (and so on)
|
||||
import kmk.keycodes
|
||||
import kmk.matrix
|
||||
|
||||
import kmk.hid
|
||||
import kmk.internal_state
|
||||
|
||||
# GC runs automatically after CircuitPython imports. If we ever go back to
|
||||
# supporting MicroPython, we'll need a GC here (and probably after each
|
||||
# chunk of the above)
|
||||
|
||||
# Thanks for sticking around. Now let's do real work, starting below
|
||||
|
||||
import gc
|
||||
from kmk.consts import LeaderMode, UnicodeModes
|
||||
from kmk.hid import USB_HID
|
||||
from kmk.internal_state import InternalState
|
||||
from kmk.matrix import MatrixScanner
|
||||
|
||||
|
||||
class Firmware:
|
||||
def __init__(
|
||||
self, keymap, row_pins, col_pins,
|
||||
diode_orientation,
|
||||
hid=None,
|
||||
log_level=logging.NOTSET,
|
||||
matrix_scanner=None,
|
||||
):
|
||||
assert matrix_scanner is not None
|
||||
self.matrix_scanner = matrix_scanner
|
||||
debug_enabled = False
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
logger.setLevel(log_level)
|
||||
keymap = None
|
||||
|
||||
import kmk_keyboard
|
||||
self.encoders = getattr(kmk_keyboard, 'encoders', [])
|
||||
row_pins = None
|
||||
col_pins = None
|
||||
diode_orientation = None
|
||||
|
||||
self.hydrated = False
|
||||
unicode_mode = UnicodeModes.NOOP
|
||||
tap_time = 300
|
||||
leader_mode = LeaderMode.ENTER
|
||||
leader_dictionary = {}
|
||||
|
||||
self.store = Store(kmk_reducer, log_level=log_level)
|
||||
self.store.subscribe(
|
||||
lambda state, action: self._subscription(state, action),
|
||||
hid_helper = USB_HID
|
||||
|
||||
def __init__(self):
|
||||
self.matrix = MatrixScanner(
|
||||
cols=self.col_pins,
|
||||
rows=self.row_pins,
|
||||
diode_orientation=self.diode_orientation,
|
||||
rollover_cols_every_rows=getattr(self, 'rollover_cols_every_rows', None),
|
||||
swap_indicies=getattr(self, 'swap_indicies', None),
|
||||
)
|
||||
|
||||
if hid:
|
||||
self.hid = hid(store=self.store, log_level=log_level)
|
||||
else:
|
||||
logger.warning(
|
||||
"Must provide a HIDHelper (arg: hid), disabling HID\n"
|
||||
"Board will run in debug mode",
|
||||
)
|
||||
self._hid_helper_inst = self.hid_helper()
|
||||
|
||||
self.leader_helper = LeaderHelper(store=self.store, log_level=log_level)
|
||||
self._state = InternalState(self)
|
||||
|
||||
self.store.dispatch(init_firmware(
|
||||
keymap=keymap,
|
||||
row_pins=row_pins,
|
||||
col_pins=col_pins,
|
||||
diode_orientation=diode_orientation,
|
||||
))
|
||||
|
||||
def _subscription(self, state, action):
|
||||
if not self.hydrated:
|
||||
self.matrix = self.matrix_scanner(
|
||||
state.col_pins,
|
||||
state.row_pins,
|
||||
state.diode_orientation,
|
||||
)
|
||||
self.hydrated = True
|
||||
def _send_hid(self):
|
||||
self._hid_helper_inst.create_report(self._state.keys_pressed).send()
|
||||
self._state.resolve_hid()
|
||||
|
||||
def go(self):
|
||||
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'
|
||||
|
||||
if self.debug_enabled:
|
||||
print("Firin' lazers. Keyboard is booted.")
|
||||
|
||||
while True:
|
||||
update = self.matrix.scan_for_pressed()
|
||||
|
||||
if update:
|
||||
self.store.dispatch(update)
|
||||
if update is not None:
|
||||
self._state.matrix_changed(
|
||||
update[0],
|
||||
update[1],
|
||||
update[2],
|
||||
)
|
||||
|
||||
for encoder in self.encoders:
|
||||
eupdate = encoder.scan()
|
||||
if self._state.hid_pending:
|
||||
self._send_hid()
|
||||
|
||||
if eupdate:
|
||||
for event in eupdate:
|
||||
self.store.dispatch(event)
|
||||
if self._state.macro_pending:
|
||||
for key in self._state.macro_pending(self):
|
||||
if not getattr(key, 'no_press', None):
|
||||
self._state.force_keycode_down(key)
|
||||
self._send_hid()
|
||||
|
||||
if not getattr(key, 'no_release', None):
|
||||
self._state.force_keycode_up(key)
|
||||
self._send_hid()
|
||||
|
||||
self._state.resolve_macro()
|
||||
|
||||
gc.collect()
|
||||
|
Reference in New Issue
Block a user