b708d684a5
docs: Document the new predefined behaviors
...
Reorganising the pages of the docs can be done in a followup PR.
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2025-05-17 09:27:52 +00:00
879cff7595
docs: Document the default flavor of layer-tap ( #2937 )
2025-05-08 11:43:48 -07:00
f1b944b1ef
docs: Add secondary functions for the keypad number keys ( #2933 )
...
* docs: Add secondary functions for the keypad number keys
* docs: Change descriptions of secondary functions for the keypad number keys
The descriptions were updated to match those of the USB HID usage tables.
2025-04-30 17:32:22 +01:00
4235c8b491
chore: Add typescript support to eslint, fix errors ( #2923 )
2025-04-22 20:51:41 -07:00
c4ee8ab86b
refactor(combos): Reduce RAM usage, simplify config ( #2849 )
...
* Reference combos by index, not 32-bit pointers, and store bitfields
instead of arrays in several places, to bring down our flash/RAM usage.
* Use bit field to track candidate combos, to avoid needing an explicit
`ZMK_COMBO_MAX_COMBOS_PER_KEY` setting.
* Determine the max keys per combo automatically from the devicetree,
so we remove the ZMK_COMBO_MAX_KEYS_PER_COMBO Kconfig symbol.
2025-04-20 05:01:22 -04:00
d9576c5534
fix(docs): remove title as alt text ( #2922 )
2025-04-20 10:41:13 +02:00
84772ebf14
fix: changed shebang to make scripts more platform independent ( #2893 )
...
See for example this thread:
https://stackoverflow.com/questions/21612980/why-is-usr-bin-env-bash-superior-to-bin-bash
on why its better to use '#!/usr/bin/env bash' instead.
Without this change these scripts will not run on some
platforms. This is not a breaking change for the
platforms it already works on.
2025-04-20 04:23:31 -04:00
7823a43f62
docs: fix path typo in module-creation.md ( #2920 )
2025-04-16 09:53:56 -07:00
90bca78300
chore(deps): bump estree-util-value-to-estree in /docs ( #2914 )
2025-04-07 21:54:32 -07:00
a34839f001
chore(eslint): upgrade to eslint v9 and flat config ( #2909 )
2025-04-06 18:16:03 -07:00
9aadc3e5ab
chore(deps): bump image-size from 1.2.0 to 1.2.1 in /docs ( #2903 )
2025-04-03 22:54:30 -07:00
1c76bcb0a1
blog: Add meeting notes from February ( #2890 )
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2025-03-25 19:20:50 +01:00
d733fbafa5
docs: Document missing user-defined input processors ( #2895 )
2025-03-25 14:35:38 +01:00
49f86f7ed0
docs: Update hold-tap page ( #2888 )
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2025-03-23 18:12:50 -07:00
147c340c6e
Feature: Full-Duplex Wired Split ( #2766 )
...
refactor(split): Refactor split code for extension
Extract central/peripheral code to allow for plugging in alternate
transports, instead of tying all split logic to BT.
feat(split): Add full-duplex wired split support
* Depends on full-duplex hardware UART for communication.
* Supports all existing central commands/peripheral events, including
sensors/inputs from peripherals.
* Only one wired split peripheral supported (for now)
* Relies on chosen `zmk,split-uart` referencing the UART device.
docs: Add wired split config docs.
Migrate split to its own dedicated config file, and add details
on wired split config.
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
fix: Properly override stack size on RP2040
Move the system work queue stack size override on RP2040 ouf of
a `ZMK_BLE` conditional so it is properly applied generally for that
SoC.
---------
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
2025-03-18 02:48:32 -04:00
5ba7e260f4
docs: update name of XIAO boards ( #2869 )
2025-03-17 15:15:57 -07:00
bffbccc748
chore(deps): npm update on docs ( #2878 )
2025-03-16 20:47:42 -07:00
b366df8b17
docs: Fix powershell tab in user setup ( #2879 )
2025-03-16 20:14:48 -07:00
5d9920406c
Update container.mdx for clarity about ZMK repo folder location ( #2868 )
2025-03-10 21:52:30 -07:00
f5a838b4bd
docs: Fix wakeup-source property location for composite kscan ( #2861 )
2025-03-09 14:59:57 -07:00
21f54e7238
refactor(behaviors): Remove unneeded init funcs. ( #2843 )
...
Initialization functions are optional for Zephyr drivers, so remove
all our superfluous empty init functions.
2025-02-26 17:54:29 -05:00
2fe55c4c41
refactor(behaviors): Minor RAM usage tweaks ( #2839 )
...
Follow up cleanup of some config structs not marked as const.
2025-02-26 13:17:23 -05:00
d2eb6de7ad
docs: Add query strings to tabs ( #2840 )
2025-02-25 16:31:57 -08:00
209085da73
refactor(behaviors): Add max-held tap-dance config ( #2838 )
...
refactor(behaviors): Add max-held tap-dance config
Add new `CONFIG_ZMK_BEHAVIOR_TAP_DANCE_MAX_HELD` config for reducing RAM
usage on more constrained devices.
refactor(behaviors): Move defaults to Kconfig.defaults
2025-02-25 14:12:27 -05:00
8575fc8a9d
docs: Inline simple physical layout info in new shield guide ( #2827 )
...
docs: Inline simple physical layouts in new shield guide
docs: Fix broken anchor in module creation
docs: Make physical layout transform label consistent and comment
2025-02-17 15:59:54 -08:00
9d234cbb10
docs: Make default keymap in new shield guide complete ( #2825 )
...
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
2025-02-17 11:55:42 -08:00
e8ec9b65f8
docs: Add "planned: import/export keymap" to the studio features page ( #2821 )
2025-02-17 11:44:42 -08:00
d0d313409b
docs: Improved some links to modules ( #2822 )
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2025-02-17 10:16:36 +01:00
5926269ea5
docs: Add KiCAD note and titles to physical layouts page ( #2823 )
...
docs: Note that Nick Coutsos' tool can import from KiCAD
docs: Add titles to some code blocks in physical layouts
2025-02-16 20:12:31 -08:00
eeb8a00778
docs: Add a page on module creation ( #2456 )
...
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2025-02-14 16:32:18 -08:00
aa3e5dd70f
feat(display): Add config for display update period ( #2819 )
...
Add `CONFIG_ZMK_DISPLAY_TICK_PERIOD_MS` Kconfig to allow tweaking
the period between display updates.
2025-02-10 13:32:16 -05:00
627e6dbec9
feat(display): Add ability to set display on/off pin. ( #2814 )
...
Zephyr is still working on the plan upstream for generically controlling
display "backlight" pins with GPIO/PWM, so in the meantime, add our
own chosen property `zmk,display-led` that is set to an LED device child
to allow blanking/unblanking of devices that use a dedicated backlight
control pin.
2025-02-07 17:49:30 -07:00
0f7c11248a
feat(pointing): Add pre-defined scroll scaler and mouse scroll tests ( #2759 )
...
feat(pointing): Add pre-defined scroll scaler
tests(pointing): Add mouse scroll tests
2025-02-04 10:27:14 -07:00
72b00b3f58
docs: Add pointers to final Kconfig/devicetree files ( #2796 )
...
docs: Add diagnosis pointers for Kconfig/devicetree outputs
docs: Add tip boxes for diagnosing config/devicetree changes
2025-01-25 13:04:50 -08:00
e4885d5d4c
docs: Update keymaps index intro ( #2790 )
...
Co-authored-by: Nicolas Munnich <98408764+Nick-Munnich@users.noreply.github.com>
2025-01-25 12:30:50 -08:00
4f72e7cb25
docs: Update intro page ( #2767 )
2025-01-22 16:58:15 -08:00
4882a62c40
docs: Update dongle FAQ entry ( #2788 )
2025-01-22 10:09:03 +01:00
40ea92d201
docs: Link to ZMK Studio download page ( #2783 )
2025-01-20 21:30:55 -08:00
db2fc2bffd
chore(deps): bump katex from 0.16.11 to 0.16.21 in /docs ( #2774 )
...
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2025-01-17 15:15:54 -08:00
c367d8f636
feat(core): Make physical layout key rotation optional ( #2770 )
...
To be able to save on flash space, for layouts on space constrained
devices that don't require rotation, make key rotation props
optional behind a new Kconfig flag.
2025-01-15 16:48:18 -05:00
700e9b264f
docs: Move more sections under hardware integration ( #2704 )
...
docs: Move battery sensing hardware integration to new page
docs: Refactor lighting hardware integrations to new category
docs: Link to pin control page from lighting pages
docs: Consolidate lighting feature pages
docs: Remove incorrect redirect
docs: Consolidate lighting config pages
2025-01-13 21:14:25 -08:00
022603ec16
docs: Fix broken anchors in dongle page ( #2764 )
2025-01-13 09:21:55 +01:00
b93bf6d3fd
docs: Fix incorrect `kscan` value ( #2763 )
2025-01-12 15:51:30 +01:00
3377ed02a8
docs: Improve pointing docs ( #2703 )
...
docs: Add missing code fence languages in pointing
docs: Fix default msc exponent in example
docs: Make pointing hardware integration follow semantic structure
2025-01-04 11:15:32 -08:00
bc6bb90414
docs: added a page on dongles.
...
Co-authored-by: rasmuskoit <rasmuskoit@gmail.com>
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2025-01-02 10:44:50 -08:00
cb867f92db
Feature: input processor behavior invocation ( #2714 )
...
refactor(pointing): Allow stopping event propagation
Allow input processors to return a special value if a given input event
should not be further processed/propagated.
feat(pointing): Add behavior input processor
Add the ability to intercept certain input events and trigger behaviors
when they occur.
Co-authored-by: Jorge Villalobos <minusfive@users.noreply.github.com>
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
2024-12-17 20:50:06 -05:00
d0016b34f8
chore(deps-dev): bump the development group across 1 directory with 7 updates ( #2698 )
...
Bumps the development group with 7 updates in the /docs directory:
| Package | From | To |
| --- | --- | --- |
| [@docusaurus/module-type-aliases](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-module-type-aliases ) | `3.6.1` | `3.6.3` |
| [@docusaurus/tsconfig](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-tsconfig ) | `3.5.2` | `3.6.3` |
| [@docusaurus/types](https://github.com/facebook/docusaurus/tree/HEAD/packages/docusaurus-types ) | `3.6.1` | `3.6.3` |
| [json-schema-to-typescript](https://github.com/bcherny/json-schema-to-typescript ) | `15.0.2` | `15.0.3` |
| [prettier](https://github.com/prettier/prettier ) | `3.3.3` | `3.4.2` |
| [typescript](https://github.com/microsoft/TypeScript ) | `5.6.3` | `5.7.2` |
| [webpack](https://github.com/webpack/webpack ) | `5.96.1` | `5.97.1` |
Updates `@docusaurus/module-type-aliases` from 3.6.1 to 3.6.3
- [Release notes](https://github.com/facebook/docusaurus/releases )
- [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md )
- [Commits](https://github.com/facebook/docusaurus/commits/v3.6.3/packages/docusaurus-module-type-aliases )
Updates `@docusaurus/tsconfig` from 3.5.2 to 3.6.3
- [Release notes](https://github.com/facebook/docusaurus/releases )
- [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md )
- [Commits](https://github.com/facebook/docusaurus/commits/v3.6.3/packages/docusaurus-tsconfig )
Updates `@docusaurus/types` from 3.6.1 to 3.6.3
- [Release notes](https://github.com/facebook/docusaurus/releases )
- [Changelog](https://github.com/facebook/docusaurus/blob/main/CHANGELOG.md )
- [Commits](https://github.com/facebook/docusaurus/commits/v3.6.3/packages/docusaurus-types )
Updates `json-schema-to-typescript` from 15.0.2 to 15.0.3
- [Changelog](https://github.com/bcherny/json-schema-to-typescript/blob/master/CHANGELOG.md )
- [Commits](https://github.com/bcherny/json-schema-to-typescript/commits )
Updates `prettier` from 3.3.3 to 3.4.2
- [Release notes](https://github.com/prettier/prettier/releases )
- [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md )
- [Commits](https://github.com/prettier/prettier/compare/3.3.3...3.4.2 )
Updates `typescript` from 5.6.3 to 5.7.2
- [Release notes](https://github.com/microsoft/TypeScript/releases )
- [Changelog](https://github.com/microsoft/TypeScript/blob/main/azure-pipelines.release.yml )
- [Commits](https://github.com/microsoft/TypeScript/compare/v5.6.3...v5.7.2 )
Updates `webpack` from 5.96.1 to 5.97.1
- [Release notes](https://github.com/webpack/webpack/releases )
- [Commits](https://github.com/webpack/webpack/compare/v5.96.1...v5.97.1 )
---
updated-dependencies:
- dependency-name: "@docusaurus/module-type-aliases"
dependency-type: direct:development
update-type: version-update:semver-patch
dependency-group: development
- dependency-name: "@docusaurus/tsconfig"
dependency-type: direct:development
update-type: version-update:semver-minor
dependency-group: development
- dependency-name: "@docusaurus/types"
dependency-type: direct:development
update-type: version-update:semver-patch
dependency-group: development
- dependency-name: json-schema-to-typescript
dependency-type: direct:development
update-type: version-update:semver-patch
dependency-group: development
- dependency-name: prettier
dependency-type: direct:development
update-type: version-update:semver-minor
dependency-group: development
- dependency-name: typescript
dependency-type: direct:development
update-type: version-update:semver-minor
dependency-group: development
- dependency-name: webpack
dependency-type: direct:development
update-type: version-update:semver-minor
dependency-group: development
...
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-12-13 10:07:46 +01:00
ec6b770947
docs: Minor touchups to studio related bits ( #2707 )
2024-12-13 10:03:08 +01:00
4ef231f4bb
feat: Added `toggle-mode`, allowing toggle-on and toggle-off ( #2555 )
...
feat: added toggle mode to key and layer toggles
docs: documented toggle mode changes
2024-12-12 19:13:56 -05:00
a8f5ab67b5
fix: allow kscan-composite to wake up device. ( #2682 )
...
* include kscan.yaml so we can set kscan-composite as a wakeup source
* modify enable and disable callback to check for wakeup capabilities of
composite and children
* disable children wakeup source
The disable function is only called
when the composite is not an enabled wakeup source.
In that case the children should also not be an enabled
wakeup source, so they can get suspended
2024-12-11 14:46:22 -05:00
Nicolas Munnich
Steven Sheldon
Omar L.
Aasim-A
Pete Johanson
romil-soni
Tygo van den Hurk
Genteure
dependabot[bot]
Will Hack
Nicolas Munnich
Cem Aksoylar
idesignstuff
Nicolas Munnich
Nick Winans
Nicolas Munnich
svek1