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
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

#!/usr/bin/env python3
from __future__ import annotations

import argparse
import zmk_studio_api as zmk


def run(client: zmk.StudioClient) -> None:
    print("Lock state:", client.get_lock_state())
    behavior_ids = client.list_all_behaviors()
    print("Behavior count:", len(behavior_ids))

    if behavior_ids:
        details = client.get_behavior_details_bytes(behavior_ids[0])
        print("First behavior details bytes:", len(details))

    keymap_bytes = client.get_keymap_bytes()
    print("Keymap bytes:", len(keymap_bytes))

    layouts_bytes = client.get_physical_layouts_bytes()
    print("Physical layouts bytes:", len(layouts_bytes))

    # Demonstrate typed behavior get/set at (layer 0, position 0).
    before = client.get_key_at(0, 0)
    print("Before:", before)

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

    # Avoid persisting the example mutation.
    if client.check_unsaved_changes():
        client.discard_changes()
        print("Discarded changes")


def main() -> int:
    parser = argparse.ArgumentParser(description="Basic zmk_studio_api example")
    sub = parser.add_subparsers(dest="transport", required=True)

    serial = sub.add_parser("serial", help="Connect over serial")
    serial.add_argument("port", help="Serial port path (for example COM3)")

    ble = sub.add_parser("ble", help="Connect over BLE")

    args = parser.parse_args()

    if args.transport == "serial":
        client = zmk.StudioClient.open_serial(args.port)
    else:
        devices = zmk.StudioClient.list_ble_devices()
        if not devices:
            raise SystemExit("No Bluetooth keyboards found. Pair/connect your keyboard first.")

        device_id, local_name = devices[0]
        print("Using BLE device:", local_name or device_id)
        client = zmk.StudioClient.open_ble(device_id)

    run(client)
    return 0


if __name__ == "__main__":
    raise SystemExit(main())