kofal.net/zmk
1
0
Fork 1
mirror of https://github.com/zmkfirmware/zmk.git synced 2026-03-31 02:15:25 -05:00
Code Issues Packages Projects Releases Wiki Activity

feat: Add studio related documentation.

Browse Source 
* 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 <caksoylar@users.noreply.github.com>
This commit is contained in:
Peter Johanson
2024-08-14 11:45:11 -06:00
committed by Pete Johanson
parent 5176fbea6a
commit 3975d2fdaf
7 changed files with 332 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/docs/keymaps/behaviors/index.mdx
View File

@@ -72,6 +72,12 @@ Below is a summary of pre-defined behavior bindings and user-definable behaviors
| `&ext_power` | [Power management](power.md#behavior-binding) | Allows enabling or disabling the VCC power output to save power |
| `&soft_off` | [Soft off](soft-off.md#behavior-binding) | Turns the keyboard off. |
## ZMK Studio Behaviors
| Binding | Behavior | Description |
| ---------------- | ------------------------------------------------------ | --------------------------------------------------------- |
| `&studio_unlock` | [ZMK Studio Unlock](studio-unlock.md#behavior-binding) | Unlocks the device so that ZMK Studio UI can make changes |
## User-Defined Behaviors
| Behavior | Description |

25
docs/docs/keymaps/behaviors/studio-unlock.md Normal file
View File

@@ -0,0 +1,25 @@
---
title: ZMK Studio Unlock Behavior
sidebar_label: ZMK Studio Unlock
---
:::warning
ZMK Studio is still in active development. This behavior is documented in preparation for its general availability.
:::
## Summary
## ZMK Studio Unlock
The ZMK Studio unlock behavior is used to grant [ZMK Studio](../../features/studio.md) access to make changes to your ZMK device. The device will remain unlocked until a certain amount of time of inactivity in ZMK Studio, or on disconnect. Those trigger events for relocking can be configured with [studio configuration](../../config/studio.md).
### Behavior Binding
- Reference: `&studio_unlock`
- Parameters: None
Example:
```dts
&studio_unlock
```