Studio: keymap subsystem #2268
Merged
Studio: keymap subsystem #2268
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
petejohanson
added
enhancement
petejohanson
force-pushed
the
studio/keymap-subsystem
branch
6 times, most recently
from
ba1f1d1
to
66157f1
Compare
petejohanson
force-pushed
the
studio/keymap-subsystem
branch
3 times, most recently
from
7656aa8
to
f8be471
Compare
petejohanson
force-pushed
the
studio/keymap-subsystem
branch
8 times, most recently
from
fb81427
to
7585225
Compare
petejohanson
force-pushed
the
studio/keymap-subsystem
branch
8 times, most recently
from
19fe149
to
7b149df
Compare
petejohanson
force-pushed
the
studio/keymap-subsystem
branch
2 times, most recently
from
cd4643b
to
c648db4
Compare
caksoylar
reviewed
Aug 29, 2024
petejohanson
force-pushed
the
studio/keymap-subsystem
branch
6 times, most recently
from
14a7781
to
5f84d95
Compare
joelspadin
reviewed
Sep 2, 2024
docs/docs/features/studio.md
Outdated
|
|
||
| ### Omit Specific Behaviors | ||
|
|
||
| You can omit a specific behaviors by defining a variable like `ZMK_BEHAVIORS_OMIT_FOO` at the top of your keymap: |
There was a problem hiding this comment.
"variable like ZMK_BEHAVIORS_OMIT_FOO" isn't super clear. Continuing the discussion above, we should have some description of how to map a behavior to a symbol to use in place of FOO.
Also, I think it is important (possibly even big warning box important) to note that these defines need to come before including behaviors.dtsi.
There was a problem hiding this comment.
I added a note to this, and there is a note about the order needed here, but I can make it even more obvious if folks thinks this needs it.
petejohanson
force-pushed
the
studio/keymap-subsystem
branch
2 times, most recently
from
88dc737
to
8f8b6e4
Compare
caksoylar
reviewed
Sep 2, 2024
joelspadin
reviewed
Sep 3, 2024
petejohanson
force-pushed
the
studio/keymap-subsystem
branch
6 times, most recently
from
09f1e4c
to
746e981
Compare
* Add keymap API for getting/setting a bindings in keymap layers. * Add layer move support via intemediary ordering array. * Add settings storage for keymap changes.
* New shield to easily test studio using the `native_posix_64` board.
* Use defines to keep either all behaviors with omits, or selective behaviors with explicit kept behavior, before including `behavior.dtsi` in keymaps. * Default ZMK_BEHAVIORS_KEEP_ALL when building with the studio RPC endpoint snippet.
* Make it easier to test native builds of our shields by adding `posix_pro_micro` and `posix_seeed_xiao` so you can build posix target of, e.g. `corne_left` for testing ZMK Studio.
* Add Corne and Ferris shared layouts, and update the respective shields to use them. * Add a sample Hummingbird physical layout for testing posix xiao. * Add Sofle physical layout as an additional reference.
* Document setting up studio for a new keyboard definition. * Document how to enable ZMK Studio for a build, adding reserved layers, and controlling which behaviors are built into a studio firmware. * Document `&studio_unlock` behavior. * Document studio configuration options. Co-authored-by: Cem Aksoylar <[email protected]>
petejohanson
force-pushed
the
studio/keymap-subsystem
branch
from
746e981
to
a18e562
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is layered on top of #2254 showing how this will be evolving for the keymap subsystem.
Core features:
Adds a new keymap subsystem that:
Leaving this as a draft PR for now pending review of #2231 and #2254