refactor: update setup wizard steps and documentation; remove overview section

2026-06-21 07:29:21 +03:00
parent a983a06e41
commit d26d60def4
12 changed files with 182 additions and 88 deletions
@@ -0,0 +1,15 @@
+# Архитектура системы
+
+!!! info "Раздел в разработке"
+    Подробное описание архитектуры системы готовится.
+
+Система LWC построена как набор взаимосвязанных ROS 2 пакетов. Ключевые компоненты:
+
+- **iiwa_bringup** — launch-файлы, точка входа для запуска всей системы
+- **iiwa_controller** — hardware interface, реализует связь с контроллером KUKA по протоколу FRI
+- **iiwa_planning** — планирование движений на базе MoveIt 2
+- **iiwa_web** — REST API и MCP-сервер для внешнего управления
+- **iiwa_description** — URDF-описание робота и миры Webots
+- **iiwa_config** — все конфигурационные файлы (MoveIt, контроллеры, камеры)
+- **iiwa_utils** — вспомогательные Python-утилиты, загрузка конфигов
+- **iiwa_msgs** — кастомные ROS 2 типы сообщений (action, srv)
@@ -0,0 +1,24 @@
+# FRI-протокол
+
+!!! info "Раздел в разработке"
+    Подробное описание FRI-протокола готовится.
+
+**FRI (Fast Robot Interface)** — UDP-протокол низкоуровневого управления роботом KUKA в реальном времени. Работает поверх Ethernet и обеспечивает детерминированный цикл обмена данными между внешним ПК и контроллером KUKA.
+
+## Основные характеристики
+
+- **Транспорт:** UDP (без гарантии доставки — критично для RT)
+- **Период цикла:** 5 мс (200 Гц) или 10 мс (100 Гц), задаётся в `cobot-setting.yaml` → `robot.fri_cycle_ms`
+- **Режимы управления:** позиция, момент (крутящий момент), импеданс
+
+## Требования к сетевому подключению
+
+!!! warning "Важно: цикл 5 мс требует KONI"
+    Для работы с периодом цикла **5 мс (200 Гц)** необходимо подключение через порт **KONI**
+    (KUKA Optional Network Interface). Порт KLI поддерживает только 10 мс цикл.
+    При использовании KLI устанавливайте `fri_cycle_ms: 10`.
+
+| Порт | Мин. цикл | Назначение |
+|---|---|---|
+| **KONI** | 5 мс | Высокочастотное управление, рекомендуется для FRI |
+| **KLI** | 10 мс | Стандартное управление и программирование |
@@ -0,0 +1,23 @@
+# Планирование движений
+
+!!! info "Раздел в разработке"
+    Подробное описание планирования движений готовится.
+
+LWC использует **MoveIt 2** — стандартный фреймворк планирования движений для ROS 2.
+
+## Основные понятия
+
+- **Группа планирования** (`iiwa_arm`) — набор суставов, для которых строится план. Задаётся в SRDF.
+- **Планировщик** — алгоритм построения траектории. Доступны:
+  - `ompl` — универсальный вероятностный планировщик (по умолчанию)
+  - `pilz_industrial_motion_planner` — детерминированные траектории типа PTP, LIN, CIRC
+- **TCP (Tool Center Point)** — точка инструмента, для которой задаётся целевая поза. Настраивается в `cobot-setting.yaml` → `planning.pose_link`
+- **Система отсчёта** — координатная система целей. По умолчанию: `base_link`
+
+## Настройки в `cobot-setting.yaml`
+
+| Параметр | Описание |
+|---|---|
+| `planning.default_planner` | Планировщик по умолчанию: `ompl` или `pilz_industrial_motion_planner` |
+| `planning.planning_attempts` | Число попыток при неудаче планирования |
+| `planning.pose_link` | TCP-линк для декартовых целей |
@@ -0,0 +1,18 @@
+# Симуляция (Webots)
+
+!!! info "Раздел в разработке"
+    Подробное описание работы в симуляторе готовится.
+
+**Webots** — симулятор роботов с открытым исходным кодом. В LWC используется как цифровой двойник робота KUKA LBR IIWA 7: позволяет разрабатывать и отлаживать алгоритмы управления без доступа к физическому роботу.
+
+## Ключевые особенности
+
+- Симулятор использует те же ROS 2 топики и интерфейсы, что и реальный робот
+- Мир симуляции задаётся в `cobot-setting.yaml` → `digital_twin.webots.world`
+- Для запуска: `cobot run --simulate`
+
+## Отличия от реального робота
+
+- Нет ограничений по безопасности (можно двигаться быстрее)
+- Физика не идеальна — инерция, трение и упругость приближённые
+- FRI-протокол не задействован — связь идёт через Webots-драйвер ROS 2