Skip to main content

ZMK Studio Configuration

Alpha Feature

ZMK Studio is still in active development and the below information is for development purposes only. For up to date information, join the ZMK Discord server and discuss in #studio-development.

The following settings affect the ZMK Studio portions of ZMK. See the ZMK Studio feature for more information on enabling and building with ZMK Studio enabled.

See Configuration Overview for instructions on how to change these settings.

Kconfig

Definition file: zmk/app/src/studio/Kconfig

Keymaps

ConfigTypeDescriptionDefault
CONFIG_ZMK_KEYMAP_LAYER_NAME_MAX_LENintMax allowable keymap layer display name20

Locking

ConfigTypeDescriptionDefault
CONFIG_ZMK_STUDIO_LOCKINGboolEnable/disable locking for ZMK Studioy
CONFIG_ZMK_STUDIO_LOCK_IDLE_TIMEOUT_SECintSeconds of inactivity in ZMK Studio before automatically locking500
CONFIG_ZMK_STUDIO_LOCK_ON_DISCONNECTboolWhether to automatically lock again whenever ZMK Studio disconnects from the devicey

Transport/Protocol Details

ConfigTypeDescriptionDefault
CONFIG_ZMK_STUDIO_TRANSPORT_BLE_PREF_LATENCYintLower latency to request while ZMK Studio is active to improve responsiveness10
CONFIG_ZMK_STUDIO_RPC_THREAD_STACK_SIZEintStack size for the dedicated RPC thread1800
CONFIG_ZMK_STUDIO_RPC_RX_BUF_SIZEintNumber of bytes available for buffering incoming messages30
CONFIG_ZMK_STUDIO_RPC_TX_BUF_SIZEintNumber of bytes available for buffering outgoing messages64