Add documentation for SunriseWorkbench project setup and features

- Create libraries.md for library installation instructions in SunriseWorkbench. - Create load-project.md for importing existing projects in SunriseWorkbench. - Create new-project.md detailing the process of creating a new project in SunriseWorkbench. - Add applications.md to describe the applications section in KUKA smartHMI. - Add extra-menu.md for additional robot control options in KUKA smartHMI. - Create io-group.md for managing input/output groups in KUKA smartHMI. - Add robot-menu.md as a placeholder for the robot menu section in KUKA smartHMI. - Create station.md to outline the main navigation and functionalities in KUKA smartHMI. - Add LBRserver.md, robot-power-control.md, and teach-kuka.md as placeholders for respective control programs. - Create config-error.md to provide troubleshooting steps for configuration errors in SunriseWorkbench. - Add main.html to override base template with site root metadata.
2026-06-18 13:22:55 +03:00
parent 07edc4faf6
commit b7db2e991c
98 changed files with 685 additions and 190 deletions
@@ -0,0 +1,59 @@
+# Приложения
+
+Раздел **Приложения** предоставляет доступ к выбору и управлению управляющими программами, разработанными в SunriseWorkbench и развёрнутыми на контроллере. Раздел открывается через кнопку **Приложения** в строке навигации smartHMI.
+
+![Меню приложений](../../assets/kuka/applications/menu.jpg)
+
+## Список приложений
+
+Страница выбора приложений разделена на два столбца:
+
+| Столбец | Описание |
+|---|---|
+| Приложения робота | Управляющие программы, запускаемые вручную оператором. |
+| Фоновые приложения | Программы, выполняющиеся автоматически (`backgroundTask`). |
+
+Каждая запись в списке содержит:
+
+- **Индикатор состояния** — цветная точка слева от наименования.
+- **Наименование приложения** — имя класса Java.
+- **Пакет** — пространство имён или категория (например, `[application]`, `[ros]`, `[demo]`).
+- **Чекбокс** — для выбора или деактивации приложения.
+
+![Выбор приложения](../../assets/kuka/applications/choose_app.jpg)
+
+Кнопка **Сбросить выбранное приложение робота** (иконка руки) снимает выбор активного приложения без его остановки. Фоновые приложения, находящиеся в состоянии выполнения, отображаются с зелёной точкой и кнопкой **Стоп**.
+
+## Выбор и активация приложения
+
+Для выбора приложения нажмите на его наименование в списке. Выбранное приложение выделяется оранжевым цветом, в чекбоксе появляется галочка (✓), а наименование отображается в строке навигации smartHMI. Система автоматически открывает страницу **Контроль приложений** с текущим состоянием программы и журналом её выполнения.
+
+## Состояния приложения
+
+### Активизировано
+
+![Состояние: активизировано](../../assets/kuka/applications/app_active.jpg)
+
+Серый круглый индикатор — приложение выбрано и загружено в контроллер, однако ещё не запущено. Для запуска нажмите **Старт**.
+
+### Выполнение
+
+Зелёный индикатор воспроизведения — программа активно выполняется. В журнале в реальном времени отображаются события, определённые программистом. Если программа предусматривает взаимодействие с оператором, поверх журнала появляется диалог с кнопками выбора.
+
+### Перемещение приостановлено
+
+![Состояние: приостановлено](../../assets/kuka/applications/app_stoped.jpg)
+
+Жёлтый индикатор паузы — выполнение прервано. Для возобновления нажмите **Старт**.
+
+### Ошибка
+
+![Состояние: ошибка](../../assets/kuka/applications/app_error.jpg)
+
+Красный индикатор — в ходе выполнения возникло необработанное исключение. Строка состояния отображает код ошибки. Исправление логических ошибок выполняется в SunriseWorkbench.
+
+## Деактивация приложения
+
+![Деактивация приложения](../../assets/kuka/applications/selected_app.jpg)
+
+Для снятия выбора с приложения перейдите в раздел **Приложения**, найдите активное приложение (выделено оранжевым, чекбокс ✓) и нажмите на чекбокс — приложение будет деактивировано.
@@ -0,0 +1,84 @@
+# Дополнительное меню
+
+Помимо основных функциональных блоков раздела [Станция](station.md), smartHMI предоставляет доступ к дополнительным параметрам управления роботом через боковую панель smartPAD. Панели открываются поверх текущего вида и не требуют перехода в отдельный раздел интерфейса.
+
+## Метод управления роботом
+
+Панель **Опции ручного метода** позволяет настроить параметры ручного перемещения: активный инструмент, точку управления (TCP), базовую систему координат и вид перемещения.
+
+![Опции ручного метода](../../assets/kuka/extra-menu/move_method.jpg)
+
+### Выбор инструмента и TCP
+
+| Параметр | Описание |
+|---|---|
+| Инструмент | Активный инструмент, закреплённый на фланце. По умолчанию: `Фланец` |
+| TCP | Точка управления инструментом. По умолчанию: `Фланец (Root)` |
+
+### Выбор базы
+
+Базовая система координат, относительно которой выполняется ручное перемещение. Выбирается из списка фреймов, определённых в проекте (например, `P1`).
+
+### Вид перемещения
+
+Определяет систему координат, в которой работают кнопки осей A1–A7:
+
+| Режим | Описание |
+|---|---|
+| Оси | Поосевое управление. Каждая кнопка перемещает соответствующую ось независимо. |
+| Универс. | Перемещение в универсальной (мировой) системе координат. |
+| База | Перемещение в выбранной базовой системе координат. |
+| Инструмент | Перемещение в системе координат активного инструмента (TCP). |
+
+## Скорость управления
+
+Панель **Скорость** управляет процентным ограничением скорости ручного перемещения и выполнения программы.
+
+![Панель скорости](../../assets/kuka/extra-menu/speedmenu.jpg)
+
+## Вид перемещения
+
+Панель **Вид перемещения** управляет режимом работы кнопки **Старт** и параметрами подвода к фреймам.
+
+![Вид перемещения](../../assets/kuka/extra-menu/viewmove.jpg)
+
+### Режим приложения
+
+| Режим | Описание |
+|---|---|
+| Старт — непрерывный | Кнопка Старт запускает приложение в непрерывном режиме (по умолчанию). |
+| Пошаговое выполнение | Кнопка Старт выполняет программу по одному шагу. Используется при отладке. |
+
+### Подвод к фрейму
+
+| Тип | Описание |
+|---|---|
+| Подвод к PTP | Движение по кратчайшей траектории в пространстве суставов (Point-to-Point). |
+| Подвод к LIN | Движение по прямолинейной траектории TCP в декартовом пространстве (Linear). |
+
+Кнопка **Открыть вид фрейма** выполняет переход в раздел Фрейм.
+
+## Часы
+
+Нажатие на иконку часов отображает текущее системное время и дату контроллера.
+
+![Часы](../../assets/kuka/extra-menu/clock.jpg)
+
+!!! note
+    Системное время синхронизировано с часами контроллера KUKA Sunrise Cabinet. Изменение времени выполняется в настройках операционной системы контроллера.
+
+## Группа пользователей
+
+Диалог **Войти в систему** обеспечивает смену активной группы пользователей и соответствующего уровня доступа к функциям HMI.
+
+![Группа пользователей](../../assets/kuka/extra-menu/groupusers.jpg)
+
+Уровень доступа определяет перечень доступных операций: редактирование фреймов, управление Safety, изменение конфигурации проекта и другие.
+
+## Смена языка
+
+Диалог **Выбор языка** позволяет изменить язык интерфейса smartHMI.
+
+![Смена языка](../../assets/kuka/extra-menu/changelang.jpg)
+
+Изменение вступает в силу немедленно без перезагрузки системы. Текущий язык интерфейса отображается в нижнем левом углу smartHMI (например, `ru-RU`).
@@ -0,0 +1,41 @@
+# Меню IO Group
+
+Раздел **Группы вводов/выводов** предоставляет доступ к мониторингу и ручному управлению цифровыми сигналами ввода/вывода, сконфигурированными в проекте Sunrise. Раздел открывается через строку навигации smartHMI.
+
+![Список групп IO](../../assets/kuka/io-group/main.jpg)
+
+## Доступные группы
+
+При нажатии на кнопку **Группы вводов/выводов** в строке навигации открывается список доступных групп. В данном проекте определены следующие группы:
+
+| Группа | Описание |
+|---|---|
+| FRI | Группа сигналов интерфейса FRI (Fast Robot Interface) |
+| IO_group | Пользовательская группа цифровых вводов/выводов |
+
+## Просмотр сигналов
+
+После выбора группы открывается страница со списком всех сигналов.
+
+![Управление выходными сигналами](../../assets/kuka/io-group/output.jpg)
+
+### Структура таблицы сигналов
+
+| Столбец | Описание |
+|---|---|
+| Вход / Выход | Иконка направления сигнала |
+| Имя | Наименование сигнала (например, `In_1`, `Out_16`) |
+| Тип | Тип сигнала (для данной группы — цифровой Boolean) |
+| Значение | Текущее состояние сигнала (`0` / `1`) |
+
+## Управление выходными сигналами
+
+Для сигналов с направлением **Выход** в нижней панели отображаются кнопки принудительной установки значения:
+
+| Кнопка | Действие |
+|---|---|
+| True | Установить значение выходного сигнала в `1` (активен) |
+| False | Установить значение выходного сигнала в `0` (неактивен) |
+
+!!! note
+    Сигналы с направлением **Вход** доступны только для чтения.
@@ -0,0 +1,6 @@
+# Меню робота
+
+В данном разделе будет представлено описание раздела **Меню робота** интерфейса KUKA smartHMI.
+
+!!! info "Раздел в разработке"
+    Содержимое данного раздела находится в процессе подготовки.
@@ -0,0 +1,168 @@
+# Станция
+
+Раздел **Станция** является главным уровнем навигации интерфейса KUKA smartHMI. Он открывается нажатием кнопки **Станция** в строке навигации smartPAD и предоставляет доступ к основным функциям управления роботизированной ячейкой.
+
+![Главное окно Станция](../../assets/kuka/station/main.jpg)
+
+## Структура меню
+
+Интерфейс раздела Станция включает четыре функциональных блока:
+
+| Блок | Описание |
+|---|---|
+| Меню навигации | Станция, Приложения, Меню робота, Меню IO Group |
+| Меню станции | Данные процесса, Safety, Фреймы, KUKA_Sunrise_cabinet, Состояние HMI, Информация, Протокол |
+| Дополнительное меню | Вид перемещения, Часы, Пользовательские кнопки |
+| Функциональные кнопки smartPAD | Управление программой и перемещением |
+
+## Данные процесса
+
+Раздел **Данные процесса** отображает текущее состояние активного приложения (например, `Ok`). Используется для мониторинга параметров выполняемой программы в режиме реального времени.
+
+## Safety
+
+Раздел **Safety** предоставляет доступ к настройкам и состоянию системы безопасности робота.
+
+![Safety](../../assets/kuka/station/safety1.jpg)
+
+### Функции блока Safety
+
+| Функция | Описание |
+|---|---|
+| Состояние | Отображает текущее состояние конфигурации безопасности |
+| Активация | Управление активацией и деактивацией конфигурации безопасности |
+
+### Доступные действия на странице Активация
+
+| Действие | Описание |
+|---|---|
+| Активизировать | Применить и активировать текущую конфигурацию безопасности |
+| Деактивировать | Отключить активную конфигурацию безопасности |
+| Сброс | Сбросить конфигурацию безопасности к предыдущему состоянию |
+
+Поле **Id безопасной конфигурации** отображает уникальный идентификатор загруженной конфигурации (например, `2BCAB6DD`).
+
+![Safety — Активация](../../assets/kuka/station/safety2.jpg)
+
+## Фреймы
+
+Раздел **Фреймы** открывает редактор систем координат.
+
+![Фреймы — общий вид](../../assets/kuka/station/frames.jpg)
+
+Здесь отображается список всех фреймов, определённых в проекте Sunrise, с возможностью просмотра, корректировки и навигации по иерархии.
+
+### Структура таблицы фреймов
+
+| Столбец | Описание |
+|---|---|
+| Имя фрейма | Наименование фрейма в проекте |
+| X, Y, Z | Смещение по осям в мм |
+| A, B, C | Ориентация в градусах |
+
+Данные фреймов также доступны в приложении SunriseWorkbench.
+
+### Навигация и корректировка
+
+![Вложенные фреймы](../../assets/kuka/station/frames2.jpg)
+
+Для перехода в дочерние фреймы нажмите кнопку **>** рядом с нужным фреймом. Путь навигации в строке «хлебных крошек» обновляется автоматически. Для возврата на предыдущий уровень нажмите соответствующий элемент в строке навигации.
+
+![Корректировка фрейма](../../assets/kuka/station/frames3.jpg)
+
+При нажатии **Корректировать** открывается диалог с таблицей сравнения текущих и новых значений. Для подтверждения нажмите **Сохранить**, для отмены — **Отменить**.
+
+![Вложенность фреймов](../../assets/kuka/station/frames4.jpg)
+
+Фреймы поддерживают многоуровневую вложенность. Полный путь иерархии отображается в строке навигации (например, `Универсальный > grant_RNF > P4`).
+
+## KUKA_Sunrise_cabinet
+
+Раздел **KUKA_Sunrise_Cabinet** отображает информацию о состоянии аппаратных компонентов контроллера.
+
+![KUKA Sunrise Cabinet](../../assets/kuka/station/cabinet.jpg)
+
+| Компонент | Описание |
+|---|---|
+| Состояние загрузки | Статус загрузки контроллера |
+| Магистральные шины | Состояние шины EtherCAT |
+
+## Состояние HMI
+
+Раздел **Состояние HMI** отображает статус соединения между smartHMI и контроллером Sunrise Cabinet.
+
+## Протокол
+
+Раздел **Протокол** открывает журнал системных событий.
+
+![Протокол](../../assets/kuka/station/protocol.jpg)
+
+### Фильтры журнала
+
+| Фильтр | Описание |
+|---|---|
+| Источник(и) | Станция, LBR_iiwa_7_R800 или оба |
+| Уровень | Информация, Предупреждение, Ошибка |
+| Промежуток времени | Временной диапазон выборки |
+
+Каждая запись содержит: иконку уровня, дату и время события, источник, наименование и описание события.
+
+## Информация
+
+Раздел **Информация** содержит подробные системные сведения о контроллере и подключённом роботе.
+
+![Информация](../../assets/kuka/station/info.jpg)
+
+## Функциональные кнопки smartPAD
+
+Физические кнопки smartPAD разделены на три группы: кнопки управления программой (левая панель), кнопки ручного управления осями (правая панель) и пользовательские кнопки.
+
+### Кнопки управления программой
+
+| Кнопка | Описание |
+|---|---|
+| Редактировать | Переход в режим обучения (Teach). Активирует возможность изменения точек программы в ручном режиме. |
+| Стоп | Останавливает выполнение программы или движение робота. |
+| Шаг назад | Выполняет один шаг программы в обратном направлении. Используется для отладки. |
+| Старт | Запускает выбранное приложение или возобновляет остановленную программу. В режиме T1/T2 требует удержания enabling device. |
+
+!!! note
+    Режим редактирования со smartPAD не используется — все программы написаны на Java и изменяются только в SunriseWorkbench.
+
+### Кнопки управления осями (режимы T1 и T2)
+
+| Кнопка | Описание |
+|---|---|
+| A1 − / A1 + | Перемещение оси 1 в отрицательном / положительном направлении |
+| A2 − / A2 + | Перемещение оси 2 в отрицательном / положительном направлении |
+| A3 − / A3 + | Перемещение оси 3 в отрицательном / положительном направлении |
+| A4 − / A4 + | Перемещение оси 4 в отрицательном / положительном направлении |
+| A5 − / A5 + | Перемещение оси 5 в отрицательном / положительном направлении |
+| A6 − / A6 + | Перемещение оси 6 в отрицательном / положительном направлении |
+| A7 − / A7 + | Перемещение оси 7 в отрицательном / положительном направлении |
+
+При выборе режима декартового управления те же кнопки управляют перемещением TCP по осям X / Y / Z и ориентацией A / B / C.
+
+### Управление скоростью (Override)
+
+| Кнопка | Описание |
+|---|---|
+| 0 | Уменьшение скорости ручного перемещения |
+| 100 | Увеличение скорости ручного перемещения |
+
+Значение отображается в процентах от максимальной скорости. В режиме T1 скорость TCP аппаратно ограничена до 250 мм/с.
+
+### Пользовательские кнопки
+
+Четыре белые круглые кнопки в нижней части левой панели. Их назначение задаётся программно в Sunrise-проекте через API. По умолчанию не назначены.
+
+## Режимы работы
+
+| Режим | Описание |
+|---|---|
+| T1 | Ручное управление, скорость ограничена до 250 мм/с по TCP. Требуется удержание enabling device. |
+| T2 | Ручное управление, нормальная скорость. Требуется удержание enabling device. |
+| AUT | Автоматический режим. Кнопки осей недоступны, управление осуществляется кнопками Старт / Стоп. |
+
+!!! tip "Дополнительное меню"
+    Описание дополнительных параметров управления приведено в разделе [Дополнительное меню](extra-menu.md).