zmkx

Python client for ZMKX


Keywords
helloword, zmkx
License
MIT
Install
pip install zmkx==0.3.0

Documentation

zmkx-sdk .github/workflows/build.yml

pypi downloads license issues stars commits

zmkx.app 的 Python 实现,包含一个供二次开发的库和一个简单的 CLI 客户端。

安装

需要 Python 3.8 以上。

pip3 install -U zmkx

快速上手

本仓库提供了一个最简单的 examples/set_image.py 演示换图功能:

python3 examples/set_image.py 你的图片.jpg

命令行

本仓库实现了一个命令行工具 zmkx 来操作设备,命令格式如下:

zmkx [-s SERIAL] command ...

完整命令说明请参考 zmkx -h

列出设备

$ zmkx list
* HelloWord HW-75 Dynamic (序列号: 34314704001A002B)
* HelloWord HW-75 Keyboard (序列号: 55895648066BFF53)

监控电机状态

$ zmkx knob --monitor
控制模式: 角度 | 当前角度:  23.7° | 当前速度:   -0.01 rad/s | 目标角度:  30.6° | 目标速度:    1.76 rad/s | 目标电压:   0.035 V

换图

$ zmkx eink --set 图片.jpg --dither

相关链接

协议

MIT License