|
|
@@ -17,7 +17,7 @@ Build locally:
|
|
|
```bash
|
|
|
git clone <repo-url>
|
|
|
cd qmk-rgb
|
|
|
-go build -o qmk-rgb ./cmd/qmk-rgb/
|
|
|
+go build -o qmk-rgb-tool ./cmd/qmk-rgb/
|
|
|
```
|
|
|
|
|
|
And, to run it from anywhere, install globally (run from the repo root, installs to `$GOPATH/bin/`):
|
|
|
@@ -30,32 +30,32 @@ go install ./cmd/qmk-rgb/
|
|
|
|
|
|
```bash
|
|
|
# Discover connected keyboards
|
|
|
-./qmk-rgb keyboard info
|
|
|
+./qmk-rgb-tool keyboard info
|
|
|
|
|
|
# RGB commands target Logo, Backlight, and Side by default
|
|
|
-./qmk-rgb effect breathing
|
|
|
-./qmk-rgb effect rainbow_moving_chevron
|
|
|
-./qmk-rgb effect rainbow_moving_chevron --zone backlight
|
|
|
-./qmk-rgb brightness 160
|
|
|
-./qmk-rgb speed 2
|
|
|
-./qmk-rgb color 00ff00
|
|
|
+./qmk-rgb-tool effect breathing
|
|
|
+./qmk-rgb-tool effect rainbow_moving_chevron
|
|
|
+./qmk-rgb-tool effect rainbow_moving_chevron --zone backlight
|
|
|
+./qmk-rgb-tool brightness 160
|
|
|
+./qmk-rgb-tool speed 2
|
|
|
+./qmk-rgb-tool color 00ff00
|
|
|
# Raw mode IDs are zone-specific; ID 17 is Backlight-only
|
|
|
-./qmk-rgb mode 17 --zone backlight
|
|
|
-./qmk-rgb enable
|
|
|
-./qmk-rgb disable
|
|
|
-./qmk-rgb info
|
|
|
+./qmk-rgb-tool mode 17 --zone backlight
|
|
|
+./qmk-rgb-tool enable
|
|
|
+./qmk-rgb-tool disable
|
|
|
+./qmk-rgb-tool info
|
|
|
|
|
|
# Select exactly one zone
|
|
|
-./qmk-rgb brightness 160 --zone side
|
|
|
+./qmk-rgb-tool brightness 160 --zone side
|
|
|
|
|
|
# Save and load RGB profiles
|
|
|
-./qmk-rgb save paul
|
|
|
-./qmk-rgb load paul
|
|
|
-./qmk-rgb list
|
|
|
-./qmk-rgb delete paul
|
|
|
+./qmk-rgb-tool save paul
|
|
|
+./qmk-rgb-tool load paul
|
|
|
+./qmk-rgb-tool list
|
|
|
+./qmk-rgb-tool delete paul
|
|
|
|
|
|
# Specify a target device (when multiple are connected)
|
|
|
-./qmk-rgb --device /dev/hidrawX enable
|
|
|
+./qmk-rgb-tool --device /dev/hidrawX enable
|
|
|
```
|
|
|
|
|
|
`--zone` is persistent across commands and accepts `logo`, `backlight`, or `side`.
|
|
|
@@ -197,7 +197,7 @@ Create a persistent rule for the Impact 80:
|
|
|
|
|
|
```bash
|
|
|
echo 'SUBSYSTEM=="hidraw", ATTRS{idVendor}=="36b0", ATTRS{idProduct}=="309f", MODE="0660", GROUP="adm"' \
|
|
|
- | sudo tee /etc/udev/rules.d/99-qmk-rgb.rules
|
|
|
+ | sudo tee /etc/udev/rules.d/99-qmk-rgb-tool.rules
|
|
|
|
|
|
sudo udevadm control --reload-rules
|
|
|
sudo udevadm trigger
|
|
|
@@ -229,22 +229,22 @@ New keyboards can be added to `keyboards.json`.
|
|
|
|
|
|
| Command | Description |
|
|
|
|---------------------------------|------------------------------------------|
|
|
|
-| `qmk-rgb keyboard info` | Discover connected VIA-compatible keyboards |
|
|
|
-| `qmk-rgb keyboard list` | List all supported keyboards in database |
|
|
|
-| `qmk-rgb enable` | Enable selected lighting zones |
|
|
|
-| `qmk-rgb disable` | Disable selected lighting zones |
|
|
|
-| `qmk-rgb info` | Show per-zone RGB state (JSON) |
|
|
|
-| `qmk-rgb effect <name>` | Set a zone-aware effect by name |
|
|
|
-| `qmk-rgb brightness <val>` | Set brightness (0–255) on selected zones |
|
|
|
-| `qmk-rgb speed <val>` | Set effect speed (0–255) on selected zones |
|
|
|
-| `qmk-rgb color <hex>` | Set color (e.g. `ff0000`) on selected zones |
|
|
|
-| `qmk-rgb mode <index>` | Set a raw zone-specific effect ID |
|
|
|
-| `qmk-rgb --zone <zone> ...` | Target `logo`, `backlight`, or `side` |
|
|
|
-| `qmk-rgb --device <path> ...` | Specify HID device path |
|
|
|
-| `qmk-rgb save [name]` | Save current RGB state to `profiles/<name>.json` |
|
|
|
-| `qmk-rgb load [name]` | Load and apply a profile from `profiles/` |
|
|
|
-| `qmk-rgb list` | List saved profiles |
|
|
|
-| `qmk-rgb delete [name]` | Delete a saved profile |
|
|
|
+| `qmk-rgb-tool keyboard info` | Discover connected VIA-compatible keyboards |
|
|
|
+| `qmk-rgb-tool keyboard list` | List all supported keyboards in database |
|
|
|
+| `qmk-rgb-tool enable` | Enable selected lighting zones |
|
|
|
+| `qmk-rgb-tool disable` | Disable selected lighting zones |
|
|
|
+| `qmk-rgb-tool info` | Show per-zone RGB state (JSON) |
|
|
|
+| `qmk-rgb-tool effect <name>` | Set a zone-aware effect by name |
|
|
|
+| `qmk-rgb-tool brightness <val>` | Set brightness (0–255) on selected zones |
|
|
|
+| `qmk-rgb-tool speed <val>` | Set effect speed (0–255) on selected zones |
|
|
|
+| `qmk-rgb-tool color <hex>` | Set color (e.g. `ff0000`) on selected zones |
|
|
|
+| `qmk-rgb-tool mode <index>` | Set a raw zone-specific effect ID |
|
|
|
+| `qmk-rgb-tool --zone <zone> ...` | Target `logo`, `backlight`, or `side` |
|
|
|
+| `qmk-rgb-tool --device <path> ...` | Specify HID device path |
|
|
|
+| `qmk-rgb-tool save [name]` | Save current RGB state to `profiles/<name>.json` |
|
|
|
+| `qmk-rgb-tool load [name]` | Load and apply a profile from `profiles/` |
|
|
|
+| `qmk-rgb-tool list` | List saved profiles |
|
|
|
+| `qmk-rgb-tool delete [name]` | Delete a saved profile |
|
|
|
|
|
|
## Profiles
|
|
|
|