Commit Graph

67 Commits (main)

Author SHA1 Message Date
FHA d43c712301 Requested updates before push into main
1. Space before "If you're wondering"
2. Replaced "with certain boards ... pico" by "with most boards"
2021-07-29 11:53:38 -07:00
FHA c75b52f94b Update keycodes.md
Precision on KC.APPLICATION position on the keyboard
2021-07-29 11:53:38 -07:00
FHA 3525a5f1a5 Update keycodes.md
typo  : interNATIOnal
2021-07-29 11:53:38 -07:00
FHA 10a1447adc Update keycodes.md
Added international (ISO) keys as defined in the code
2021-07-29 11:53:38 -07:00
FHA 24a4a4da11 Proofread & typos 2021-07-29 11:53:38 -07:00
FHA 9aaebbcf54 typos 2021-07-29 11:53:38 -07:00
FHA 081590f85d Update Getting_Started.md
Added direct references to various existing doc pages
2021-07-29 11:53:38 -07:00
FHA 2db4682264 Update Getting_Started.md
Name of the main file updated (code.py or main.py)
2021-07-29 11:53:38 -07:00
FHA f256c49727 Rename kmk_vs_circuitpython.md to kmkpython_vs_circuitpython.md 2021-07-29 11:53:38 -07:00
FHA 0247de4988 Update Getting_Started.md 2021-07-29 11:53:38 -07:00
FHA 4139c97b22 clarify the diff between KMK and KMKPython 2021-07-29 11:53:38 -07:00
FHA 917afe5f57 Create kmk_vs_circuitpython.md
Move KMK vs CircuitPython from main guide to dedicated page
2021-07-29 11:53:38 -07:00
FHA 9e731bce1e Update Getting_Started.md
various precisions
2021-07-29 11:53:38 -07:00
FHA 3f10abc6fd Update Getting_Started.md
Review structure. Provide TLDR example as a quickstart
2021-07-29 11:53:38 -07:00
pullenrc 15918db7ac
Encoder module! (#211)
* added atreus62 board

* Uploaded module for encoder support

* Update README.md


Co-authored-by: Ryan Pullen <rpullen@martinuav.com>
2021-07-19 08:30:28 -07:00
enbyautumn 76e7ee4027 Rename Offiially_Supported_Microcontrollers.md to Officially_Supported_Microcontrollers.md 2021-07-09 09:50:41 -07:00
Kyle Brown 1a348f1539 docs and typos 2021-06-25 10:53:58 -07:00
Kyle Brown e72d2b8c34
feat(extensions): most of the extensions implementation, by kdb424 2021-06-20 13:55:16 -07:00
DonutCables f1bce8fdbd Update docs/rgb.md for config clarity 2021-05-16 00:49:24 -04:00
Josh Klar 01daa7a07e
fix: resolve #197, remove broken Matrix links and instead duplicate README blurb 2021-05-02 20:17:03 -07:00
Josh Klar dc598ad439
Merge pull request #167 from dzervas/ble_multimple_conns
BLE Multiple Connections
2020-10-14 22:04:29 -07:00
Kyle Brown 6ed5d04af5 Corrected a replace issue in the docs 2020-10-13 11:07:08 -07:00
Kyle Brown 80d95816e4 Switch to initiator/target 2020-10-13 11:07:08 -07:00
Dimitris Zervas f3067099b2
Update the docs for the new connection selection keys 2020-10-01 23:02:05 +03:00
Dimitris Zervas d79a2c943c Update the docs for the new clear bond key 2020-09-29 19:35:49 -07:00
Kyle Brown d47665df50 small docs add for rgb 2020-07-12 19:07:17 -07:00
Josh Klar 666c0a4f08
Rename KeyboardConfig to KMKKeyboard - prepping for later merge with InternalState 2019-07-25 01:30:55 -07:00
Josh Klar b03ae32e7d
straggling docs update 2019-07-25 01:20:14 -07:00
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