pwarren
/
zmk_mf68
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1,939 Commits 1 Branch 0 Tags 16 MiB
Commit Graph

478 Commits

Author SHA1 Message Date
Peter Johanson 6539b3ae25 refactor(split): Clean up Kconfig organization. 
* Seperated configs for split role (central/peripheral)
  and transport (BLE only for now).
* Split the configs to align on structure.
 2022-05-29 19:18:09 -04:00
Kurtis Lew 8a70d5fccc
feat(docs): Add New Behavior Guide 
Co-authored-by: Henré Botha <henrebotha@gmail.com>
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Co-authored-by: Dom H <dom@hxy.io>
Co-authored-by: Pete Johanson <peter@peterjohanson.com>
 2022-05-21 17:26:10 +01:00
Peter Johanson 64dadfb336 refactor(tests): Move remaining tests to posix 64. 
* Update docs and fix up a few lingering tests
  to consistently use native_posix_64 target.
 2022-05-19 10:55:23 -04:00
Kurtis Lew 8bbbf530a7 fix(docs): Remove code-snippet backticks from customization.md title 
Discussed here: https://discord.com/channels/719497620560543766/883452966114324550/970385441134104747

Code snippets in titles are not formatted properly in page titles
 2022-05-01 21:14:19 +01:00
Joel Spadin d7b912b798 fix(docs): Fix broken links in FAQs 2022-04-30 09:34:30 +01:00
Dom H e5843b268c fix(docs): Clarify `timeout-ms` for Combos 2022-04-29 14:13:04 -04:00
Andrew Rae b5efc7a7eb
feat(behaviors): Add `global-quick-tap` 2022-04-27 13:33:22 +01:00
Xudong Zheng dffae5cf2b fix(docs): Correct default Mod-Tap behavior 2022-04-26 18:49:15 +01:00
Kurtis Lew 2a38849f4e fix(docs): Fix link to `BT_CTLR_TX_PWR` adjustment in Zephyr docs 2022-04-25 19:59:20 +01:00
Thomas de Barochez a24cc5d688 doc(backlight): small typo 2022-04-21 18:42:54 -05:00
Peter Johanson c8c273d83b feat(docs): Add TOC to supported hardware page. 2022-04-19 07:05:26 -04: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
Herald ebc6275a72
fix(docs): Document `ignore-modifiers` and `quick-release` for sticky keys (#1228) 2022-04-14 16:13:33 +01: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
Cem Aksoylar 32c8737a22 fix(docs): Fix cmake version requirements 2022-04-08 07:18:44 -04:00
Albert Y 6753d31ee9
docs: Revise "Troubleshooting" for Zephyr 3.0 (#1214) 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Co-authored-by: Dom H <dom@hxy.io>
 2022-04-07 09:26:22 +01:00
Caleb Goates 9c3d909b82 feat(docs): Reference conditional layers from the layers behavior page 2022-04-06 19:11:23 +01:00
Cem Aksoylar 27ba5fdfb3 fix(docs): Improve powershell command for setup script for failure cases 2022-04-03 08:39:15 +01:00
Peter Johanson 3c4ff9c82c fix(docs): Proper links to new SDK version. 2022-04-03 00:10:29 -04:00
Peter Johanson bf2fc68070 fix(underglow): Add newly required color-mapping prop. 2022-04-03 00:10:29 -04:00
Kurtis Lew 28ef19488d fix(docs): Fix Number of Profiles note in Bluetooth docs 
Remove hard line wrapping
 2022-03-31 09:00:47 +01:00
Albert Y 59d2744a4f
feat(docs): Add settings_reset build instructions (#1197) 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2022-03-30 09:56:47 +01:00
Cem Aksoylar 92e7618346 fix(docs): Fix Windows unicode macro example 2022-03-28 21:16:48 -04:00
Albert Y 5f35a0bf58
feat(docs): Add note on locating tmp file in GH actions (#1177) 
Co-authored-by: Dom H <dom@hxy.io>
 2022-03-28 08:44:34 +01:00
Peter Johanson 34e1de23fb feat(docs): Document the macro behavior. 2022-03-23 23:42:54 -04:00
Kurtis Lew 58c7c0ee0c
feat(docs): Add tap-dance to feature matrix 2022-03-16 11:06:55 -04:00
Kurtis Lew 32ebe2cfb5
feat(behaviors): Add Tap-Dance behavior 2022-03-16 01:08:42 -04:00
Caleb Goates 594cc55e0c fix(docs): Update instructions to find settings reset firmware 2022-03-08 06:21:53 -05:00
Dom H 322cc14da6 fix(docs): Remove trailing whitespace 
Otherwise, prettier fails.
 2022-02-16 15:29:02 +00:00
chadbailey59 43ffa6c760
docs: Clarifications within New Shield page (#1130) 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2022-02-16 11:46:15 +00:00
Cem Aksoylar 5c4f26ae74 fix(docs): Tweak label of left-hand positional hold-tap example behavior 
We see folks copying this behavior node and duplicating it for the right hand,
then forgetting to modify the "label" value and getting confusing runtime
behavior. If we modify the label to be left-specific like this it might be
a better hint to change it when duplicating it.
 2022-02-12 07:09:58 +00:00
Cem Aksoylar 22ed448843 fix(docs): Replace deprecated keycode in positional-hold-tap example 2022-02-12 07:09:58 +00:00
Albert Y 7474d985c9
docs: Add guide to build additional keyboards with GH Actions (#1126) 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2022-02-11 10:05:04 +00:00
Cem Aksoylar c18c3d9106 feat(docs): Add note for combos invoking source-specific behaviors 2022-02-07 09:30:16 -05:00
Cem Aksoylar 76268bae8f feat(docs): Document locality for backlight behaviors 2022-02-07 09:30:16 -05:00
Cem Aksoylar a1ef7c8090 feat(docs): Document locality for RGB underglow behaviors 2022-02-07 09:30:16 -05:00
Cem Aksoylar c0b5985ac7 feat(docs): Document locality for power management behaviors 2022-02-07 09:30:16 -05:00
Cem Aksoylar 5c4bf8a3bb feat(docs): Document locality for reset 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 13a4515300 feat(backlight): add command to cycle brightness 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
Peter Johanson 70bb7c9334 feat(behaviors): `&key_repeat` behavior + tests. 
* Add new `&key_repeat` behavior that captures and re-sends
  the most recently triggered keycode.

Closes: #853
 2022-01-30 22:47:34 -05:00
Albert Y 2ad8f687c0
docs: Add a note for GitHub SSH scheme (#1089) 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2022-01-13 09:23:43 +00:00
Evan Callicoat be343674de
docs: Fix typos and inconsistent spellings (#1079) 2022-01-02 10:34:21 +00:00
Cem Aksoylar ef0d088cb8 feat(docs): Link to outputs page in troubleshooting re: BT output 2021-12-28 21:17:48 +00:00
Cem Aksoylar 8c321063a0 feat(docs): Add note for USB power in outputs page 2021-12-28 21:17:48 +00:00
Ivan Smirnov 3114ce00b9
docs: reiterate building from `zmk/app/` (#1031) 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2021-12-28 10:52:16 +00:00
Albert Y a562578fd2
docs: change quick_tap_ms to quick-tap-ms (#1071) 2021-12-28 10:04:18 +00:00
Evan Callicoat 62e3b573b9 Typos 2021-12-26 13:44:46 -06:00
Pete Johanson c4ad3bc5dc fix(docs): Make the modifier function examples clearer. 
* Ensure the list of available modifier functions is clearly shown
  as macros, not as basic defines.
 2021-12-01 16:56:15 -05:00
Peter Johanson 54dabffd0d feat(behaviors): Add caps word (`&caps_word`). 
* Add new `&caps_word` behavior that acts like caps lock, but
  releases automatically when any "break" keycode is pressed.
 2021-11-28 22:41:35 -05:00
Jonathan Rascher cbf6e28e34 docs(conditional-layers): Document feature 2021-11-15 05:49:23 -05:00
jding 4e62319982 feat: hold/tap flavor tap-unless-interrupted 
Implements new hold/tap flavor, tap-unless-interrupted
Adds tests
Adds docs
 2021-11-09 01:07:05 -05:00
jmding8 19ee7849f8
feat(behaviors) Required keys for tap-hold behaviors 
* Add optional `hold-trigger-key-positions` hold-tap configuration
* Leverage configuration for decision making around when to trigger
  hold decision in hold-taps.
* Add docs for new configuration.
* Tests for the new config/decision logic.
 2021-11-01 12:37:20 -04: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
Manuel Transfeld 05167c6539
fix(docs): Typo fix, open -> upon 2021-10-20 22:54:48 -04:00
Jonathan Rascher 96fea949d5 docs(docs): Document up-to-date Node.js repo 
For example, Debian Bullseye (current stable) packages Node.js version
12, which is too old to build the docs successfully. At least version 14
is required, and version 16 is current. General advice seems to be to
install from the NodeSource repo instead of your distro's repo, so I
added a suggestion to the docs.
 2021-10-10 12:20:35 -07:00
Nick Winans e6645882c3 feat(docs): Update documentation to match new Pro Micro nodes 2021-09-25 23:09:21 -04:00
Nick Winans 10870b24bf fix(docs): Update split naming system 2021-09-25 21:17:24 -04:00
Richard Titmuss 5d2120ad17 fix(docs): Typo EC11_CONFIG 
This should be CONFIG_EC11
 2021-09-24 02:15:56 -04:00
Dom H c52887e236 fix(docs): Remove build.yml from new shield steps 2021-09-22 17:35:08 -04:00
Dom H 8bdd270c91 fix(docs): Set "Mouse Keys" as "Under Development" 2021-09-17 10:49:56 -04:00
Michael van Eerd 50174af658 fix(docs) add `BT_PRV` as suggested 
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 2021-09-17 10:45:37 -04:00
Michael van Eerd c27c1048e4 fix(docs) Bluetooth behavior typo 2021-09-17 10:45:37 -04:00
Michael van Eerd 748bc75587 fix(docs) Move Number of Profiles note down 2021-09-17 10:45:37 -04:00
Michael van Eerd 05b0353219 feat(docs) Clarify Bluetooth profile pairing 2021-09-17 10:45:37 -04:00
Richard Titmuss d769618b3f fix(docs): Remove unnecessary security warning for MacOS 
The security warning applies for downloaded executables. If you are
following the instructions the toolchain is installed with brew and
the security warning does not apply. This is explained in the removed
link.
 2021-09-17 10:43:48 -04:00
Cem Aksoylar 33fa15a235
feat(docs): Add note to clarify shared .conf files do not apply outside zmk-config 2021-09-14 20:51:05 -04:00
Peter Johanson 7bf68f2a00 refactor(docs): Remove build.yml for new shield. 
* No longer recommending that all new shields get added to the
  build matrix in `build.yml`, so we avoid conflicts.
 2021-09-11 00:50:36 -04:00
Peter Johanson f8e88d78c4 docs: Add docs on hardware metadata files. 2021-09-11 00:50:36 -04:00
Peter Johanson 47abbe7925 feat(docs): Add dynamic hardware list component. 2021-09-11 00:50:36 -04:00
chad3814 b235034dc9 fix typo 
"load your newly flashed firmware" not "load your newfly flashed fireware"
 2021-08-12 19:14:44 -05: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
Felix Sargent 6d105f324b
Update docs to use “SQT” instead of “QUOTE” (#839) 
* Update default keymap to use SQT

Instead of the invalid “QUOTE”

* Update keymap-example-file.md

* Update docs/docs/keymap-example.md

Co-authored-by: Pete Johanson <peter@peterjohanson.com>

Co-authored-by: Pete Johanson <peter@peterjohanson.com>
 2021-07-27 18:18:52 -05:00
innovaker a8c0c76fca docs(setup): replace `zephyr-west-action` with `zmk-docker` 
This should've been changed after #481.

See: https://github.com/zmkfirmware/zmk/pull/481
PR: https://github.com/zmkfirmware/zmk/pull/845
 2021-07-18 03:52:45 +01:00
innovaker 47043c86e9 docs: bump Zephyr documentation links to Zephyr v2.5.0 
PR: https://github.com/zmkfirmware/zmk/pull/736
 2021-07-17 17:04:25 -04:00
innovaker c03046e54a docs(setup): add `x86_64-linux` to Zephyr SDK setup filename 
See: zmkfirmware/zmk-docker@b8341e185a
PR: https://github.com/zmkfirmware/zmk/pull/736
 2021-07-17 17:04:25 -04:00
innovaker 76979d293a docs(setup): bump `ZSDK_VERSION` to `0.12.4` 
PR: https://github.com/zmkfirmware/zmk/pull/736
 2021-07-17 17:04:25 -04:00
Nick Winans 9c1319c4ff feat(docs): Add nice!nano v2 to scripts, actions, and documentation 
asdf

asdf


asdf
 2021-07-15 18:52:28 -04:00
innovaker 576ce76ad3 docs(setup): fix whitespace in Fedora toolchain install command 
Aligns Fedora whitespace with Debian.
 2021-06-16 16:23:53 -05:00
innovaker 84a5fec458 docs(setup): remove extra slash from Fedora toolchain install command 2021-06-16 16:23:53 -05:00
innovaker 6f3a2529ae docs(setup): fix whitespace mismatch in host dependencies 
Replaces spaces with tabs (bzip2).
 2021-06-16 16:23:53 -05:00
Peter Johanson 3f4839ec96 refactor: Move to new zmk.dev domain name. 2021-06-10 09:27:57 -04:00
Peter Johanson ba45aaa81b chore(docs): Bump prettier, and reformat w/ it. 
* Bump to prettier 2.3.1.
* Re-run prettier:format to apply updated format.
 2021-06-09 10:58:53 -04:00
Peter Johanson 7323f78a37 fix(docs): Upgrade docusaurus, webpack/loaders. 
Upgrade to the new Docusaurus 2 beta release, which also required
upgrades to newer Webpack@5, and some API fixes for TOC changes.
 2021-06-09 10:12:06 -04:00
Martin Eberhardt 87ee2304a1
feat(docs): Add icon legend to the feature matrix 
Add icon legend to the feature matrix
 2021-06-08 21:06:20 -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
Ivan Smirnov bb32005474
fix(docs): Update macos GCC embedded section with brew cmd 
* Update macos GCC embedded section with brew cmd

Brew has a cask for GCC embedded, so we can make this guide more user friendly by providing it.
 2021-06-08 20:56:10 -04:00
Christian Stücklberger 8196b1d46b
fix(docs): Add missing semicolon to examples 
Co-authored-by: Christian Stücklberger <christian.stuecklberger@ergon.ch>
 2021-05-19 11:10:29 -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
measlesbagel 3893d50e13
Docs: added mod morph page (#749) 
* docs(behaviors): add mod-morph doc page

* docs(behaviors): add mod-morph doc page

* docs(mod-morph): add note about sent modifiers

* docs(mod-morph): fixed prettier formatting
 2021-04-05 18:04:38 -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