1 unstable release
0.0.1 | Apr 2, 2024 |
---|
#4 in #qmk
115 downloads per month
44KB
1K
SLoC
[!WARNING]
qmk-via-api
is currently in very early development and mostly untested. Use at your own risk!
qmk-via-api
qmk-via-api
provides an implementation of the VIA API for QMK (Quantum Mechanical Keyboard) firmware-based keyboards. It allows developers to interact with QMK keyboards programmatically, enabling tasks such as configuring keymaps, macros, lighting effects and more.
Additionally, this library includes Python bindings for all API calls for integration of QMK keyboard configuration into Python-based applications or scripts.
Usage
Rust
Add to Cargo.toml
dependencies:
[dependencies]
qmk-via-api = "*"
Usage example:
use qmk_via_api::api::KeyboardApi;
const PRODUCT_VID: u16 = 0x594D;
const PRODUCT_PID: u16 = 0x604D;
const USAGE_PAGE: u16 = 0xff60;
fn main() {
let api = KeyboardApi::new(PRODUCT_VID, PRODUCT_PID, USAGE_PAGE);
println!("Protocol version: {:?}", api.get_protocol_version());
println!("Layer count: {:?}", api.get_layer_count());
}
Python
Install with pip:
pip install qmk-via-api
Usage example:
import qmk_via_api
PRODUCT_VID = 0x594D
PRODUCT_PID = 0x604D
USAGE_PAGE = 0xff60
if __name__ == "__main__":
api = qmk_via_api.KeyboardApi(PRODUCT_VID, PRODUCT_PID, USAGE_PAGE)
print(f"Protocol version {api.get_protocol_version()}")
print(f"Layers count: {api.get_layer_count()}")
License & Attribution
The Rust code in this project is based on code from the VIA project, which is licensed under the GNU General Public License v3.0.
Dependencies
~4–12MB
~136K SLoC