# watrt_keyboard

**Repository Path**: watrt/watrt_keyboard

## Basic Information

- **Project Name**: watrt_keyboard
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-25
- **Last Updated**: 2025-12-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Watrt Keyboard

这是一个基于 KMK 固件的键盘项目，适用于 CircuitPython 兼容的微控制器（如 RP2040、nice!nano 等）。

## 特性

- 使用 Python 编写，易于定制和扩展。
- 支持多层按键映射。
- 支持多种外设和扩展功能（如 RGB 灯效、编码器、OLED 显示等）。
- 可运行于多种微控制器平台。

## 支持的键盘

- 多种常见机械键盘设计，如 Lily58、Corne、Dactyl ManuForm、Kyria 等。
- 支持手焊键盘（Handwired）和自定义 PCB 设计。
- 支持 Split 键盘（有线或无线）。

## 快速开始

### 依赖

- Python 3.9 或更高版本
- CircuitPython 兼容的微控制器（如 Raspberry Pi Pico、nice!nano 等）

### 构建固件

1. 确保你已安装 Docker。
2. 运行以下命令来构建固件：

```bash
make
```

3. 编译完成后，将生成的固件文件复制到微控制器的根目录。

### 烧录固件

1. 将微控制器设置为 bootloader 模式。
2. 将编译好的 `.uf2` 文件拖放到微控制器显示的磁盘中。

## 自定义键位图

你可以通过修改 `user_keymaps` 文件夹下的 Python 文件来自定义键位映射。

示例：
```python
from kmk.keys import KC

# 定义你的键位映射
keyboard.keymap = [
    [KC.Q, KC.W, KC.E, KC.R, KC.T, KC.Y, KC.U, KC.I, KC.O, KC.P],
    [KC.A, KC.S, KC.D, KC.F, KC.G, KC.H, KC.J, KC.K, KC.L, KC.ENT],
    [KC.Z, KC.X, KC.C, KC.V, KC.B, KC.N, KC.M, KC.COMM, KC.DOT, KC.SLSH],
    [KC.LCTL, KC.LGUI, KC.LALT, KC.SPC, KC.BSPC, KC.ESC, KC.TAB, KC.MO(1), KC.LEFT, KC.DOWN, KC.UP, KC.RIGHT]
]
```

## 扩展功能

KMK 支持多种扩展功能，例如：

- **RGB 灯效**：支持 WS2812、APA102 等 LED。
- **OLED 显示**：可显示当前层、按键状态等信息。
- **编码器**：支持旋转编码器用于音量调节或其他功能。
- **无线连接**：通过 BLE 实现无线键盘。

## 调试

你可以通过串口连接查看调试信息：

```bash
screen /dev/tty.usbmodem* 115200
```

## 贡献

欢迎提交 Pull Request 或 Issue。请遵循项目代码风格，并确保测试通过。

## 许可证

该项目使用 GNU General Public License v3.0。详见 [LICENSE.md](kmk_firmware/LICENSE.md) 文件。

## 更多文档

请参考 [KMK 文档](kmk_firmware/docs/en/README.md) 获取更多详细信息。