kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
2041 commits 18 branches 0 tags 93 MiB
Commit graph

44 commits

Author SHA1 Message Date
Joel Spadin
94061bb916 refactor: Replace tabs with spaces 
Standardized indentation to use spaces with a new pre-commit hook.
 2023-04-24 16:07:04 -07:00
Nick Conway
3db163aa2c feat(behaviors): Add reusable sensor behaviors. 
* Add new sensor behaviors that either take full bindings
  add definition, or accept parameters when bound in the
  keymap.
* Remove existing hard-coded key press sensor behavior
  and instead leverage new generic sensor behaviors to
  achieve the same functionality.

Co-authored-by: nick@conway.dev
 2023-04-21 21:13:31 -07:00
Peter Johanson
374104dec6 fix(underglow): Move to spi3 for underglow bus. 
* Workaround Zephyr bug for Nordic SPI(M) driver after the
  pinctrl refactor by using spi3 peripheral for the SPI bus for
  the WS2812 led_strip driver.
 2023-04-09 14:41:00 -07:00
Peter Johanson
0c5bcf5fe4 feat(docs): Add BLE feature/config pages. 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2023-04-05 22:55:38 -07:00
Peter Johanson
1493620bf7 refactor(boards): Move to pinctrl. 2023-04-05 22:55:38 -07:00
Anton
f238001904
doc(keymaps): fix typo (#1425) 2022-08-12 07:37:06 -04:00
Joel Spadin
ae78aa247a feat(docs): Update power and lighting config pages 
Moved battery configuration to its own page to match the feature page.

Documented that external power is disabled when in sleep mode.

Clarified that the *_START configs apply on first boot, and any changes
after that are persisted.
 2022-07-03 18:55:54 +01:00
Joel Spadin
e0e0928f9c fix(docs): Update config docs for review feedback 2022-07-03 18:55:54 +01:00
Joel Spadin
c350f7130b fix(docs): Fix links in config pages 2022-07-03 18:55:54 +01:00
Joel Spadin
11861a4d30 docs: Add documentation for config options 2022-07-03 18:55:54 +01:00
Dom H
e5843b268c fix(docs): Clarify timeout-ms for Combos 2022-04-29 14:13:04 -04:00
Thomas de Barochez
a24cc5d688 doc(backlight): small typo 2022-04-21 18:42:54 -05:00
Dom H
6308ab9426 fix(docs): Ensure relative links always resolve 
Linking to the document _file path_ rather than the document _URL_
ensures that the link resolves regardless of trailing slash config.

More information is at https://docusaurus.io/docs/docs-markdown-features
 2022-04-18 22:48:53 -05:00
Dom H
3e294375b6 feat(docs): Provide current status of Displays 2022-04-18 12:15:49 -04:00
Joel Spadin
b7b026f20c feat(docs): Add battery sensor documentation 2022-04-17 11:30:57 -04:00
DoctorNefario
0e54603ec6 fix(docs): Clarify backlight & underglow use cases 
This should help reduce confusion for newcomers.
 2022-04-14 16:03:29 +01:00
Peter Johanson
bf2fc68070 fix(underglow): Add newly required color-mapping prop. 2022-04-03 00:10:29 -04:00
Cem Aksoylar
c18c3d9106 feat(docs): Add note for combos invoking source-specific behaviors 2022-02-07 09:30:16 -05:00
Alessandro Bortolin
be94e04963 docs(backlight): improve documentation 2022-02-05 23:40:18 -05:00
Alessandro Bortolin
2c0fe3934d feat(backlight): add tests 2022-02-05 23:40:18 -05:00
Alessandro Bortolin
ce843825e8 refactor(backlight): code cleanup 2022-02-05 23:40:18 -05:00
Alessandro Bortolin
da41391b1f feat(docs): add backlight documentation 2022-02-05 23:40:18 -05:00
Evan Callicoat
be343674de
docs: Fix typos and inconsistent spellings (#1079) 2022-01-02 10:34:21 +00:00
Jonathan Rascher
cbf6e28e34 docs(conditional-layers): Document feature 2021-11-15 05:49:23 -05:00
Joel Spadin
f946dc6893 feat(kscan): Improve matrix debouncing 
Switched the GPIO matrix driver to debouncing using a simple integrator
algorithm. Whenever a key is pressed, we now scan at a rate controlled
by debounce-scan-period-ms (default 1 ms) until all keys are released,
then return to either waiting for an interrupt or polling more slowly.

The timers for key press and release can now be controlled separately,
so debounce-period is deprecated in favor of debounce-press-ms and
debounce-release-ms. Global Kconfig options
ZMK_KSCAN_DEBOUNCE_PRESS_MS and ZMK_KSCAN_DEBOUNCE_RELEASE_MS are also
added to make these easier to set.

Added documentation for debouncing options.
 2021-10-26 23:52:13 -04:00
Richard Titmuss
5d2120ad17 fix(docs): Typo EC11_CONFIG 
This should be CONFIG_EC11
 2021-09-24 02:15:56 -04:00
Nick Winans
d964faaa89 fix(docs): Standardize all internal links 2021-08-12 20:07:45 -04:00
chad3814
689ba2d171
fix(docs): Fix "All" typo 2021-08-12 00:08:49 -04:00
Joel Spadin
6870fdc604 fix(docs): Appease Prettier 
Fixed code formatting in docs files.
 2021-08-08 13:17:27 -05:00
Peter Johanson
47109641d8 Add warning about peripheral encoders. 2021-08-04 22:25:41 -04:00
Dom H
06a85f944f docs(codes): Refer to LSHIFT instead of LSHFT 
`LSHIFT` is slightly more intuitive and should result in fewer user
errors.
 2021-06-08 20:57:40 -04:00
Michael van Eerd
fadb508671
fix(docs) omit layers -1 example, clarify it defaults when omitted (#757) 
* fix(docs) omit layers -1 example, clarify

* comment, simplify description

* remove 'the'
 2021-04-15 03:31:07 -05:00
Cody McGinnis
d956193251 change "Under Development" to "Beta Testing" 2021-03-10 13:45:50 -05:00
Cody McGinnis
ac50e741be move the information to its own page 2021-03-10 13:45:50 -05:00
Megamannen
a7c6e080a7
Fix broken link in documentation (encoders) (#707) 
* Update encoders.md

Link to "New Keyboard Shield" didn't work

* Update encoders.md

Forgot hash-link
 2021-03-03 00:06:29 -06:00
Megamannen
0a7491af87
Add detailed pin mapping explanation to underglow docs (#709) 
* Update underglow.md

Updated the documentation according to my current understandring of how to pin-mapping works, also split the chapter into a nrf-section and a non-nrf-section since that information isn't applicable to both

* Ran prettier and updated pin reference according to suggestion
 2021-03-03 00:03:12 -06:00
KemoNine
cd503ed17b
Feat combo layers (#661) 
feat(combos): add layer filtering

Co-authored-by: KemoNine <mcrosson@kemonine.info>
 2021-02-03 23:33:09 -05:00
Pete Johanson
e8aa576781 refactor(docs): Move combos under Features. 
* Since combos aren't a behavior, but a new high level keymap
  feature, move under Features section.
 2021-01-24 16:42:44 -05:00
Nick
a1d3230eef feat(underglow): RGB toggle controls ext_power 
fix(ug): Don't return if finding ext power fails

fix(ug): Move ext_power to a static variable

Add #if defs
 2020-11-22 21:23:29 -05:00
innovaker
2744f44e73 refactor(docs): Integrate Dev Guides into Development section 
Improves discoverability.
 2020-11-20 22:31:56 -05:00
innovaker
532c1987b2 refactor(docs): Move dev- documents into /development 
Aligns to conventions introduced by newer documentation.
 2020-11-20 22:31:56 -05:00
innovaker
28a4f33ee7 refactor(docs): Extract keymap examples into their own files 
Eases maintenance and promotes reuse.
 2020-11-16 21:39:38 -05:00
innovaker
2871dca9bf refactor(docs): Change behavior to behaviors 
Makes a better URL.
 2020-11-16 15:33:44 -05:00
innovaker
a685d88744 refactor(docs): Change feature to features 
Makes a better URL.
 2020-11-16 15:33:44 -05:00