Поддержка MacOS (проверено в Tahoe)
This commit is contained in:
@@ -13,6 +13,8 @@
|
||||
|
||||
Подсветка и клавиши управляются HID feature-репортами через штатный драйвер `usbhid` — **печатать можно прямо во время настройки**, драйвер не отцепляется, root не нужен (после разовой установки udev-правила).
|
||||
|
||||
macOS поддерживается экспериментально (транспорт IOKit, см. [docs/install.md](docs/install.md) → «Установка на macOS»).
|
||||
|
||||
| Характеристика | Значение |
|
||||
| -------------- | ------------------------------------------------------ |
|
||||
| Устройство | GANSS ARDOR_Katana |
|
||||
@@ -22,11 +24,11 @@
|
||||
## Быстрый старт
|
||||
|
||||
```
|
||||
# 1. установка (подробности — docs/INSTALL.md)
|
||||
# 1. установка (подробности — docs/install.md)
|
||||
python3 -m venv .venv && .venv/bin/pip install pyusb
|
||||
sudo cp 70-ganss-katana.rules /etc/udev/rules.d/ && sudo udevadm trigger
|
||||
|
||||
# 2. подсветка (подробности — docs/COLOR-MODES.md)
|
||||
# 2. подсветка (подробности — docs/color-modes.md)
|
||||
./katana.py mode breathing --color red # дыхание красным
|
||||
./katana.py paint --black --wasd dodgerblue # чёрная база, WASD голубым
|
||||
./katana.py keys # посмотреть, что сейчас светится
|
||||
@@ -43,7 +45,7 @@ sudo cp 70-ganss-katana.rules /etc/udev/rules.d/ && sudo udevadm trigger
|
||||
./katana.py apply ~/my-katana.yaml # макросы + переназначение + подсветка
|
||||
```
|
||||
|
||||
Если что-то не работает — загляните в [docs/INSTALL.md](docs/INSTALL.md) (разделы «Проверка устройства» и решение проблем) и в справочник команд [docs/cli/README.md](docs/cli/README.md).
|
||||
Если что-то не работает — загляните в [docs/install.md](docs/install.md) (разделы «Проверка устройства» и решение проблем) и в справочник команд [docs/cli/README.md](docs/cli/README.md).
|
||||
|
||||
## Документация
|
||||
|
||||
@@ -51,16 +53,16 @@ sudo cp 70-ganss-katana.rules /etc/udev/rules.d/ && sudo udevadm trigger
|
||||
|
||||
| Документ | Тема |
|
||||
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| [docs/INSTALL.md](docs/INSTALL.md) | Установка: зависимости, venv, udev-правило, проверка устройства, решение проблем. |
|
||||
| [docs/COLOR-MODES.md](docs/COLOR-MODES.md) | 19 режимов подсветки: таблица, примеры `mode`, аргументы, направление анимации. |
|
||||
| [docs/install.md](docs/install.md) | Установка: зависимости, venv, udev-правило, проверка устройства, решение проблем. |
|
||||
| [docs/color-modes.md](docs/color-modes.md) | 19 режимов подсветки: таблица, примеры `mode`, аргументы, направление анимации. |
|
||||
| [docs/cli/README.md](docs/cli/README.md) | Справочник `katana.py`: именованные цвета, имена клавиш, `paint`/`scan`/`raw`/`remap`/`macro`/`keys`/`reset`, решение проблем. |
|
||||
| [docs/cli/remap.md](docs/cli/remap.md) | Переназначение клавиш: мышь, редактор, горячие клавиши, мультимедиа, макросы. |
|
||||
| [docs/cli/macro.md](docs/cli/macro.md) | Макросы: запись, режимы повтора, XML вендора. |
|
||||
| [docs/cli/apply.md](docs/cli/apply.md) | `apply` — YAML-конфиг: все настройки одним файлом. |
|
||||
| [docs/EXTENDING.md](docs/EXTENDING.md) | Свои скрипты и анимации: `katana.py` как библиотека, API `Katana`, ограничения скорости и флеша, готовые приёмы. |
|
||||
| [docs/PROTOCOL.md](docs/PROTOCOL.md) | Протокол для реверсеров: транспорт, транзакции, форматы payload'ов, карта клавиш, статус реверса, грабли, планы. |
|
||||
| [docs/SCRIPTS.md](docs/SCRIPTS.md) | Состав репозитория и вспомогательные скрипты: `keymap.py`, `analyze_pcap.py`, `probe.py`. |
|
||||
| [docs/RAW-DATA.md](docs/RAW-DATA.md) | Дампы USB-трафика вендорской утилиты: как снимались, как конвертировать, состав `raw-data/katana-v1/`. |
|
||||
| [docs/extending.md](docs/extending.md) | Свои скрипты и анимации: `katana.py` как библиотека, API `Katana`, ограничения скорости и флеша, готовые приёмы. |
|
||||
| [docs/protocol.md](docs/protocol.md) | Протокол для реверсеров: транспорт, транзакции, форматы payload'ов, карта клавиш, статус реверса, грабли, планы. |
|
||||
| [docs/scripts.md](docs/scripts.md) | Состав репозитория и вспомогательные скрипты: `keymap.py`, `analyze_pcap.py`, `misc/probe.py`. |
|
||||
| [docs/raw-data.md](docs/raw-data.md) | Дампы USB-трафика вендорской утилиты: как снимались, как конвертировать, состав `raw-data/katana-v1/`. |
|
||||
|
||||
## Лицензия
|
||||
|
||||
@@ -101,6 +103,7 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
* AI-модель `koda-pro` через [KodaCode](https://kodacode.ru)
|
||||
* python 3.10 + pyusb + pyyaml
|
||||
* Linux (hidraw-ioctl) и macOS (IOKit через ctypes, экспериментально)
|
||||
* VirtualBox + Windows 11:
|
||||
* штатная утилита конфигурации клавиатуры
|
||||
* WireShark с установленным `usbpcap`
|
||||
@@ -108,7 +111,7 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
## TODO
|
||||
|
||||
* переназначение на другие типы действий (Fn-слой) и чтение таблицы переназначений — мышиные действия, шорткаты редактора, горячие клавиши, мультимедиа и макросы реализованы ([docs/cli/remap.md](docs/cli/remap.md), [docs/cli/macro.md](docs/cli/macro.md))
|
||||
* макросы: чтение содержимого из прошивки, коллизия кодов громкости и букв B/C, стрелки Up/Down, остальные медиа-коды ([docs/PROTOCOL.md](docs/PROTOCOL.md) → «Макросы»)
|
||||
* пресеты/анимации поверх per-key API — методика описана в [docs/EXTENDING.md](docs/EXTENDING.md).
|
||||
* макросы: чтение содержимого из прошивки, коллизия кодов громкости и букв B/C, стрелки Up/Down, остальные медиа-коды ([docs/protocol.md](docs/protocol.md) → «Макросы»)
|
||||
* пресеты/анимации поверх per-key API — методика описана в [docs/extending.md](docs/extending.md).
|
||||
|
||||
Cм. [docs/PROTOCOL.md](docs/PROTOCOL.md) → «Следующие шаги»
|
||||
Cм. [docs/protocol.md](docs/protocol.md) → «Следующие шаги»
|
||||
|
||||
Reference in New Issue
Block a user