kmk_firmware/docs
Josh Klar 6baaf5e5d4
Continue to shuffle and burn stuff
- Remove the concept of "mcus". With only one target platform
(CircuitPython), it no longer makes a bunch of sense and has been kept
around for "what if" reasons, complicating our import chains and eating
up RAM for pointless subclasses. If you're a `board`, you derive from
`KeyboardConfig`. If you're a handwire, the user will derive from
`KeyboardConfig`. The end. As part of this, `kmk.hid` was refactored
heavily to emphasize that CircuitPython is our only supported HID stack,
with stubs for future HID implementations (`USB_HID` becomes
`AbstractHID`, probably only usable for testing purposes,
`CircuitPython_USB_HID` becomes `USBHID`, and `BLEHID` is added with an
immediate `NotImplementedError` on instantiation)

- `KeyboardConfig` can now take a HID type at runtime. The NRF52840
boards will happily run in either configuration once CircuitPython
support is in place, and a completely separate `mcu` subclass for each
mode made no sense. This also potentially allows runtime *swaps* of HID
driver down the line, but no code has been added to this effect. The
default, and only functional value, for this is `HIDModes.USB`

- Most consts have been moved to more logical homes - often, the main
or, often only, component that uses them. `DiodeOrientation` moved to
`kmk.matrix`, and anything HID-related moved to `kmk.hid`
2019-07-25 00:58:23 -07:00
..
config_and_keymap.md Continue to shuffle and burn stuff 2019-07-25 00:58:23 -07:00
debugging.md Re-add LED support 2019-07-17 16:05:40 -07:00
examples.md Re-add LED support 2019-07-17 16:05:40 -07:00
flashing.md boot.py is still required - ensure it ends up in our dists and is documented 2019-07-24 23:28:13 -07:00
hardware.md Re-add LED support 2019-07-17 16:05:40 -07:00
keycodes.md Small touch ups to correct errors, and update to modern information 2019-07-17 16:17:52 -07:00
keys.md Re-add LED support 2019-07-17 16:05:40 -07:00
leader.md Remove outdated Leader Mode doc sentences 2018-10-19 15:30:43 -07:00
led.md Re-add LED support 2019-07-17 16:05:40 -07:00
modtap.md Make this clearer 2019-07-17 22:11:31 -07:00
rgb.md Re-add LED support 2019-07-17 16:05:40 -07:00
sequences.md Re-add LED support 2019-07-17 16:05:40 -07:00
split_keyboards.md Re-add LED support 2019-07-17 16:05:40 -07:00
support.md Re-add LED support 2019-07-17 16:05:40 -07:00
tapdance.md Rename "Firmware" to "KeyboardConfig" for clarity in main.py and to illustrate separation of KeyboardConfig/InternalState 2019-07-24 21:25:10 -07:00