2023-03-07 14:42:53 -04:00
# ArduPilot ROS 2 packages
2024-07-30 22:08:58 -03:00
This directory contains ROS 2 packages and configuration files for running
ROS 2 processes and nodes that communicate with the ArduPilot DDS client
library using the microROS agent. It contains the following packages:
2023-03-07 14:42:53 -04:00
#### `ardupilot_sitl`
2024-07-30 22:08:58 -03:00
This is a `colcon` package for building and running ArduPilot SITL using the ROS 2 CLI.
2023-03-07 14:42:53 -04:00
For example `ardurover` SITL may be launched with:
```bash
ros2 launch ardupilot_sitl sitl.launch.py command:=ardurover model:=rover
```
2024-05-07 12:46:20 -03:00
Other launch files are included with many arguments.
Some common arguments are exposed and forwarded to the underlying process.
For example, MAVProxy can be launched, and you can enable the `console` and `map` .
```bash
ros2 launch ardupilot_sitl sitl_mavproxy.launch.py map:=True console:=True
```
2024-07-30 22:08:58 -03:00
ArduPilot SITL does not yet expose all arguments from the underlying binary.
See [#27714 ](https://github.com/ArduPilot/ardupilot/issues/27714 ) for context.
To see all current options, use the `-s` argument:
```bash
ros2 launch ardupilot_sitl sitl.launch.py -s
```
2024-10-20 21:42:39 -03:00
#### `ardupilot_dds_tests`
2023-03-07 14:42:53 -04:00
A `colcon` package for testing communication between `micro_ros_agent` and the
ArduPilot `AP_DDS` client library.
## Prerequisites
The packages depend on:
- [ROS 2 Humble ](https://docs.ros.org/en/humble/Installation/Ubuntu-Install-Debians.html )
## Install Ubuntu
#### 1. Create a workspace folder
```bash
2024-06-21 02:57:31 -03:00
mkdir -p ~/ros2_ws/src & & cd ~/ros2_ws/src
2023-03-07 14:42:53 -04:00
```
The ROS 2 tutorials contain more details regarding [ROS 2 workspaces ](https://docs.ros.org/en/humble/Tutorials/Workspace/Creating-A-Workspace.html ).
#### 2. Get the `ros2.repos` file
```bash
cd ~/ros2_ws/src
2023-04-22 12:26:16 -03:00
wget https://raw.githubusercontent.com/ArduPilot/ardupilot/master/Tools/ros2/ros2.repos
2023-03-07 14:42:53 -04:00
vcs import --recursive < ros2.repos
```
#### 3. Update dependencies
```bash
2024-06-21 02:57:31 -03:00
cd ~/ros2_ws
2023-03-07 14:42:53 -04:00
source /opt/ros/humble/setup.bash
sudo apt update
rosdep update
2023-04-22 12:26:16 -03:00
rosdep install --rosdistro ${ROS_DISTRO} --from-paths src
2023-03-07 14:42:53 -04:00
```
#### 4. Build
2023-04-22 12:26:16 -03:00
Check that the [ROS environment ](https://docs.ros.org/en/humble/Tutorials/Beginner-CLI-Tools/Configuring-ROS2-Environment.html#check-environment-variables ) is configured correctly:
```bash
ROS_VERSION=2
ROS_PYTHON_VERSION=3
ROS_DISTRO=humble
```
2023-03-07 14:42:53 -04:00
```bash
2024-06-21 02:57:31 -03:00
cd ~/ros2_ws
2023-04-22 12:26:16 -03:00
colcon build --cmake-args -DBUILD_TESTING=ON
2023-03-07 14:42:53 -04:00
```
#### 5. Test
```bash
source ./install/setup.bash
2023-04-22 12:26:16 -03:00
colcon test --packages-select ardupilot_dds_tests
2023-03-07 14:42:53 -04:00
colcon test-result --all --verbose
```
2023-11-26 12:48:36 -04:00
To debug a specific test, you can do the following:
```
colcon --log-level DEBUG test --packages-select ardupilot_dds_tests --event-handlers=console_direct+ --pytest-args -k test_dds_udp_geopose_msg_recv -s
```
2023-03-07 14:42:53 -04:00
## Install macOS
The install procedure on macOS is similar, except that all dependencies
must be built from source and additional compiler flags are needed.
#### 1. Create a workspace folder
```bash
2024-06-21 02:57:31 -03:00
mkdir -p ~/ros2_ws/src & & cd ~/ros2_ws/src
2023-03-07 14:42:53 -04:00
```
2023-04-22 12:26:16 -03:00
#### 2. Get the `ros2_macos.repos` file
2023-03-07 14:42:53 -04:00
The `ros2_macos.repos` includes additional dependencies to build:
```bash
cd ~/ros2_ws/src
2023-04-22 12:26:16 -03:00
wget https://raw.githubusercontent.com/ArduPilot/ardupilot/master/Tools/ros2/ros2_macos.repos
2023-03-07 14:42:53 -04:00
vcs import --recursive < ros2_macos.repos
```
#### 3. Update dependencies
```bash
2024-06-21 02:57:31 -03:00
cd ~/ros2_ws
2023-04-22 12:26:16 -03:00
source /{path_to_your_ros_distro_workspace}/install/setup.zsh
2023-03-07 14:42:53 -04:00
```
#### 4.1. Build microxrcedds_gen:
```bash
cd ~/ros2_ws/src/microxrcedds_gen
./gradlew assemble
export PATH=$PATH:$(pwd)/scripts
```
#### 4.2. Build colcon projects
```bash
colcon build --symlink-install --cmake-args \
-DBUILD_TESTING=ON \
-DCMAKE_BUILD_TYPE=RelWithDebInfo \
-DCMAKE_MACOSX_RPATH=FALSE \
-DUAGENT_SOCKETCAN_PROFILE=OFF \
-DUAGENT_LOGGER_PROFILE=OFF \
-DUAGENT_USE_SYSTEM_LOGGER=OFF \
-DUAGENT_USE_SYSTEM_FASTDDS=ON \
-DUAGENT_USE_SYSTEM_FASTCDR=ON \
2023-04-22 12:26:16 -03:00
--event-handlers=desktop_notification-
2023-03-07 14:42:53 -04:00
```
#### 5. Test
```bash
colcon test \
--pytest-args -s -v \
--event-handlers console_cohesion+ desktop_notification- \
--packages-select ardupilot_dds_tests
```
## Install Docker
#### 0. Build the image and run the container
Clone the ArduPilot docker project:
```bash
git clone https://github.com/ArduPilot/ardupilot_dev_docker.git
```
Build the container:
```bash
cd ~/ardupilot_dev_docker/docker
docker build -t ardupilot/ardupilot-dev-ros -f Dockerfile_dev-ros .
```
Start the container in interactive mode:
```bash
docker run -it --name ardupilot-dds ardupilot/ardupilot-dev-ros
```
Connect another bash process to the running container:
```bash
docker container exec -it ardupilot-dds /bin/bash
```
The remaining steps 1 - 5 are the same as for Ubuntu. You may need to
install MAVProxy if it is not available on the container.
```bash
pip install -U MAVProxy
```
## Test details
The launch file replicates the following commands:
```bash
socat -d -d pty,raw,echo=0,link=./dev/ttyROS0 pty,raw,echo=0,link=./dev/ttyROS1
```
```bash
2024-05-23 12:27:59 -03:00
ros2 run micro_ros_agent micro_ros_agent serial --baudrate 115200 --dev ./dev/ttyROS0
2023-03-07 14:42:53 -04:00
```
```bash
2023-12-11 14:52:03 -04:00
arducopter --synthetic-clock --wipe --model quad --speedup 1 --slave 0 --instance 0 --serial1 uart:./dev/ttyROS1 --defaults $(ros2 pkg prefix ardupilot_sitl)/share/ardupilot_sitl/config/default_params/copter.parm,$(ros2 pkg prefix ardupilot_sitl)/share/ardupilot_sitl/config/default_params/dds_serial.parm --sim-address 127.0.0.1
2023-03-07 14:42:53 -04:00
```
```bash
mavproxy.py --out 127.0.0.1:14550 --out 127.0.0.1:14551 --master tcp:127.0.0.1:5760 --sitl 127.0.0.1:5501
```
Using individual launch files
```bash
ros2 launch ardupilot_sitl virtual_ports.launch.py tty0:=./dev/ttyROS0 tty1:=./dev/ttyROS1
```
```bash
2024-05-23 12:27:59 -03:00
ros2 launch ardupilot_sitl micro_ros_agent.launch.py transport:=serial baudrate:=115200 device:=./dev/ttyROS0
2023-03-07 14:42:53 -04:00
```
```bash
2023-12-11 14:52:03 -04:00
ros2 launch ardupilot_sitl sitl.launch.py synthetic_clock:=True wipe:=True model:=quad speedup:=1 slave:=0 instance:=0 serial1:=uart:./dev/ttyROS1 defaults:=$(ros2 pkg prefix ardupilot_sitl)/share/ardupilot_sitl/config/default_params/copter.parm,$(ros2 pkg prefix ardupilot_sitl)/share/ardupilot_sitl/config/default_params/dds_serial.parm sim_address:=127.0.0.1
2023-03-07 14:42:53 -04:00
```
```bash
ros2 launch ardupilot_sitl mavproxy.launch.py master:=tcp:127.0.0.1:5760 sitl:=127.0.0.1:5501
```
Using combined launch file
```bash
2023-03-07 14:42:53 -04:00
ros2 launch ardupilot_sitl sitl_dds_serial.launch.py \
2023-03-07 14:42:53 -04:00
\
tty0:=./dev/ttyROS0 \
tty1:=./dev/ttyROS1 \
\
2023-03-07 14:42:53 -04:00
transport:=serial \
2023-03-07 14:42:53 -04:00
baudrate:=115200 \
device:=./dev/ttyROS0 \
\
synthetic_clock:=True \
wipe:=True \
model:=quad \
speedup:=1 \
slave:=0 \
instance:=0 \
2023-12-11 14:52:03 -04:00
serial1:=uart:./dev/ttyROS1 \
2023-03-07 14:42:53 -04:00
defaults:=$(ros2 pkg prefix ardupilot_sitl)/share/ardupilot_sitl/config/default_params/copter.parm,$(ros2 pkg prefix ardupilot_sitl)/share/ardupilot_sitl/config/default_params/dds_serial.parm \
2023-03-07 14:42:53 -04:00
sim_address:=127.0.0.1 \
\
master:=tcp:127.0.0.1:5760 \
sitl:=127.0.0.1:5501
```
2023-03-07 14:42:53 -04:00
UDP version
```
2024-05-23 12:27:59 -03:00
ros2 launch ardupilot_sitl sitl_dds_udp.launch.py transport:=udp4 synthetic_clock:=True wipe:=False model:=quad speedup:=1 slave:=0 instance:=0 defaults:=$(ros2 pkg prefix ardupilot_sitl)/share/ardupilot_sitl/config/default_params/copter.parm,$(ros2 pkg prefix ardupilot_sitl)/share/ardupilot_sitl/config/default_params/dds_udp.parm sim_address:=127.0.0.1 master:=tcp:127.0.0.1:5760 sitl:=127.0.0.1:5501
2023-03-07 14:42:53 -04:00
```