Commit graph

928 commits

Author SHA1 Message Date
Nicolas Munnich
ac29b51c84 improvements and image 2024-09-02 12:43:05 +02:00
Nicolas Munnich
816cbfed77
Apply suggestions from code review
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-09-02 11:47:27 +02:00
Nicolas Munnich
6d9d1b2757 Added a page on shift registers 2024-09-02 10:22:23 +02:00
Nicolas Munnich
4daa82ace9 Apply suggestions from code review
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-09-02 10:22:23 +02:00
Nicolas Munnich
df8feb8494 Moved logging, deleted hardware-int index 2024-08-31 07:37:53 +02:00
Nicolas Munnich
e12d4f7137 Removed popup, added warnings instead 2024-08-30 20:28:27 +02:00
Nicolas Munnich
5426abe64b Added popup 2024-08-30 19:46:32 +02:00
Nicolas Munnich
f28c82ac91 fixed all the links 2024-08-30 16:50:23 +02:00
Nicolas Munnich
9519d0cece Refactoring of the development section 2024-08-30 14:14:00 +02:00
Nicolas Munnich
f01cbc993e Added making modules page 2024-08-24 09:45:17 +02:00
Nicolas Munnich
8e15b5fa96 Added advanced guides page 2024-08-24 09:37:33 +02:00
Nicolas Munnich
5f056f7199
refactor(docs): Convert the keymaps section into a base folder (#2430)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-08-21 10:39:18 -07:00
Nicolas Munnich
503f6c8e58
feat(docs): Add and modify docs to point users to the experimental zmk-cli (#2431)
Co-authored-by: Joel Spadin <joelspadin@gmail.com>
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-08-21 10:36:23 -07:00
Peter Johanson
b735a051ce fix(docs): Admonition formatting fix. 2024-08-15 12:51:38 -06:00
Peter Johanson
feda96eb40 feat(studio): Initial RPC infrastructure and subsystems.
* UART and BLE/GATT transports for a protobuf encoded RPC
  request/response protocol.
* Custom framing protocol is used to frame a give message.
* Requests/responses are divided into major "subsystems" which
  handle requests and create response messages.
* Notification support, including mapping local events to RPC
  notifications by a given subsystem.
* Meta responses for "no response" and "unlock needed".
* Initial basic lock state support in a new core section, and allow specifying
  if a given RPC callback requires unlocked state or not.
* Add behavior subsystem with full metadata support and examples of
  using callback to serialize a repeated field without extra stack space needed.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-08-15 11:45:18 -06:00
Cem Aksoylar
ea64fcaf71 fix(docs): Note direct pin use in matrix transform 2024-08-15 10:38:10 -07:00
dependabot[bot]
6fe13c9565
chore(deps-dev): bump eslint-plugin-mdx from 2.3.3 to 3.1.5 in /docs (#2128)
Bumps [eslint-plugin-mdx](https://github.com/mdx-js/eslint-mdx) from 2.3.3 to 3.1.5.
- [Release notes](https://github.com/mdx-js/eslint-mdx/releases)
- [Changelog](https://github.com/mdx-js/eslint-mdx/blob/master/CHANGELOG.md)
- [Commits](https://github.com/mdx-js/eslint-mdx/compare/eslint-plugin-mdx@2.3.3...eslint-plugin-mdx@3.1.5)

---
updated-dependencies:
- dependency-name: eslint-plugin-mdx
  dependency-type: direct:development
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-08-15 16:15:39 +02:00
dependabot[bot]
08988ec7da
chore(deps): bump braces from 3.0.2 to 3.0.3 in /docs (#2337)
Bumps [braces](https://github.com/micromatch/braces) from 3.0.2 to 3.0.3.
- [Changelog](https://github.com/micromatch/braces/blob/master/CHANGELOG.md)
- [Commits](https://github.com/micromatch/braces/compare/3.0.2...3.0.3)

---
updated-dependencies:
- dependency-name: braces
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-08-15 16:14:45 +02:00
Cem Aksoylar
96cd3a1ce2 refactor(docs): Remove unnecessary jsx includes 2024-08-13 23:03:15 -07:00
Cem Aksoylar
4faeb365b1 feat(docs): Add keyboard vs consumer variants note 2024-08-13 23:03:15 -07:00
Cem Aksoylar
ba0dee088f feat(docs): Add section on nesting mod-morphs
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
2024-08-13 14:56:07 -07:00
Cem Aksoylar
0d15ae84f4 fix(docs): Fix mod-morph terms from keycodes to bindings 2024-08-13 14:56:07 -07:00
Cem Aksoylar
8b909acdcf refactor(docs): Add subheaders for devicetree error types 2024-08-13 11:11:27 -07:00
Cem Aksoylar
3de8a56fcb feat(docs): Add a note on column numbers for DTS errors 2024-08-13 11:11:27 -07:00
Cem Aksoylar
00e4818094 fix(docs): Fix broken anchor in reset behaviors 2024-08-13 10:51:40 -07:00
Nicolas Munnich
049c070b3a
feat(docs): Minor improvements to the docs (#2411) 2024-08-13 10:47:45 -07:00
Pete Johanson
6d50ba5553 chore: Docs review tweaks.
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-08-12 16:57:54 -07:00
Peter Johanson
3fec690def feat: Add config settings for sticky keys/hold-tap
* Add new Kconfig symbols to config max held sticky-keys/hold-taps
  and for max captured events during hold-tap resolution.
2024-08-12 16:57:54 -07:00
Cem Aksoylar
2eff266f5b feat(docs): Add battery life remark for split keyboards 2024-08-07 23:57:58 -07:00
Cem Aksoylar
2a0708d1fc feat(docs): Add locality warning for nested behaviors 2024-08-07 23:57:58 -07:00
Cem Aksoylar
2501f1f548 feat(docs): Add references to new split keyboards page 2024-08-07 23:57:58 -07:00
Cem Aksoylar
d75e388593 feat(docs): Add split keyboards feature page
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
2024-08-07 23:57:58 -07:00
Cem Aksoylar
47a6715aa6 fix(docs): Fix toggle layer docs 2024-08-02 11:17:10 -07:00
Cem Aksoylar
b9a025c76e
fix(docs): Document number of peripherals Kconfig (#2389)
Fixes #2373
2024-08-02 18:57:15 +02:00
Cem Aksoylar
b080befebb fix(docs): Fix link for matrix transform 2024-08-02 09:55:20 -07:00
Nicolas Munnich
9e7fcde868
feat(docs): Improve the layers-related documentation (#2390)
Fixes #1284
2024-07-31 20:53:36 -07:00
Nicolas Munnich
f92dce43e9
feat(docs): Add modules feature page (#2380)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-07-25 12:08:08 -07:00
Nicolas Munnich
fd152baff0
feat(docs): Add troubleshooting notes on experimental bluetooth options (#2387)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-07-25 12:00:22 -07:00
Cem Aksoylar
7bd74a6b0f fix(docs): Add required display-name in physical layout examples 2024-07-14 16:59:15 -07:00
Peter Johanson
b4f9081b09 docs: Updated new shield documentation for physical layouts.
* Document how to define one or more physical layouts and assign
  the chosen one.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-07-03 16:52:05 -06:00
Peter Johanson
0438cb0ee5 feat(kscan): More complete PM support to drivers.
* Update our GPIO kscan drivers to more completely support PM device,
  by doing proper hardare init/deinit in the PM action hook.
2024-07-03 16:52:05 -06:00
Timoyoungster
29599e8b0a docs: hopefully more clear description of the new setting 2024-06-24 14:26:14 -06:00
Timoyoungster
10d03ca46c fix: adding option to separate implicit mod release from key release
This adds a new config value `ZMK_HID_SEPARATE_MOD_RELEASE_REPORT`
where, if enabled, the report for a key release is sent separately to
the accompanying modifier release signals, which are then sent in a
second report.

This fixes an issue where certain applications are unable to work with
implicitly modified keys (e.g. colon) due to them registering the
modifier release prior to the actual key release.

Have tested this on my personal keyboard and `wev` now shows the signals
in the correct order.

=> **Previously:** ```LSHIFT (pressed) -> colon (pressed) -> LSHIFT
(released) -> **semi**colon (released)```

=> **Now:** ```LSHIFT (pressed) -> colon (pressed) -> colon (released)
-> LSHIFT (released)```

(This time without accidental files)
2024-06-24 14:26:14 -06:00
honorless
4dce096161 docs: improve settings_reset link 2024-06-24 13:18:56 -07:00
Peter Johanson
a080b5287f refactor: Remove static CDC ACM logging nodes.
* To avoid spurious CDC ACM instances when usint CDC ACM for something
  other than logging, move to the approach used by Zephyr of using a
  snippet to redirect console output to a CDC ACM node added by the
  snippet. Remove all the existing static CDC ACM nodes.
* Add new `zmk-usb-logging` snippet that mirrors the upstream
  `cdc-acm-logging` snippet, but still does our extra USB logging
  configuration.
* Updated logging docs accordingly.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-06-20 12:06:13 -06:00
Cem Aksoylar
7c09eb217e refactor(docs): Document and enforce header casing conventions 2024-06-17 11:46:32 -07:00
Cem Aksoylar
e56db304ea refactor(docs): Split up troubleshooting page into a section 2024-06-17 11:46:32 -07:00
Nicolas Munnich
308d6bce6e
feat(docs): Improve the toolchain setup page (#2272)
Split the toolchain setup into separate docker and native pages
and improve instructions to better refer to Zephyr docs in certain steps.
Also refactor to improve consistency and add virtualenv instructions.

---------

Co-authored-by: KemoNine <mcrosson@kemonine.info>
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-06-01 21:51:08 -07:00
Nicolas Munnich
2d96f469c8
fix(docs): Removing to-to typos (#2310) 2024-05-25 22:16:33 -07:00
Horu
7d1f84e3eb
chore: fix typos in various places 2024-05-13 16:47:33 -04:00