Skip to content

Commit

Permalink
docs: Studio setup to include &studio_unlock
Browse files Browse the repository at this point in the history
* Add a section about adding `&studio_unlock` to the stock keymap.

Co-authored-by: Cem Aksoylar <[email protected]>
  • Loading branch information
petejohanson and caksoylar committed Oct 3, 2024
1 parent 29b39f2 commit d50e929
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/docs/development/hardware-integration/studio-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ This guide will walk you through enabling ZMK Studio support for a keyboard.

The main additional pieces needed for ZMK Studio support involve additional metadata needed in order
to properly to display the physical layouts available for the particular keyboard.
In addition to the layout metadata, the default keymap should be updated to include a binding for the
[Studio Unlock](../../keymaps/behaviors/studio-unlock.md) behavior.

# Physical Layout Positions

Expand Down Expand Up @@ -138,3 +140,8 @@ Here is a fixed up Corne mapping:
```

Notice how the outer column positions in the 6-column layout are mapped to positions 36, 37, etc. in the 5-column layout. The 5-column layout only uses key positions up to 35, so those bindings in the outer columns will get migrated into the "extra space" that is ignored by the smaller layout, preserved to get mapped back in place when the user switches back.

# Studio Unlock Keymap Update

The stock keymap should be updated to include a way to unlock the device for studio updates, by adding a [`&studio_unlock`](../../keymaps/behaviors/studio-unlock.md) binding to the
keymap in some unused location.
4 changes: 4 additions & 0 deletions docs/docs/features/studio.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ ZMK Studio support is in alpha. Although best efforts are being made, keeping co

ZMK Studio provides runtime update functionality to ZMK powered devices, allowing users to change their keymap layers without flashing new firmware to their keyboards. Studio is still under active development, and is not yet ready for casual end user use.

## Keymap Changes

To unlock your keyboard to allow ZMK Studio to make changes, you'll need to add a [`&studio_unlock`](../keymaps/behaviors/studio-unlock.md) binding to the keymap.

## Building

Building for ZMK Studio involves two main additional items.
Expand Down

0 comments on commit d50e929

Please sign in to comment.