https://github.com/xingrz/zmkx-sdk
zmkx.app 的 Python 实现，包含一个供二次开发的库和一个简单的 CLI 客户端
https://github.com/xingrz/zmkx-sdk
helloword zmkx
Last synced: about 2 months ago
JSON representation
zmkx.app 的 Python 实现，包含一个供二次开发的库和一个简单的 CLI 客户端
- Host: GitHub
- URL: https://github.com/xingrz/zmkx-sdk
- Owner: xingrz
- License: mit
- Created: 2023-06-13T02:04:06.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-19T03:20:10.000Z (over 1 year ago)
- Last Synced: 2025-04-13T01:13:32.803Z (about 2 months ago)
- Topics: helloword, zmkx
- Language: Python
- Homepage:
- Size: 22.5 KB
- Stars: 11
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
zmkx-sdk [](https://github.com/xingrz/zmkx-sdk/actions/workflows/build.yml)
========
[![pypi][pypi-img]][pypi-url] [![downloads][downloads-img]][downloads-url] [![license][license-img]][license-url] [![issues][issues-img]][issues-url] [![stars][stars-img]][stars-url] [![commits][commits-img]][commits-url]
[zmkx.app](https://github.com/xingrz/zmkx.app) 的 Python 实现，包含一个供二次开发的库和一个简单的 CLI 客户端。
## 安装
需要 Python 3.8 以上。
```sh
pip3 install -U zmkx
```
## 快速上手
本仓库提供了一个最简单的 [`examples/set_image.py`](examples/set_image.py) 演示换图功能：
```sh
python3 examples/set_image.py 你的图片.jpg
```
## 命令行
本仓库实现了一个命令行工具 [`zmkx`](bin/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
```
## 相关链接
* [zmkx.app](https://github.com/xingrz/zmkx.app)
* [ZMK for HW-75](https://github.com/xingrz/zmk-config_helloword_hw-75)
* [peng-zhihui/HelloWord-Keyboard](https://github.com/peng-zhihui/HelloWord-Keyboard)
## 协议
[MIT License](LICENSE)
[pypi-img]: https://img.shields.io/pypi/v/zmkx?style=flat-square
[pypi-url]: https://pypi.org/project/zmkx/
[downloads-img]: https://img.shields.io/pypi/dm/zmkx?style=flat-square
[downloads-url]: https://pypi.org/project/zmkx/
[license-img]: https://img.shields.io/github/license/xingrz/zmkx-sdk?style=flat-square
[license-url]: LICENSE
[issues-img]: https://img.shields.io/github/issues/xingrz/zmkx-sdk?style=flat-square
[issues-url]: https://github.com/xingrz/zmkx-sdk/issues
[stars-img]: https://img.shields.io/github/stars/xingrz/zmkx-sdk?style=flat-square
[stars-url]: https://github.com/xingrz/zmkx-sdk/stargazers
[commits-img]: https://img.shields.io/github/last-commit/xingrz/zmkx-sdk?style=flat-square
[commits-url]: https://github.com/xingrz/zmkx-sdk/commits/master