Commit graph

573 commits

Author SHA1 Message Date
Cem Aksoylar
3d938033b0 feat(docs): Note GPIO flags and add examples 2023-09-02 20:49:19 -07:00
Cem Aksoylar
1e11e84d0d fix(docs): Fix row/col comments in matrix examples 2023-09-02 20:49:19 -07:00
Cem Aksoylar
fd47965838 fix(docs): Remove diode-direction from direct GPIO driver 2023-09-02 20:45:29 -07:00
Peter Johanson
dcb1f8f135 fix(docs): Update docs about split encoder support 2023-08-27 19:52:03 -07:00
Seth Milliken
c957348e61 fix(docs): detail overriding the led_strip chain-length property
Quite a few people have struggled with setting the correct
`chain-length` for their `led_strip`. For some, this is their first time
needing to change a pre-defined devicetree property, and so they aren't
familiar with the technique. I commonly see folks adding a duplicate of
the entire `*.overlay` file with only the `chain-length` value changed.
Having clear documentation for this specific application of the property
override technique could help forestall these problems, and give those
of us helping out in Discord something to easily reference.
2023-08-15 11:04:01 +03:00
Jorge Villalobos
d17c473d45
feat(docs): Improve parameterized macros docs 2023-08-02 09:57:00 -07:00
Maciej Konieczny aka narf
cec2061dad fix(docs): Fix typos in parameterized macros docs. 2023-07-19 15:42:35 -07:00
フィルターペーパー
bbb27ac027
feat(docs): Note that UF2 drive unmounts after flashing (#1859)
Add a note about the UF2 drive that automatically unmounts itself
to restart, which may surprise some new users.
2023-07-06 10:39:08 -07:00
Peter Johanson
805dd4a53b feat(behaviors): Support parameterized macros.
* Add two new compatibles for macros that
  take one or two parameters when bound in
  a keymap.
* Use `&macro_param_1to1`, `&macro_param_1to2`, `&macro_param_2to1`,
  and `&macro_param_2to2` control entries in the bindings for the macro
  to have the next binding entry have it's values substituted.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2023-06-20 11:19:28 -06:00
pixls
9d39a87f67
fix(docs): Change user-setup.md order to agree with order in setup script
Fixes #1281 

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2023-06-10 17:49:30 -07:00
Albert Y
a5c57fa224
feat(docs): Add an example for combining just modifiers (#1826)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2023-06-05 22:22:39 -07:00
Peter Johanson
19d883cdfe fix(bluetooth): Passkey pairing improvements.
* Capture the last 6 entered digits, and then require pressing
   Enter/Return to submit the entered digits. This matches the
   messaging shown on hosts regarding how to complete pairing.
* Fix the wording on the Kconfig menu item to accurately describe
  the feature.
2023-06-05 00:01:44 -06:00
Cem Aksoylar
ace11e327f fix(docs): Fix broken link in BT troubleshooting 2023-06-02 22:07:29 -06:00
Cem Aksoylar
0682bc3aa6 feat(docs): Note split connectivity improvement with TX power 2023-06-02 21:13:27 -06:00
Cem Aksoylar
a9ad11f91e refactor(docs): Move BT troubleshooting items to BT page 2023-06-02 21:13:27 -06:00
Cem Aksoylar
30ba4b08ae feat(docs): Add pointer to Bluetooth page in troubleshooting 2023-06-02 21:13:27 -06:00
Cem Aksoylar
4042aea66f feat(docs): Add troubleshooting for Windows issue 2023-06-02 21:13:27 -06:00
Cem Aksoylar
0508718d6c feat(docs): Add behavior types section for hold-tap 2023-06-02 21:11:33 -06:00
Cem Aksoylar
a2af74f5ab feat(docs): Add note on modifier functions to macros 2023-06-02 21:08:02 -06:00
Xudong Zheng
1adfcf92bf refactor(split): fix inconsistency in Kconfig names 2023-05-28 22:58:31 -06:00
Cem Aksoylar
864394b40a feat(display): Add setting to invert display colors
Add CONFIG_ZMK_DISPLAY_INVERT Kconfig to invert colors
(black-on-white to white-on-black) on monochrome screens.
Currently applies only if CONFIG_LV_USE_THEME_MONO is selected,
which is the default unless user overrides it.
2023-05-21 21:51:36 -06:00
Albert Y
48be2eedd0 fix(docs): Update QMK debounce references 2023-05-09 21:40:14 -07:00
Joel Spadin
7a352908ee docs: Add pre-commit documentation 2023-04-24 16:07:04 -07:00
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
Albert Y
9c4f1e02d1
fix(docs): Update references to QMK settings
* Remove TAPPING_FORCE_HOLD reference
* Remove IGNORE_MOD_TAP_INTERRUPT reference
2023-04-24 04:24:36 -04:00
Nick Coutsos
9d64c2a3a0 fix(docs): switch sensor rotate parameter order 2023-04-22 17:30:10 -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
sporkus
83a151890c
fix(docs): Correct example keymap filename 2023-04-16 13:28:08 -07:00
Josep Roca
71855af14f
fix(docs): ignore-modifiers clarification
* Clarify the potential need of adding the ignore-modifiers setting for new sticky key behaviors.
* Add ignore-modifiers setting to skq example
* Update docs/docs/behaviors/sticky-key.md

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2023-04-16 03:04:49 -04: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
Peter Johanson
09ed79a867 refactor: Move away from deprecated label usages.
* Move away from DT_LABEL.
* Move to DEVICE_DT_GET for non-behavior device access.
* Move various drivers to `gpio_spec_dt` and `DT` related macros.
* Remove mcp23017 while at it, since better upstream driver is
  available.
2023-04-05 22:55:38 -07:00
Peter Johanson
3a958c667f refactor: Move to zephyr/ include paths.
* Zephyr moved to properly namespaced headers, so major "rip
  the bandaid" commit to move us to those everywhere.
2023-04-05 22:55:38 -07:00
Peter Johanson
35a1c5a3d4 refactor(behaviors): Rename reset behavior.
* Upstream now has a node w/ label `reset` on many boards, so
  renaming our reset behavior node label to `sys_reset`.
2023-04-05 22:55:38 -07:00
Robert U
6cb42a8060
feat(behaviors): On-release option for positional-hold-taps 2023-03-12 12:24:00 -04:00
Albert Y
b7d5865e40 feat(docs): additional note on bug fixed in macOS v13.1 2023-02-02 21:23:48 -05:00
Joel Spadin
82ff6d8e85 docs: update dev env setup guide
Renamed the "Basic Setup" page to "Toolchain Setup" to make it clearer
that this is for setting up a development environment for local builds.

Linked to the relevant Zephyr setup documentation instead of duplicating
that information in our guide. This also switches Windows and macOS
setup to using the Zephyr SDK, which is much easier to install.

Updated the command for installing Zephyr's Python dependencies to be
OS specific, as Windows and macOS don't need the --user flag.

Updated the IDE integration page with instructions for determining the
compiler path that work with the latest version of the Zephyr SDK.
2023-01-19 22:25:10 -05:00
Peter Johanson
c23443a086 feat(docs): Generate new shield interconnect docs.
* Add to metadata schema for interconnects.
* New conventional location for pinout diagrams/pics.
* New component to generate the tabs for the new shield
  doc section on interconnects.
* Add XIAO and arduino uno pinout diagram.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-12-23 02:41:35 -06:00
Cem Aksoylar
d993b03433 feat(docs): Refer to troubleshooting in connecting split halves 2022-12-23 00:20:12 -06:00
Cem Aksoylar
080c47825f feat(docs): Add caution note about split peripheral sides to user setup 2022-12-23 00:20:12 -06:00
Cem Aksoylar
77d60182bf feat(docs): Recommend USB testing and warn about BT pairing in user setup 2022-12-23 00:20:12 -06:00
Joel Spadin
3eb06f137b feat: Add global macro timing configs
Added ZMK_MACRO_DEFAULT_WAIT_MS and ZMK_MACRO_DEFAULT_TAP_MS to set
global defaults for the wait-ms and tap-ms properties of macros.

Also reduced the default timings for macros, since it's been reported
many times that 100 ms is too slow.
2022-12-20 20:34:25 -06:00
as29
11ca0098a5
fix(docs): Disable encoders in dtsi (#1600) 2022-12-20 20:24:32 +00:00
Petrus Claviger
408b87ae7b
fix(docs): Grammatical fixes (#1587)
Co-authored-by: Dom H <dom@hxy.io>
2022-12-14 14:51:46 +00:00
Kyle McCreery
70aa4fa824
feat(boards): Add PillBug board, blackpill interconnect.
* Add blackbill interconnect metadata.
* Add config/overlay for upstream blackpill boards to work with ZMK.
* Add pillbug board.
* Updated new shield docs.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-12-10 22:01:37 -06:00
Cem Aksoylar
2a42fe658e feat(docs): Document battery widget percentage Kconfig 2022-12-10 17:08:37 -06:00
Joel Spadin
6ccb5280c9 fix(docs): Pin Zephyr docs links to a version
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2022-12-08 01:00:48 -06:00
Joel Spadin
593db85378 feat(boards): Add support for nRF5340 DK
Added overlays to support building for the nRF5340 development kit.

Also added some documentation on how to build and flash ZMK for dual-
chip Bluetooth configurations, with an example for the nRF5340.
2022-12-08 01:00:48 -06:00
Kurtis Lew
001105e318 fix(docs): Correct typo in hold-tap comparison balanced flavor 2022-12-01 20:11:31 +00:00