Docker контейнери для PX4

Для повного інструментарію розробника PX4надаються Docker контейнери, включаючи апаратне забезпечення, основане на NuttX та Linux, симуляція Gazebo Classic та ROS.

Цей розділ розповідає як використовувати Наявні docker контейнери, щоб отримати доступ до середовища збірки на локальному Linux комп'ютері.

Ви можете знайти Dockerfile та README на Github. Вони автоматично збираються на Docker Hub.

Необхідні умови

::: note На цей момент контейнери для PX4 підтримуються лише для Linux (якщо немає Linux ви можете запустити контейнер всередині віртуальної машини). Не використовуйте boot2docker із образом за замовчуванням, тому що він не містить X-Server. :::

Встановіть Docker для Linux, бажано використовувати один з репозиторіїв пакетів, які підтримуються Docker, щоб отримати останню стабільну версію. Ви можете використовувати або Enterprise Edition або (безплатну) Community Edition.

Для локального встановлення для позавиробничих установок на Ubuntu, найшвидший і найпростіший спосіб встановити Docker - це скористатися зручним скриптом як показано нижче (альтернативні методи встановлення вказані там же):

curl -fsSL get.docker.com -o get-docker.sh
sudo sh get-docker.sh

Встановлення за замовчуванням потребує використання root користувача для запуску Docker (тобто за допомогою sudo). Однак для збірки прошивок PX4 пропонуємо використовувати docker від імені непривілейованого користувача. Таким чином, директорія для збірки не буде належати користувачу root після використання docker.

# Створіть групу docker (можливо не потрібно)
sudo groupadd docker
# Додайте вашого користувача в групу docker.
sudo usermod -aG docker $USER
# Вийдіть та увійдіть перед використанням docker!

Ієрархія контейнерів

Усі доступні контейнери можна знайти на Github.

Вони дозволяють тестувати різні цілі збірки та конфігурації (включені інструменти можна зрозуміти з їх назв). Контейнери є ієрархічними, тобто такими, що мають функціональність вихідних контейнерів. Наприклад, часткова ієрархія нижче показує, що docker контейнер з інструментами збірки nuttx (px4-dev-nuttx-focal) не містить ROS 2, на відміну від контейнерів симуляції:

- px4io/px4-dev-base-focal
  - px4io/px4-dev-nuttx-focal
  - px4io/px4-dev-simulation-focal
    - px4io/px4-dev-ros-noetic
      - px4io/px4-dev-ros2-foxy
  - px4io/px4-dev-ros2-rolling
- px4io/px4-dev-base-jammy
  - px4io/px4-dev-nuttx-jammy

Найновіша версія доступна з використанням тегу latest: px4io/px4-dev-nuttx-focal:latest (доступні теги перелічені для кожного контейнеру на hub.docker.com. Наприклад теги для px4io/px4-dev-nuttx-focal можна знайти тут).

TIP

Зазвичай потрібно використовувати свіжий контейнер, але не обов'язково latest (т. як вони часто змінюються).

Використання Docker контейнера

Наступні інструкції показують, як зібрати вихідний код PX4 на основному комп'ютері за допомогою інструментарію, що працює у docker контейнері. Передбачається, що ви вже завантажили вихідний код PX4 в src/PX4-Autopilot, як показано:

mkdir src
cd src
git clone https://github.com/PX4/PX4-Autopilot.git
cd PX4-Autopilot

Допоміжний скрипт (docker_run.sh)

Найпростіший спосіб використовувати контейнери - разом із допоміжним скриптом docker_run.sh. Цей скрипт приймає команду збірки PX4 як аргумент (наприклад, make tests). Він запускає docker із найновішою версією відповідного контейнера (вказано в коді) і слушними налаштуваннями середовища.

Наприклад, щоб зібрати SITL потрібно виконати (із директорії /PX4-Autopilot):

./Tools/docker_run.sh 'make px4_sitl_default'

