Commit Graph

39 Commits (6baaf5e5d430c82f6f01cde41875a943b247550e)

Author SHA1 Message Date
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
Josh Klar 4bdf926360
boot.py is still required - ensure it ends up in our dists and is documented 2019-07-24 23:28:13 -07:00
Josh Klar 6b73a5ec56
Update keymap/keyboardconfig docs 2019-07-24 23:19:45 -07:00
Josh Klar 614883ef80
More docs updates 2019-07-24 21:25:10 -07:00
Josh Klar 1e9625ae0e
Rename "Firmware" to "KeyboardConfig" for clarity in main.py and to illustrate separation of KeyboardConfig/InternalState 2019-07-24 21:25:10 -07:00
Kyle Brown fc51f84045 Make this clearer 2019-07-17 22:11:31 -07:00
Kyle Brown 241cf69979 Small touch ups to correct errors, and update to modern information 2019-07-17 16:17:52 -07:00
Josh Klar d34e8ce9d2 Re-add LED support
This reverts commit 5b069a0104.
2019-07-17 16:05:40 -07:00
Josh Klar 5b069a0104
Revert "Monocolor LED backlight added" 2019-07-07 15:35:15 -07:00
Kyle Brown 5158094549 Small changes 2019-06-21 16:49:00 -07:00
Kyle Brown 3f8c6e7648 Added support for user animations with docs 2019-06-21 16:49:00 -07:00
Kyle Brown 9d8682c866 Config changes and uses consts to save ram 2019-06-21 16:49:00 -07:00
Kyle Brown 54d63037bf Added board definition for nyquist and add RGB and LED pins for nyquest and iris 2019-06-21 16:46:59 -07:00
Kyle Brown f7a1d54752 Added LED support, cleaned up RGB docs 2019-06-21 16:45:04 -07:00
Kyle Brown 7ebfaa3bf7 cleaned up docs even more. I believe this fills all requirements for merge. 2019-06-21 16:44:03 -07:00
Kyle Brown f65ea1e841 Added 2 more keys, stripped unused cruft, and added more docs. 2019-06-21 16:44:03 -07:00
Kyle Brown 5c8c2e97fd Resolved many things 2019-06-21 16:44:02 -07:00
Kyle Brown 3ae7432de0 Massive docs update 2019-06-21 16:42:53 -07:00
Kyle Brown 7e06b143e1
Merge branch 'master' into topic-backspace-delete 2019-03-12 00:25:05 -07:00
Kyle Brown 298f9489c2 Duh, chaining.... 2019-03-12 00:24:48 -07:00
Kyle Brown a2cfa92f2f Missed some obvious things 2019-03-12 00:24:48 -07:00
Kyle Brown e792524b63 Added mod tap with docs 2019-03-12 00:24:48 -07:00
Kyle Brown fc8ddba6cb Adds delete/backspace key. Resolves #93 2019-03-09 15:12:23 -08:00
Josh Klar d4f4872b00
So much documentation 2019-02-18 16:35:07 -08:00
Josh Klar 413e8b8806
Rename keycodes to keys, simpler and easier to deal with 2018-12-29 15:29:11 -08:00
Kyle Brown 5ef6a7a96a Added docs, and removed some old, not needed docs 2018-12-12 15:43:33 -08:00
Josh Klar d6a0538009
kmk.consts: rename UnicodeModes => UnicodeMode
This brings this naming into consistency with both fellow consts in the
same file (ex. LeaderMode is singular) as well as the variables in which
the consts are usually used (usually a `Firmware.unicode_mode` attribute
in a keymap).
2018-12-04 17:03:13 -08:00
Josh Klar db741eb055
Add some documentation 2018-11-05 21:36:29 -08:00
Kyle Brown 15fea0189b Added remote debugger and cleaned up several things Looks good to merge 2018-10-28 15:03:22 -07:00
Kyle Brown 2b28b99503 Finalize docs, and unbreak failed rebase 2018-10-28 15:03:22 -07:00
Josh Klar 5b49e6d098 Remove outdated Leader Mode doc sentences 2018-10-19 15:30:43 -07:00
Josh Klar 1521a3ec03
Fix more typoes 2018-10-19 02:09:10 -07:00
Josh Klar 74716c4c20
More sane default leader mode 2018-10-19 02:08:13 -07:00
Josh Klar 26c40b977f
Update docs for leader mode 2018-10-19 02:05:03 -07:00
Josh Klar 54f7117712
Resolves #38: Add KC.DEBUG to toggle log spew at runtime 2018-10-19 00:58:17 -07:00
Josh Klar 758e4de82b
Add a bit of important documentation 2018-10-18 23:59:26 -07:00
Josh Klar 9646c89d3a
Update soooo much documentation 2018-10-18 23:54:36 -07:00
Josh Klar ebc45d59dc
Address #52 almost entirely - target upstream builds of CircuitPython and simply copy (rsync) KMK source, a basic main.py, and the user's keymap to the CIRCUITPY drive 2018-10-15 02:49:12 -07:00
Kyle Brown 4c12e3a08d Basic Docs
Updated

Final cleanup
2018-10-11 21:42:30 -07:00