https://github.com/ohare93/zsa-keymapp-python

Control your ZSA keyboard using the Keymapp API in Python.
https://github.com/ohare93/zsa-keymapp-python

ergodox keymapp moonlander poetry protobuf python voyager zsa

Last synced: about 10 hours ago
JSON representation

Control your ZSA keyboard using the Keymapp API in Python.

• Host: GitHub
• URL: https://github.com/ohare93/zsa-keymapp-python
• Owner: ohare93
• Created: 2025-01-16T14:23:36.000Z (2 days ago)
• Default Branch: main
• Last Pushed: 2025-01-17T10:24:46.000Z (1 day ago)
• Last Synced: 2025-01-17T11:25:40.865Z (1 day ago)
• Topics: ergodox, keymapp, moonlander, poetry, protobuf, python, voyager, zsa
• Language: Python
• Homepage:
• Size: 26.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# zsa-keymapp-python

Control your ZSA keyboard (Moonlander / Voyager / Ergodox) using the [Keymapp](https://blog.zsa.io/keymapp/) API (Protobuf) in Python.

## Installation

This repo uses poetry as a package manager and Python 3.12 (though older versions may work fine).

1. Install the dependencies in the pyproject.toml

```sh

poetry install

```

2. Generate the Protobuf API code from the keymapp.proto file

```sh

poetry run python -m grpc.tools.protoc -I. --proto_path . --python_out . --mypy_out . --grpc_python_out . ./protos/*.proto

```

Any .proto files in the protos/ folder will be used for generation.

## Usage

Ensure your Keymapp API is enabled in the application,

![](./assets/keymapp-settings.png)

Run it:

```sh

poetry run python keymapp.py

```

This will change the keyboard layer to the 2nd layer (layer 1!). Change the code in keymapp.py to do whatever you like 🎉 Set the layer, increase the brightness, change led colours in your keyboard. See protos/keymapp.proto for the valid endpoints. 

See also:

- [Kontroll](https://github.com/zsa/kontroll) a command-line tool written in Rust to interact with the Keymapp API. (Where the keymapp.proto file was taken from)