Або почати сеанс bash використовуючи інструментарій NuttX:

./Tools/docker_run.sh 'bash'

TIP

Цей скрипт легко використовувати тому що вам не потрібно знати багато про Docker або думати який контейнер взяти. Однак він не дуже надійний! Ручний підхід, що обговорюється в наступній частині більш гнучкий і повинен використовуватися якщо є якісь проблеми зі скриптом.

Запуск Docker вручну

Синтаксис типової команди показано нижче. Це запускає Docker контейнер з підтримкою переадресації X (що робить графічний інтерфейс симуляції доступним з середини контейнера). Каталог <host_src> комп'ютера відображається на каталог <container_src> всередині контейнера, а також переадресується UDP порт, потрібний для з'єднання з QGroundControl. З параметром -–privileged контейнер автоматично матиме доступ до апаратного забезпечення на вашому комп'ютері (наприклад до джойстика або GPU). Якщо ви під'єднуєте/від'єднуєте пристрій, вам слід перезапустити контейнер.

# дозвольте доступ до xhost з контейнера
xhost +

# запуск docker
docker run -it --privileged \
    --env=LOCAL_USER_ID="$(id -u)" \
    -v <host_src>:<container_src>:rw \
    -v /tmp/.X11-unix:/tmp/.X11-unix:ro \
    -e DISPLAY=:0 \
    -p 14570:14570/udp \
    --name=<local_container_name> <container>:<tag> <build_command>

Де:

• <host_src>: Директорія комп'ютера для відображення на директорію <container_src> у контейнері. Зазвичай потрібно щоб це була директорія PX4-Autopilot.
• <container_src>: Розташування спільної (вихідної) директорії всередині контейнера.
• <local_container_name>: Ім'я docker контейнера, що створюється. Це потім можна використовувати, якщо потрібно посилатись на контейнер знову.
• <container>:<tag>: Контейнер з тегом версії для запуску, наприклад: px4io/px4-dev-ros:2017-10-23.
• <build_command>: Команда яку потрібно виконати на новому контейнері. Наприклад, bash для запуску оболонки bash у контейнері.

Наведений нижче приклад показує як запустити консоль bash і розділити каталог ~/src/PX4-Autopilot між контейнером і основним комп'ютером.

# дозвольте доступ до xhost з контейнера
xhost +

# запуск docker та оболонки bash
docker run -it --privileged \
--env=LOCAL_USER_ID="$(id -u)" \
-v ~/src/PX4-Autopilot:/src/PX4-Autopilot/:rw \
-v /tmp/.X11-unix:/tmp/.X11-unix:ro \
-e DISPLAY=:0 \
--network host \
--name=px4-ros px4io/px4-dev-ros2-foxy:2022-07-31 bash

::: note Ми використовуємо режим хост-мережі, щоб уникнути конфліктів між керуванням доступом до порту UDP під час використання QGroundControl у тій же системі, що й контейнер докерів. :::

::: note Якщо ви зіткнулися з помилкою «Не вдається відкрити дисплей: :0», можливо, для DISPLAY потрібно встановити інше значення. На комп'ютерах з Linux (XWindow) ви можете змінити параметр -e DISPLAY=:0 на -e DISPLAY=$DISPLAY. На інших системах вам можливо знадобиться послідовно змінити 0 в -e DISPLAY=:0 допоки помилка "Can't open display: :0" не зникне. :::

Якщо все пройшло добре, ви повинні бути в новій оболонці bash. Перевірте, чи все працює запустивши, наприклад, SITL:

cd src/PX4-Autopilot    #це <container_src>
make px4_sitl_default gazebo-classic

Повторний вхід в контейнер

Команда docker run використовується тільки для створення нового контейнеру. Щоб повернутися у цей контейнер (що збереже ваші зміни) просто зробіть:

