zmk-studio-api 0.3.0

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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

# zmk-studio-api

[![Version](https://img.shields.io/crates/v/zmk-studio-api.svg)](https://crates.io/crates/zmk-studio-api)
[![image](https://img.shields.io/pypi/v/zmk-studio-api.svg)](https://pypi.python.org/pypi/zmk-studio-api)
[![image](https://img.shields.io/pypi/l/zmk-studio-api.svg)](https://pypi.python.org/pypi/zmk-studio-api)

`zmk-studio-api` is a Rust client for the ZMK Studio RPC API on ZMK keyboards.
It can read device and keymap state, and apply keymap changes over serial or BLE.
Additionally, this library includes Python bindings for API access from Python applications and scripts.

## Usage

### Rust

Add dependency with Cargo:

```bash
cargo add zmk-studio-api [--features ble]
```

Usage example:

```rust
use zmk_studio_api::{Behavior, HidUsage, Keycode, StudioClient, transport::serial::SerialTransport};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let mut client = StudioClient::new(SerialTransport::open("COM3")?);
    let info = client.get_device_info()?;
    println!("Device: {}", info.name);
    println!("Lock: {:?}", client.get_lock_state()?);

    let before = client.get_key_at(0, 12)?;
    println!("Before: {before:?}");

    client.set_key_at(0, 12, Behavior::KeyPress(HidUsage::from_encoded(Keycode::A.to_hid_usage())))?;
    let after = client.get_key_at(0, 12)?;
    println!("After: {after:?}");

    if client.check_unsaved_changes()? {
        client.discard_changes()?;
    }
    Ok(())
}
```

For a complete runnable example, see [`examples/basic_example.rs`](examples/basic_example.rs).

### Python

Install from PyPI:

```bash
pip install zmk-studio-api
```

Usage example:

```python
import zmk_studio_api as zmk

client = zmk.StudioClient.open_serial("COM3")
print("Lock:", client.get_lock_state())

before = client.get_key_at(0, 12)
print("Before:", before)

client.set_key_at(0, 12, zmk.KeyPress(zmk.Keycode.A))
after = client.get_key_at(0, 12)
print("After:", after)
```

For a complete runnable example, see [`examples/basic_example.py`](examples/basic_example.py).

# License & Attribution

This project is licensed under the [Apache 2.0](LICENSE) license. Parts of this project are based on code from the [ZMK Studio](https://github.com/zmkfirmware/zmk-studio) (Apache 2.0) and its [TypeScript client](https://github.com/zmkfirmware/zmk-studio-ts-client) implementation (MIT).