zmk-studio-api 0.3.1

Rust + Python client for the ZMK Studio RPC API (Serial + BLE)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

//! 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.

mod binding;
mod client;
mod framing;
mod hid_usage;
mod keycode;
/// Raw generated protobuf types used by the RPC protocol.
pub mod proto;
mod protocol;
#[cfg(feature = "python")]
mod python;
/// Transport adapters for connecting to a ZMK Studio-capable device.
pub mod transport;

/// Typed key binding value used by [`StudioClient::get_key_at`] and [`StudioClient::set_key_at`].
pub use binding::Behavior;
/// Errors returned by high-level client operations.
pub use client::{ClientError, StudioClient};
/// Decoded ZMK HID usage values used in typed behavior APIs.
pub use hid_usage::{
    HID_USAGE_KEYBOARD, HidUsage, MOD_LALT, MOD_LCTL, MOD_LGUI, MOD_LSFT, MOD_RALT, MOD_RCTL,
    MOD_RGUI, MOD_RSFT,
};
/// ZMK keycode enum used in typed behavior APIs.
pub use keycode::Keycode;