Crate zmk_studio_api 

High-level Rust client for the ZMK Studio RPC protocol.

The recommended API surface is:

• StudioClient for RPC operations
• Behavior for typed key bindings
• HidUsage and Keycode for ZMK key values
• transport for BLE/serial I/O adapters

proto exposes raw generated protobuf types for advanced use cases.

Modules

proto

Raw generated protobuf types used by the RPC protocol.

transport

Transport adapters for connecting to a ZMK Studio-capable device.

Structs

HidUsage

Decoded ZMK HID usage values used in typed behavior APIs. Lossless decoded ZMK HID usage value (base usage + modifiers).

StudioClient

Errors returned by high-level client operations. High-level synchronous ZMK Studio RPC client.

Enums

Behavior

Typed key binding value used by StudioClient::get_key_at and StudioClient::set_key_at. Lossless typed behavior value for a single key binding.

ClientError

Errors returned by high-level client operations. High-level error type returned by StudioClient operations.

Keycode

ZMK keycode enum used in typed behavior APIs. ZMK keycode value

Constants

HID_USAGE_KEYBOARD

Decoded ZMK HID usage values used in typed behavior APIs.

MOD_LALT

Decoded ZMK HID usage values used in typed behavior APIs.

MOD_LCTL

Decoded ZMK HID usage values used in typed behavior APIs.

MOD_LGUI

Decoded ZMK HID usage values used in typed behavior APIs.

MOD_LSFT

Decoded ZMK HID usage values used in typed behavior APIs.

MOD_RALT

Decoded ZMK HID usage values used in typed behavior APIs.

MOD_RCTL

Decoded ZMK HID usage values used in typed behavior APIs.

MOD_RGUI

Decoded ZMK HID usage values used in typed behavior APIs.

MOD_RSFT

Decoded ZMK HID usage values used in typed behavior APIs.