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
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
cbf6e28e34
docs(conditional-layers): Document feature
2021-11-15 05:49:23 -05:00
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
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
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
05167c6539
fix(docs): Typo fix, open -> upon
2021-10-20 22:54:48 -04:00
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
e6645882c3
feat(docs): Update documentation to match new Pro Micro nodes
2021-09-25 23:09:21 -04:00
10870b24bf
fix(docs): Update split naming system
2021-09-25 21:17:24 -04:00
5d2120ad17
fix(docs): Typo EC11_CONFIG
...
This should be CONFIG_EC11
2021-09-24 02:15:56 -04:00
c52887e236
fix(docs): Remove build.yml from new shield steps
2021-09-22 17:35:08 -04:00
8bdd270c91
fix(docs): Set "Mouse Keys" as "Under Development"
2021-09-17 10:49:56 -04:00
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
c27c1048e4
fix(docs) Bluetooth behavior typo
2021-09-17 10:45:37 -04:00
748bc75587
fix(docs) Move Number of Profiles note down
2021-09-17 10:45:37 -04:00
05b0353219
feat(docs) Clarify Bluetooth profile pairing
2021-09-17 10:45:37 -04:00
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
33fa15a235
feat(docs): Add note to clarify shared .conf files do not apply outside zmk-config
2021-09-14 20:51:05 -04:00
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
f8e88d78c4
docs: Add docs on hardware metadata files.
2021-09-11 00:50:36 -04:00
47abbe7925
feat(docs): Add dynamic hardware list component.
2021-09-11 00:50:36 -04:00
b235034dc9
fix typo
...
"load your newly flashed firmware" not "load your newfly flashed fireware"
2021-08-12 19:14:44 -05:00
d964faaa89
fix(docs): Standardize all internal links
2021-08-12 20:07:45 -04:00
689ba2d171
fix(docs): Fix "All" typo
2021-08-12 00:08:49 -04:00
6870fdc604
fix(docs): Appease Prettier
...
Fixed code formatting in docs files.
2021-08-08 13:17:27 -05:00
47109641d8
Add warning about peripheral encoders.
2021-08-04 22:25:41 -04:00
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
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
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
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
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
9c1319c4ff
feat(docs): Add nice!nano v2 to scripts, actions, and documentation
...
asdf
asdf
asdf
2021-07-15 18:52:28 -04:00
576ce76ad3
docs(setup): fix whitespace in Fedora toolchain install command
...
Aligns Fedora whitespace with Debian.
2021-06-16 16:23:53 -05:00
84a5fec458
docs(setup): remove extra slash from Fedora toolchain install command
2021-06-16 16:23:53 -05:00
6f3a2529ae
docs(setup): fix whitespace mismatch in host dependencies
...
Replaces spaces with tabs (bzip2).
2021-06-16 16:23:53 -05:00
3f4839ec96
refactor: Move to new zmk.dev domain name.
2021-06-10 09:27:57 -04:00
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
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
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
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
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
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
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
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
d956193251
change "Under Development" to "Beta Testing"
2021-03-10 13:45:50 -05:00
ac50e741be
move the information to its own page
2021-03-10 13:45:50 -05:00
daf10d9741
feat(docs): add information for testing PRs
2021-03-10 13:45:50 -05:00
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
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
0c1940bb79
feature(hold-tap): no-hold-flash for retro taps
...
This is an improvement on retro-tap, solving the 'flashing hold' issue
users people experience.
When the tapping-term expires, the hold key is normally pressed. When
retro-tap is enabled, this is undesirable; only an interrupted hold-tap
should trigger the hold behavior.
This change disables the hold behavior for the 'STATUS_HOLD_TIMER'
state when retro-tap is enabled, and makes sure the
'STATUS_HOLD_INTERRUPT' state will be triggered when appropriate.
2021-02-24 07:24:27 -05:00
89ed816c67
feature(hold-tap): Retro tapping
2021-02-24 07:24:27 -05:00
af9d6e9b05
style(hold-tap)!: Write hold-tap params with dashes
...
tapping_term_ms -> tapping-term-ms
quick_tap_ms -> quick-tap-ms
The old style works, although it's deprecated.
2021-02-10 07:55:12 -05:00
24ed1a8eaa
docs(vscode): add more info for compile_commands.json path
2021-02-09 00:45:55 -05:00
0955ffef65
docs: Add docs for setting up vscode
...
Added a docs page with tips for setting up VS Code's code completion to work
in ZMK's source files. Info for other IDEs can be added here later as needed.
2021-02-09 00:45:55 -05:00
b67156b3f4
feat(docs): Update to BlueMicro_BLE Features
2021-02-08 10:48:12 -05:00
ae5056d680
Update docs/docs/behaviors/bluetooth.md
...
Co-authored-by: innovaker <66737976+innovaker@users.noreply.github.com>
2021-02-04 07:45:55 -05:00
1368a6481e
docs: Explain ZMK stays connected to inactive host
...
This behavior was not obvious to me, and I actually considered reporting
it as a bug until @Nicell explained to me on Discord that it's WAI. :)
2021-02-04 07:45:55 -05:00
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
9a7908b632
behaviors(hold-tap): Implement quick_tap_ms (TAPPING_FORCE_HOLD)
...
Tap-and-hold a hold-tap to hold the tap behavior so it can repeat.
After a tap, if the same key is pressed within `quick_tap_ms`, the
tap behavior is always picked.
This is useful for things like `&ht LSHFT BACKSPACE` where holding
the backspace is required.
Implements #288 .
2021-02-02 15:28:16 -05:00
bcc3d9b5a6
Update build/flash documentation.
...
Updated docs for the build and flash to have similar content to the new board page.
Added a bit about DFU in case someone were searching for that term.
2021-02-02 01:02:54 -05:00
592b98cd12
npm run prettier:format
2021-02-02 01:02:54 -05:00
100d06ae8b
Update docs for testing a new shield.
...
Clarifying the need for `west flash` in a dockerized environment and providing a high-level overview of testing a board with UF2 support.
2021-02-02 01:02:54 -05:00
f39121f82e
fix(docs): Remove comment about here being four profiles for splits
2021-01-30 00:36:18 -05:00
cba85d400d
fix(docs): Only show push workflow builds in link
2021-01-29 22:09:22 -05:00
1adb2d5f84
feat(docs): add information on how to update the documentation to the docs
2021-01-29 20:44:39 -06:00
89567d3150
docs(sticky keys): document sticky keys and sticky layers
2021-01-24 23:30:05 -05:00
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
13e46bea81
docs(hold-tap): mark tapping_term_ms as code
...
Improves readability and consistency.
2021-01-21 07:57:33 -05:00
feb0d5b90c
feat(combos): initial implementation
...
closes #45
2021-01-13 21:07:41 -05:00
0c6686f6e8
docs(split): Remove USB configuration on right half
2021-01-08 16:51:50 -05:00
af563e9dbc
Fix parameter number
2021-01-08 16:08:13 -05:00
79b4a0ea6f
Add RGB_COLOR_HSB to lighting documentation
2021-01-08 16:08:13 -05:00
167600f01d
docs(logging): Update documentation on USB logging
2021-01-08 13:03:39 -05:00
56ec200bae
docs(intro): Add 💡 to Mouse Keys and BLE Shell
2021-01-05 19:37:00 +00:00
ad238d63df
docs(intro): Update feature table
2021-01-05 19:37:00 +00:00
4c1f615714
docs(troubleshooting): fix reset uf2 download instructions
...
PR: #512
Co-authored-by: innovaker <66737976+innovaker@users.noreply.github.com>
2021-01-05 19:29:47 +00:00
5c11962d98
feat(shields): add helix shield
...
PR: #429
2021-01-05 18:56:47 +00:00
a470353760
docs(shield): Add docs based on #510 changes
2021-01-04 14:08:00 -05:00
74b397ab91
fix(docs): Add closing bracket for new shield.
2021-01-04 11:59:25 -05:00
4ddda7e024
docs(shield): Remove SPLIT_BLE_ROLE_PERIPHERAL
...
Removes CONFIG_ZMK_SPLIT_BLE_ROLE_PERIPHERAL from the new shield docs
See: #510
Refs: 4db5b169bf
2021-01-04 00:13:49 +00:00
dcd665999a
feat(shields): add bfo9000 shield
...
PR: #472
2021-01-02 18:52:50 +00:00
5752b4fbda
feat(shields): add eek shield
...
PR: #529
2021-01-01 14:33:19 +00:00
39490552f2
feat(boards): Add BDN9 Rev2 board.
...
* Onboard stm32f072.
* 3 possible encoder positions.
* Underglow/per-key not yet support.
2020-12-31 14:46:15 -05:00
d207c3c30f
(feature) Add &to keycode/behavior ( #489 )
...
feat(behaviors): Add `&to` behavior to switch to a layer.
2020-12-29 11:57:49 -05:00
842aa5a842
refactor: replace filename hyphens with underscores
...
Aligns *.h and *.c to underscore naming convention.
These were kept (with warnings) for backwards compatibility with external boards/shields:
- kscan-mock.h
- matrix-transform.h
They should be removed in the future.
PR: #523
2020-12-28 01:15:35 -05:00
8fd9b619a7
docs(setup): bump Zephyr SDK version to 0.11.4
...
Latest stable version. Also used in zmk-docker images.
2020-12-18 09:40:39 -05:00
e89aa1cde8
docs(codes): improve iOS keyboard/keypad support data
...
Co-authored-by: innovaker <66737976+innovaker@users.noreply.github.com>
PR: #356
See: #376
2020-12-17 11:05:34 +00:00
565a72bf95
feat(shields): add tidbit and tidbit_19key shields
2020-12-17 10:57:06 +00:00
8a529163fc
docs(logging): remove CONFIG_USB_UART_DTR_WAIT
...
This configuration option was removed in Zephyr v2.4.0.
See: zephyrproject-rtos/zephyr#27427
PR: #467
2020-12-14 12:41:25 -05:00
5aa8a07aa9
feat(docs): add keymap upgrader
...
Added a documentation page with a script that upgrades deprecated key
codes and behaviors to their replacements.
Fixes #299
2020-12-10 12:23:05 +00:00
4c92a4e50f
docs(codes): improve macOS support data
...
Tested with Karabiner-EventViewer as well as some manual checks.
PR: #377
See: #375
2020-12-09 13:58:24 +00:00
02673e2f1d
update doc about bluetooth
2020-12-08 01:11:48 -05:00
784ddfc620
Add note about cmake 3.19 not working with zephr ; addresses issue #487
2020-12-08 00:41:33 -05:00
b0c525df72
feat(shields): add CRBN shield
...
Co-authored-by: innovaker <66737976+innovaker@users.noreply.github.com>
PR: #483
2020-12-07 16:49:37 +00:00
9c1a544381
Add note about default number of available profiles and how to increase if desired
2020-12-06 22:55:31 -05:00
52df05a545
Tweak/cleanup bluetooth documentation so it's more clear which codes should be used in keymaps as well as to call attention to BT_SEL requiring a second parameter
2020-12-06 22:55:31 -05:00
f8af592a9c
Update cmake note to be 3.15 which is the current minimum version. This is a re-implementation of GitHub PR 403
2020-12-02 16:01:20 -05:00
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
6573483a10
update errors in mod-tap docs
2020-11-22 21:06:42 -05:00
Pete Johanson
Jonathan Rascher
jding
jmding8
Joel Spadin
Manuel Transfeld
Nick Winans
Richard Titmuss
Dom H
Michael van Eerd
Richard Titmuss
Cem Aksoylar
chad3814
Felix Sargent
innovaker
Martin Eberhardt
Ivan Smirnov
Christian Stücklberger
measlesbagel
Cody McGinnis
Megamannen
Okke Formsma
Pierre Constantineau
KemoNine
Aaron Nunley
Nick Winans
KemoNine
KingCoinless
pbz
Mango The Fourth
onebigdoor
Chiyuan Zhang
ReFil