Commit Graph

275 Commits

Author SHA1 Message Date
chemicalwill
f21fa5edb7 Added KC.MACRO_SLEEP_MS(ms) example
* provided an example of KC.MACRO_SLEEP_MS(ms) within sequences.md
2022-06-06 16:12:18 -07:00
chemicalwill
3ee701e986 Point KC.MACRO_SLEEP_MS(ms) to sequeces.md
* macros.md no longer exists
* moving documentation for KC.MACRO_SLEEP_MS(ms) to sequencs.md
2022-06-06 16:12:18 -07:00
xs5871
80b44b5c1b update combo docs 2022-06-05 16:32:25 -07:00
Stefan Foulis
8460c5abfe fix typo in code example in easypoint docs 2022-06-05 20:22:31 +00:00
Stefan Foulis
093d0329e6 fix typos in Split docs 2022-06-05 14:29:16 +00:00
Stefan Foulis
b04b740f9a fix typo in Split docs 2022-06-04 10:49:34 -07:00
Kyle Brown
645124dab6 cleanup comments 2022-05-31 23:09:49 -07:00
Cole Smith
b91974bce2 rgb matrix now can work out what side its on using the drive name 2022-05-28 12:05:36 -07:00
Isaac Benitez
4a29530ad5 Correct Split function in example code 2022-05-23 23:15:00 +00:00
Isaac Benitez
1771b76b19 Correct import statements in example code 2022-05-23 23:15:00 +00:00
cole smith
d895da5a6a Update peg_rgb_matrix.md 2022-05-21 19:36:26 -07:00
cole smith
fb931ab2d3 Update peg_rgb_matrix.md 2022-05-21 19:36:26 -07:00
cole smith
d95b4344dd Update peg_rgb_matrix.md 2022-05-21 19:36:26 -07:00
cole smith
dade827c76 Update peg_rgb_matrix.md 2022-05-21 19:36:26 -07:00
cole smith
72d6fb9304 Update peg_rgb_matrix.md 2022-05-21 19:36:26 -07:00
Cole Smith
eb23ed0020 added peg rgb_
matrix code and docs
2022-05-21 19:36:26 -07:00
chemicalwill
73e17d780a Changed links to relative filepath links 2022-05-20 12:29:37 -07:00
chemicalwill
da0e987b68 Updated directories and added links to keys.py 2022-05-20 12:29:37 -07:00
Steven Wilde
0e051a904b Added Dynamic Sequences to modules.md 2022-05-19 15:10:32 +00:00
Steven Wilde
8d0b835c9c Improved readability and finished renaming 2022-05-19 15:10:32 +00:00
Steven Wilde
a6e5ee1c08 Renamed to Dynamic Sequences 2022-05-19 15:10:32 +00:00
Steven Wilde
55b06bba79 Added dynamic macros module 2022-05-19 15:10:32 +00:00
Cole Smith
664af4d4f2 I missed a few things in the docs 2022-05-12 21:56:01 +00:00
Cole Smith
719cef4945 fixed docs formatting 2022-05-12 21:56:01 +00:00
Cole Smith
6970a6c786 oled data is now a class 2022-05-12 21:56:01 +00:00
Cole Smith
7e760a2917 made changes from klardotsh's review 2022-05-12 21:56:01 +00:00
Cole Smith
86e3b138b2 Required libs in docs 2022-05-12 21:56:01 +00:00
Cole Smith
caab7a4a15 added oleds and docs 2022-05-12 21:56:01 +00:00
John Morrison
c183bebb58 Conform class name case conventions 2022-05-08 20:10:41 +00:00
John Morrison
bea0f6d75b Requested rename 2022-05-08 20:10:41 +00:00
John Morrison
12e7a1b42c Class should be capital, use get rather than exception 2022-05-08 20:10:41 +00:00
John Morrison
73e95bfdde Change to be an extension 2022-05-08 20:10:41 +00:00
John Morrison
9f964aba36 Allow strings in keymap. Replace with keys in keyboard _init cycle. 2022-05-08 20:10:41 +00:00
xs5871
256c0f1c55 update tapdance docs 2022-05-06 20:29:26 -07:00
Syed Hussaini
609e275c03 doc updates based on the comments and refactoring 2022-05-02 21:02:40 +00:00
Syed Hussaini
660b751c87 review updates and renamed to Sticky Mod 2022-05-02 21:02:40 +00:00
Syed Hussaini
a0efbb92d5 docs update 2022-05-02 21:02:40 +00:00
Syed Hussaini
bce7959f66 modholdandtap implementation 2022-05-02 21:02:40 +00:00
xs5871
bd87b278b8 Update scanners.md
fix `KeysScanner` example
2022-04-25 16:03:18 -07:00
John Morrison
4419f13f1c PR requested changes 2022-04-25 17:50:26 +00:00
John Morrison
8950e45325 Mention index, get and the fact that all but ALPHA keys are case-sensitive to docs 2022-04-25 17:50:26 +00:00
cole smith
88cbbc6a90 Apply suggestions from code review
Thank you for sticking with me, I really appreciate it. I will try and only need to be told once

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
2022-04-25 16:54:08 +00:00
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