Robotics Docs¶
В этом репозитории собрана документация по эксплуатации и разработке для робототехнических платформ Инженерной школы NewUU. Она написана для тех, кто действительно включает эти машины: преподавателей, ведущих лабораторные занятия, студентов, работающих по учебному плану, и разработчиков, чей код исполняется на роботе.
Каждая процедура здесь написана как процедура. Шаги пронумерованы, комбинации кнопок указаны точно, требования безопасности выделены отдельно. Выполняйте их в приведённом порядке.
Сайт доступен на английском и русском языках — переключайтесь селектором языка в шапке. Соседний значок переключает светлую и тёмную тему.
Платформы¶
- Unitree G1 EDU — человекоподобный робот, версия EDU (secondary development). Полное руководство по эксплуатации, процедура калибровки, настройка SDK и сети, обслуживание и устранение неисправностей.
Прежде чем подойти к роботу¶
Сначала прочитайте Технику безопасности G1. Раздел короткий, и в нём есть то, что обязан знать каждый оператор до подачи питания: как остановить робота.
Аварийная остановка G1 — L2+B. Физической кнопки аварийной остановки в этой поставке нет.
Как устроена документация¶
| Раздел | Когда нужен |
|---|---|
| Обзор | Нужна аппаратная конфигурация и границы применимости руководства |
| Техника безопасности | Перед каждой сессией и при инструктаже |
| Справочник по управлению | Нужна комбинация кнопок или карта режимов |
| Подготовка рабочего места | Готовите помещение перед занятием |
| Штатные процедуры | Включение, ходьба, жесты, танцы, выключение |
| Работа с кронштейном | Робот подвешен для разработки или калибровки |
| Мобильное приложение | Работаете с приложением, OTA, навигацией или demo teaching |
| Калибровка | Робот регулярно падает или уводит в сторону, и перезагрузка не помогает |
| Разработка | Пишете код, подключаетесь по SSH или расширяете железо |
| Обслуживание | Чистите, заряжаете или убираете робота на хранение |
| Устранение неисправностей | Поведение робота расходится с описанным |
| Учебный план | Ведёте занятия или отслеживаете прогресс студентов |
Как стать контрибьютером¶
Документация ведётся открыто. Если вы нашли ошибку или хотите добавить материал, откройте Issue или Pull Request.
Правила создания Issue¶
- Проверьте, что обращаетесь в нужный репозиторий.
- Если сообщаете об ошибке, убедитесь, что такого Issue ещё нет.
- Заполняйте заголовок и описание точно.
- Указывайте в заголовке один из флагов:
[BUG],[PROPOSAL],[QUESTION].
Правила создания Pull Request¶
- Для небольших правок — опечатки, форматирование — предпочтительнее Pull Request.
- Опишите проблему и предлагаемое решение. При наличии укажите номер Issue.
- Прежде чем править форматирование, убедитесь, что это нужно.
- Придерживайтесь принятого в репозитории стиля Markdown.
- Английская версия — основная. Правку по существу вносите в обе языковые версии.
Локальное развёртывание¶
Запуск документации в Docker-контейнере:
git clone https://github.com/NewUU-engineering/robotics-docs
cd robotics-docs
docker pull squidfunk/mkdocs-material
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
Либо в виртуальном окружении Python:
python3 -m venv venv
source venv/bin/activate
pip install mkdocs-material "mkdocs-static-i18n[material]"
mkdocs serve
Сайт будет доступен по адресу http://127.0.0.1:8000.