# запуск контейнера
docker start container_name
# запуск нової оболонки bash shell в цьому контейнері
docker exec -it container_name bash

Якщо вам потрібні кілька консолей, підключених до контейнера, просто відкрийте нову оболонку і виконайте останню команду знову.

Видалення контейнера

Іноді може знадобитися взагалі видалити контейнер. Це можна зробити, використовуючи його ім'я:

docker rm mycontainer

Якщо ви не можете згадати назву, ви можете знайти неактивні ідентифікатори контейнерів і видалити їх, як показано нижче:

docker ps -a -q
45eeb98f1dd9
docker rm 45eeb98f1dd9

QGroundControl

При виконанні екземпляра симуляції, напр. SITL всередині контейнерів і керування ним через QGroundControl з основного комп'ютера, канали зв'язку потрібно встановити вручну. Функція автопідключення QGroundControl тут не працює.

В QGroundControl, перейдіть до Налаштувань та оберіть Канали зв'язку. Створіть новий канал, що використовує UDP-протокол. Номер порту залежить від використаних налаштувань, наприклад порт 14570 для конфігурації SITL. IP-адреса є адресою одного з ваших контейнерів, зазвичай це адреса з мережі 172.17.0.1/16 при використанні мережі за замовчуванням. IP-адресу Docker контейнера можна знайти за допомогою наступної команди (якщо припустити, що ім'я контейнера mycontainer):

$ docker inspect -f '{ {range .NetworkSettings.Networks}}{ {.IPAddress}}{ {end}}' mycontainer

::: note Пробіли між подвійними фігурними дужками вище не повинні бути присутніми (вони потрібні, щоб уникнути проблеми з відображенням інтерфейсу користувача в gitbook). :::

Усунення проблем

Помилки з правами доступу

Контейнер створює файли, необхідні для роботи від імені стандартного користувача, як правило, "root". Це може призвести до помилок прав доступу, коли користувач на основному комп'ютері не має доступу до файлів, створених контейнером.

Приклад вище використовує рядок --env=LOCAL_USER_ID="$(id -u)", щоб створити користувача в контейнері з тим же UID що і користувач на основній машині. Це гарантує, що всі файли, створені у контейнері, будуть доступні з основного комп'ютера.

Проблеми з драйверами графіки

Можливо, що запуск Gazebo Classic призведе до подібного повідомлення про помилку:

libGL error: failed to load driver: swrast

У цьому випадку необхідно встановити нативний графічний драйвер для вашої системи. Завантажте відповідний драйвер і встановіть його всередині контейнера. Для драйверів Nvidia слід використовувати наступну команду (інакше встановлювач побачить завантажені модулі на головній машині та відмовиться продовжувати):

./NVIDIA-DRIVER.run -a -N --ui=none --no-kernel-module

Більше інформації можна знайти тут.

Підтримка віртуальних машин

Будь-який останній дистрибутив Linux повинен працювати.

Наступна конфігурація протестована:

• OS X з підтримкою VMWare Fusion і Ubuntu 14.04 (Docker контейнер з підтримкою GUI в Parallels призводить до падіння X-Server).

Оперативна Пам'ять

Потрібно не менше 4 ГБ пам'яті для віртуальної машини.

Проблеми компіляції

Якщо компіляція завершується з помилками на кшталт:

The bug is not reproducible, so it is likely a hardware or OS problem.
c++: internal compiler error: Killed (program cc1plus)

Спробуйте вимкнути паралельну збірку.

Дозволити керувати Docker з основної машини для VM

Змініть /etc/defaults/docker і додайте наступний рядок:

DOCKER_OPTS="${DOCKER_OPTS} -H unix:///var/run/docker.sock -H 0.0.0.0:2375"

Тепер можна керувати docker на вашій основній ОС:

експорт DOCKER_HOST=tcp://<ip of your VM>:2375
# запустіть якусь команду docker щоб подивитися, чи все працює, наприклад, ps
docker ps