chron_tui 0.1.0

Configure your Keychron mouse from the terminal
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

# chron_tui - Terminal user interface for adjusting Keychron mouse settings

[![CI](https://github.com/kubastick/chron-tui/actions/workflows/ci.yml/badge.svg)](https://github.com/kubastick/chron-tui/actions/workflows/ci.yml)

⚠️ Warning - the project is in a very early stage, try at your own risk and expect A LOT of issues  

![Screenshot of the terminal running tui](./media/preview.png)

## Device support

### Keychron M3 8K

| Feature                       | Status          | Notes                                                                         |
|-------------------------------|-----------------|-------------------------------------------------------------------------------|
| **Connecting to the device**  | ⚠️ Partial      | Connecting often does not work on the first try, but works on subsequent ones |
| **Wired/Wireless connection** | ✅ Supported     | Both wired (0xd050) and wireless receiver (0xd028)                            |
| **DPI Preset Selection**      | ✅ Supported     | Switch between 5 DPI presets                                                  |
| **DPI Preset Customization**  | ❌ Not Supported | Values are currently hardcoded                                                |
| **Polling Rate**              | ❌ Not Supported | UI placeholder exists, not yet functional                                     |
| **Device Info Query**         | ❌ Not Supported | Command sent but response not parsed                                          |
| **RGB Lighting Control**      | ❌ Not Supported |                                                                               |
| **Button Remapping**          | ❌ Not Supported |                                                                               |
| **Lift-off Distance**         | ❌ Not Supported |                                                                               |

#### Legend

- ✅ **Supported**: Feature is fully implemented and working
- ⚠️ **Partial**: Feature is in development or partially implemented
- ❌ **Not Supported**: Feature is not currently planned or implemented