160 lines
8.5 KiB
Markdown
160 lines
8.5 KiB
Markdown
# Plate Config App
|
||
|
||
Приложение для настройки и тестирования аппаратных плат через COM-порт.
|
||
Позволяет подключаться к плате, проходить авторизацию, отправлять команды,
|
||
тестировать входы, выходы и подсветку, обновлять прошивку и назначать роли.
|
||
|
||
---
|
||
|
||
## Содержание
|
||
|
||
- [Системные требования](#системные-требования)
|
||
- [Установка и запуск](#установка-и-запуск)
|
||
- [Интерфейс приложения](#интерфейс-приложения)
|
||
- [Главная страница](#главная-страница)
|
||
- [Подключение к плате](#подключение-к-плате)
|
||
- [Панель управления](#панель-управления)
|
||
- [Файлы данных](#файлы-данных)
|
||
- [Настройки](#настройки)
|
||
- [Документация для разработчиков](#документация-для-разработчиков)
|
||
|
||
---
|
||
|
||
## Системные требования
|
||
|
||
- Windows 10 / 11
|
||
- COM-порт (физический или виртуальный), к которому подключена плата
|
||
|
||
Для запуска из собранного EXE дополнительных зависимостей не требуется.
|
||
|
||
---
|
||
|
||
## Установка и запуск
|
||
|
||
### Из готового EXE
|
||
|
||
1. Скопируйте `plate_config_app.exe` в любую папку.
|
||
2. Запустите двойным кликом.
|
||
|
||
Файл настроек `settings.json` создается автоматически рядом с EXE при первом
|
||
изменении настроек.
|
||
|
||
### Из исходников (для разработки)
|
||
|
||
См. [DEVELOPMENT.md](DEVELOPMENT.md).
|
||
|
||
---
|
||
|
||
## Интерфейс приложения
|
||
|
||
### Главная страница
|
||
|
||
При запуске отображается стартовый экран с кнопками:
|
||
|
||
- **Новое соединение** -- открывает вкладку настройки COM-порта.
|
||
- **Команды платы** -- справочник поддерживаемых команд платы с поиском.
|
||
- **Настройки приложения** -- выбор цветовой темы (светлая / темная, зеленый /
|
||
синий акцент).
|
||
|
||
Приложение поддерживает несколько одновременных подключений: каждое соединение
|
||
открывается в отдельной вкладке.
|
||
|
||
### Подключение к плате
|
||
|
||
Во вкладке соединения выберите параметры:
|
||
|
||
| Параметр | Значение по умолчанию |
|
||
|--------------|-----------------------|
|
||
| Port | (первый доступный) |
|
||
| Baud rate | 115200 |
|
||
| Data bits | 8 |
|
||
| Stop bits | 1 |
|
||
| Parity | None |
|
||
| Flow control | None |
|
||
|
||
Нажмите **OK** для подключения. Кнопка **Обновить порты** обновляет список
|
||
доступных COM-портов.
|
||
|
||
### Панель управления
|
||
|
||
После подключения открывается панель с двумя режимами работы:
|
||
|
||
#### Базовый режим
|
||
|
||
В базовом режиме доступны встроенные секции, организованные в сворачиваемые
|
||
группы:
|
||
|
||
| Секция | Описание |
|
||
|---------------------------|--------------------------------------------------|
|
||
| Обновление прошивки | Загрузка файла и OTA-обновление с прогрессом |
|
||
| Тест цвета | Управление светодиодами и режимами подсветки |
|
||
| Тест ввода | Мониторинг входов, джойстик, калибровка, ADC |
|
||
| Тест оплаты и призов | Монетоприёмник, хоппер, автовыдача призов |
|
||
|
||
#### PRO-режим
|
||
|
||
Переключатель «PRO» открывает доступ к расширенным диалогам:
|
||
|
||
| Действие | Описание |
|
||
|-------------------------|--------------------------------------------------|
|
||
| Handshake (Авторизация) | AES-256 авторизация на плате (если требуется) |
|
||
| Тест ввода | Мониторинг состояния входов в реальном времени |
|
||
| Тест подсветки | Управление светодиодами и режимами подсветки |
|
||
| Тест силовых выходов | Включение/выключение силовых выходов |
|
||
| Обновление прошивки | Загрузка файла прошивки на плату |
|
||
| Задание роли | Назначение роли платы |
|
||
| Ввод команд | Терминал для отправки произвольных команд вручную |
|
||
|
||
#### Статус подключения
|
||
|
||
Индикатор в заголовке вкладки отображает текущее состояние:
|
||
|
||
- Красный — нет связи.
|
||
- Желтый — подключено, требуется авторизация.
|
||
- Зеленый — подключено, плата готова к работе.
|
||
|
||
Кнопка переподключения (↻) позволяет быстро восстановить связь при обрыве.
|
||
|
||
---
|
||
|
||
## Файлы данных
|
||
|
||
Рядом с EXE (или в корне проекта при запуске из исходников) могут располагаться
|
||
папки с конфигурациями:
|
||
|
||
| Папка | Расширение | Назначение |
|
||
|--------------------|------------|------------------------------------------|
|
||
| `light_modes/` | `.lm` | Режимы подсветки (формат TOML) |
|
||
| `input_mappings/` | `.mapping` | Маппинги входов по играм (формат TOML) |
|
||
| `commands/` | `.csv` | Наборы команд платы (разделитель `;`) |
|
||
|
||
Эти файлы располагаются рядом с EXE (или в корне проекта при запуске из
|
||
исходников). При сборке они автоматически копируются в папку `dist/` рядом с
|
||
EXE. Можно редактировать файлы конфигураций без пересборки — достаточно
|
||
изменить нужный файл и перезапустить приложение.
|
||
|
||
---
|
||
|
||
## Настройки
|
||
|
||
Настройки хранятся в `settings.json` рядом с EXE. Файл создается автоматически.
|
||
|
||
Доступные параметры (изменяются через диалог в приложении):
|
||
|
||
| Параметр | Значения | По умолчанию |
|
||
|-------------------------|--------------------------|---------------|
|
||
| Тема | Светлая / Тёмная | Светлая |
|
||
| Акцент | Зелёный / Синий | Зелёный |
|
||
| Проверка состояния платы| Вкл / Выкл | Выкл |
|
||
| Интервал проверки | 5–60 сек | 10 сек |
|
||
|
||
---
|
||
|
||
## Документация для разработчиков
|
||
|
||
- [DEVELOPMENT.md](DEVELOPMENT.md) -- настройка окружения, структура проекта,
|
||
запуск из исходников.
|
||
- [BUILD_EXE.md](BUILD_EXE.md) -- сборка EXE-файла через PyInstaller.
|
||
- [Система команд платы v2.x.md](%D0%A1%D0%B8%D1%81%D1%82%D0%B5%D0%BC%D0%B0%20%D0%BA%D0%BE%D0%BC%D0%B0%D0%BD%D0%B4%20%D0%BF%D0%BB%D0%B0%D1%82%D1%8B%20v2.x.md) --
|
||
описание протокола и команд платы.
|