Cole Smith
49b83305d9
fixing docs
2022-04-25 16:54:08 +00:00
Cole Smith
e67a1a8cd7
added on to the docs for splits using encoders
2022-04-25 16:54:08 +00:00
Ryan Rotter
da239e535e
minor typo in rgb.md
2022-04-25 16:53:22 +00:00
Ryan Rotter
9e171abc69
Capitalize Python class names
2022-04-25 16:53:22 +00:00
Ryan Rotter
9733c43d2a
nice!nano spelling, broken link, bulleted lists
2022-04-25 16:53:22 +00:00
Ryan Rotter
dfa73a8cca
add backtick quotes for code snippets
...
* Added for keycodes, pin numbers, and code snippets. Mostly in tables.
* Enhance documentation readability
* Make automated spell checking easier - aspell automatically ignores these snippets
* fix invalid markdown table in mouse_keys.md
2022-04-25 16:53:22 +00:00
Ryan Rotter
1985712637
spelling/capitalization/usage on proper nouns
...
correct usage sourced from:
* websites of respective trademark holders
* Wiktionary
* Wikipedia
2022-04-25 16:53:22 +00:00
Ryan Rotter
09d0287800
Correct spelling of common words in .md files
2022-04-25 16:53:22 +00:00
xs5871
c7eaeaf90c
implement multiple pixelbuffer in rgb extension
2022-04-24 10:20:22 -07:00
ldsands
651e203cb7
Updated OneShot doc with example OneShot Modifier Combination
2022-04-20 15:58:53 -07:00
xs5871
1700aff408
implements scanner with rotaryio
2022-04-17 18:33:34 -07:00
xs5871
f7dac9e96e
add documentation
2022-04-17 18:33:14 -07:00
levpopov
a210c2bf62
Update Officially_Supported_Microcontrollers.md
2022-04-14 10:57:42 +00:00
levpopov
c8df1d10ad
nice!nano compile instructions
2022-04-14 10:57:42 +00:00
xs5871
d2e87b3e70
add keypad scanner for shift registers
2022-04-12 08:29:23 -07:00
xs5871
b3ec37e274
expose keypad options through scanner init
2022-04-11 18:26:43 -07:00
xs5871
ec8e167996
add documentation
2022-04-11 17:07:12 -07:00
Syed Hussaini
87d1b0c6b9
updated doc based on the presentation on github
2022-04-09 15:19:02 -07:00
Syed Hussaini
be308d516f
added docs
2022-04-09 15:19:02 -07:00
xs5871
74fa1fb52e
update docs and examples
2022-04-09 14:40:40 -07:00
Syed Hussaini
142a15e175
Updated doc to show the keys usage
2022-04-08 21:03:36 -07:00
Syed Hussaini
0cb69651c8
updated doc to reflect python style boolean
2022-04-08 20:22:43 -07:00
Syed Hussaini
6002ad33e1
rename to cg_swap and added docs
2022-04-08 20:22:43 -07:00
Jay Wiggins
cca5b91be2
add None to account for no encoder button
...
I had to dig through the code to find out what to do... adding it to the docs...
2022-04-08 08:44:52 -07:00
giovanniborella
9684e0d5f7
add vendor
2022-03-20 15:22:57 -07:00
giovanniborella
4f7f3dcc3c
Implement easypoint
2022-03-20 15:22:57 -07:00
Hilary B. Brenum (they/them)
58ea87dcc2
fix typo
2022-03-18 17:15:01 -07:00
HBBisenieks
2a560cf3f3
added license section
2022-03-18 17:15:01 -07:00
Hilary B. Brenum
275e61832f
call out make fix-isort etc before code commit
2022-03-18 17:15:01 -07:00
HBBisenieks
b2c7da2058
escaping graves is the worst
2022-03-18 17:15:01 -07:00
HBBisenieks
dc171360f6
backticks
2022-03-18 17:15:01 -07:00
HBBisenieks
32bafcdc46
documentation about documentation
2022-03-18 17:15:01 -07:00
xs5871
5c33fd3a9f
implement combo/chord/sequence module
2022-03-14 19:27:12 -07:00
HBBisenieks
a8e7f43e59
updates to boot.py docs to bring it more in-line with docs style
2022-03-14 17:36:42 -07:00
zyxwars
603833dbb7
Add more commets explaining the code
2022-03-12 08:37:05 -08:00
zyxwars
cbaf995e33
Add boot.py docs
2022-03-12 08:37:05 -08:00
donutcat
4d1f9e487e
Fix MIDI PR files
2022-03-06 00:56:05 -08:00
DonutCables
e52af4f58a
MIDI module and docs
2022-03-06 00:56:05 -08:00
HBBisenieks
e2f2c228d1
changes per https://github.com/KMKfw/kmk_firmware/pull/350\#issuecomment-1059061967
2022-03-05 10:40:09 -08:00
HBBisenieks
8dbbc42496
added example code for all layer keys
2022-03-05 10:40:09 -08:00
idesignstuff
b3c8245365
Update keys.md
...
Added example for use of .after_keys_handler() to change RGB settings and add serial print.
2022-02-27 18:06:01 -08:00
Kyle Brown
9f2142d706
Remove KMKpython reference
2022-02-27 16:04:38 -08:00
Hilary B. Brenum
2008e0ab3f
Add example of simple_key_sequence
2022-02-25 16:04:20 -08:00
xs5871
8cec85e3ec
base animation speed on system timer
2022-02-25 16:04:09 -08:00
tonasz
b7e3e4ea8c
Add doc index
2022-02-25 13:41:08 -08:00
Ellie T
aae476b59f
Updated scanner docs to reflect boilerplate changes
2022-02-20 18:42:38 -08:00
Jeroen Harkes
ecc8b46a2c
Change documentation changing the original LED code to statusLED
2022-02-20 12:10:04 -08:00
Jeroen Harkes
fd30b7a8d8
extension for indicating layer status with leds
2022-02-20 12:10:04 -08:00
Ellie
57ba0fe8b2
Custom matrix scanners
...
- Introduce Scanner base class for MatrixScanner
- Create new Scanner using built-in keypad module
- Allow overriding the scanner used by KMKKeyboard
2022-02-20 12:00:15 -08:00
Ellie T
2d4db12c46
Override LED creation in the RGB extension.
2022-02-19 22:27:31 -08:00
Rene Giovanni Borella
8e4ab1d733
Encoder class rebuild
...
implement BaseEncoder
2022-02-19 21:33:45 -08:00
Rene Giovanni Borella
3c4e74d50e
typo
2022-02-19 21:33:45 -08:00
Rene Giovanni Borella
ba7b5ce15c
Update i2c_encoder.md
2022-02-19 21:33:45 -08:00
Rene Giovanni Borella
671aa60838
basic functions
2022-02-19 21:33:45 -08:00
xs5871
dc4fc646aa
port all boards to new intify_coordinate signature.
2022-02-19 18:01:33 -08:00
xs5871
6840330f50
update documentation
2022-02-19 18:01:33 -08:00
tonasz
083f2e143d
Add simple PIO manual to split doc
2022-02-16 17:59:59 -08:00
tonasz
fdf8e9f78c
Add RP2040 PIO UART implementation for split keyboards
2022-02-16 17:59:59 -08:00
xs5871
f4807f341e
fix table formatting in docs.
2022-02-15 08:24:33 -08:00
xs5871
ee4cce32cb
implements oneshot/sticky keys.
2022-02-13 16:43:14 -08:00
xs5871
481c69b212
add at least some kind of documentation
2022-02-13 14:47:02 -08:00
tonasz
7fba42f28c
Small pimoroni_trackball.py refactors
2022-02-08 13:23:35 -08:00
tonasz
827862b34b
Pimoroni Trackball draft module
2022-02-08 13:23:35 -08:00
xs5871
91562abde9
update documentation
2022-02-07 16:25:45 -08:00
pcharest2000
a627102b52
Clarification regaring hadlers on keys
2022-02-05 16:37:51 -08:00
xs5871
8419ed789c
implement keyboard lock status reader API
2022-01-22 08:55:40 -08:00
xs5871
a62d39a252
make TapDance a module ( #281 )
...
* extract tapdance logic into a module
* clean out old tapdance code
* canonicalize key variable names
* split _process_tap_dance into td_pressed and td_released
* implement consistent argument order
* update documentation
* implement Module.process_key for key interception and modification
* fix tapdance realesing instead of pressing
* fix: default parameters in key handler
* cleanup holdtap
* add error handling to modules process_key
* fix: key released too late
Tapped keys didn't release on a "key released" event, but waited for a
timeout. Resulted in, for example, modifiers applying to keys after the
modifier was released.
* fix lint/formatting
* fix tap_time reference in modtap + minimal documentation
* fix lint
2022-01-18 05:21:05 +00:00
Lee A. Butler
61de548acb
improve wording on step 6
2022-01-02 07:08:22 +00:00
Lee A. Butler
2527542379
cleaner and smaller pins56.jpg
2022-01-02 07:08:22 +00:00
Lee A. Butler
14fd494cd4
clarify col_pins/row_pins example code in GettingStarted.md with image
2022-01-02 07:08:22 +00:00
iraytrace
c37170da56
Add specific example of setting row_pins/col_pins
...
The example code at least needs to
2022-01-02 07:08:22 +00:00
foamyguy
f7c0bd962b
fix boards link in getting started
2021-11-06 14:42:15 -07:00
Yoichiro Tanaka
235560bf72
Fix the issue #256 by changing the timing to set True fo the hid_pending flag.
2021-10-24 14:13:15 -07:00
FHA
f381761507
replaced by encoder.md (merge)
2021-10-17 09:12:20 -07:00
elric91
ed68ddb79d
Merge Encoder and NewEncoder. Enhance missteps handling
2021-10-17 09:12:20 -07:00
FHA
0f6e183235
new_encoder module basic documentation
2021-10-17 09:12:20 -07:00
Leon Anavi
1222477866
docs/Getting_Started.md: Fix link to user examples
...
Fix the broken link to KMK user examples.
Signed-off-by: Leon Anavi <leon@anavi.org>
2021-10-16 10:34:23 -07:00
Leon Anavi
a6606c6957
docs/Getting_Started.md: Fix a typo
...
Fix a minor typo in the getting started page.
Signed-off-by: Leon Anavi <leon@anavi.org>
2021-10-15 23:39:27 -07:00
AndersonTorres
3069608e56
ptBR translations: docs/ptBR/mouse_keys.md
2021-10-05 01:39:59 -03:00
AndersonTorres
48ab6767e4
ptBR translations: docs/ptBR/adns9800.md
2021-10-05 01:39:39 -03:00
Josh Klar
e5d7333e2e
Merge pull request #238 from kbjunky/master
...
added ADNS9800 and mouse keys/mouse buttons/mouse wheel support
2021-09-25 22:21:16 +00:00
kbjunky
1a5e7fa54b
adns9800_firmware.py removed
...
Cleaned up firmware file
Additional info in docs about missing firmware file and how to proceed without it.
2021-09-21 15:09:56 +08:00
Josh Klar
9c46eaeb9c
Merge pull request #240 from honboubao/ble-name
...
add ble_name option to KMKKeyboard.go method
2021-09-20 23:31:11 +00:00
Christian Tu
113e8eb867
fix doc typos and switched description for keycodes NUBS and NUHS
2021-09-17 08:54:22 -07:00
Christian Tu
3c9c527a96
add ble_name option to KMKKeyboard.go method
2021-09-17 16:14:11 +02:00
Athul Cyriac Ajay
e821acfca1
chore: Minor Fixes to Encoder Docs
...
- Updated code to add an import and close a list element
- Add Link to Keyboard main.py
- Minor Additions to Docs and Typo fixes
2021-09-16 17:18:31 +05:30
kbjunky
3d6e4fde41
added ADNS9800 and mouse keys/mouse buttons/mouse wheel support
...
ADNS9800 - module for interfacing with ADNS9800 optical sensor
mouse_keys - module for using mouse buttons, mouse wheel as well as moving mouse cursor with keyboard keys
2021-09-15 20:14:12 +08:00
Jasper Chan
7601a6f21f
Add QMK equivalent attributes of DiodeOrientation
2021-09-13 20:34:49 -07:00
AndersonTorres
02a9a088a0
Small fixups
2021-08-30 11:16:55 -07:00
AndersonTorres
aa55153a8e
ptBR translations: docs/ptBR/power.md
2021-08-30 11:16:55 -07:00
AndersonTorres
7991dc4609
ptBR translations: docs/ptBR/media_keys.md
2021-08-30 11:16:55 -07:00
AndersonTorres
dbe6e105e2
ptBR translations: docs/ptBR/led.md
2021-08-30 11:16:55 -07:00
AndersonTorres
c9184477fb
ptBR translations: docs/ptBR/ble_hid.md
2021-08-30 11:16:55 -07:00
AndersonTorres
25015e54ca
ptBR translations: docs/ptBR/flashing.md
2021-08-30 11:16:55 -07:00
AndersonTorres
8ee368cfe4
ptBR translations: docs/ptBR/international.md
2021-08-30 11:16:55 -07:00
AndersonTorres
2e75a89581
ptBR translations: docs/ptBR/modtap.md
2021-08-30 11:16:55 -07:00
AndersonTorres
137df5a46c
ptBR translations: docs/ptBR/encoder.md
2021-08-30 11:16:55 -07:00
AndersonTorres
9a2918d85c
ptBR translations: docs/ptBR/split_keyboards.md
2021-08-30 11:16:55 -07:00
AndersonTorres
bd31af0e14
ptBR translations: docs/ptBR/layers.md
2021-08-30 11:16:55 -07:00
AndersonTorres
c62b2e94f7
ptBR translations: docs/ptBR/tapdance.md
2021-08-30 11:16:55 -07:00
AndersonTorres
c023f368ba
ptBR translations: docs/ptBR/sequences.md
2021-08-30 11:16:55 -07:00
AndersonTorres
8d16cac06d
ptBR translations: docs/ptBR/config_and_keymap.md
2021-08-30 11:16:55 -07:00
AndersonTorres
b11fce321f
ptBR translations: docs/ptBR/keys.md
2021-08-30 11:16:55 -07:00
AndersonTorres
d21aa772a7
ptBR translations: docs/ptBR/rgb.md
2021-08-30 11:16:55 -07:00
AndersonTorres
9ad8233104
ptBR translations: docs/ptBR/modules.md
2021-08-30 11:16:55 -07:00
AndersonTorres
2b59ed7aec
ptBR translations: docs/ptBR/handwiring.md
2021-08-30 11:16:55 -07:00
AndersonTorres
2c6ec8c5da
ptBR translations: docs/ptBR/extensions.md
2021-08-30 11:16:55 -07:00
AndersonTorres
ceb9f69a38
ptBR translations: docs/ptBR/porting_to_kmk.md
2021-08-30 11:16:55 -07:00
AndersonTorres
46206dabbf
ptBR translations: docs/ptBR/keycodes.md
2021-08-30 11:16:55 -07:00
AndersonTorres
73b8542665
ptBR translations: docs/ptBR/debugging.md
2021-08-30 11:16:55 -07:00
AndersonTorres
fd097c3924
ptBR translations: docs/ptBR/support.md
2021-08-30 11:16:55 -07:00
Athul Cyriac Ajay
586d1deb4e
chore: Fix URL and added a space for cleaner look
2021-08-23 23:06:04 -07:00
AndersonTorres
796b7733f5
ptBR translation: docs/ptBR/kmkpython_vs_circuitpython.md
2021-08-19 15:44:53 -07:00
AndersonTorres
9eb86d2069
ptBR translation: docs/ptBR/Officially_Supported_Microcontrollers.md
2021-08-19 15:44:53 -07:00
AndersonTorres
a08ed5dc25
ptBR translation: docs/ptBR/Getting_Started.md
2021-08-19 15:44:53 -07:00
razel
9340579031
Translated Getting_Started.md to Japanese.
2021-08-13 07:15:48 -07:00
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
