3. Docker Setup for ROS 2

3.1. Quick Start Guide

Note

For a quick start, it is recommended to use the pre-built SDK Docker images. In the SDK Docker container, pre-built ROS packages for the Robotics SDK are already installed (under /opt/ros/robotics_sdk_install in the container filesystem).

3.1.1. On the Target

  1. Set up the SDK git repository and the workspace:

    source /opt/edgeai-gst-apps/scripts/install_robotics_sdk.sh
cd ~/j7ros_home
make scripts

  2. Pull and Run the SDK Docker image:

    docker pull ghcr.io/texasinstruments/robotics-sdk:10.1.0-humble-$SOC
docker tag ghcr.io/texasinstruments/robotics-sdk:10.1.0-humble-$SOC robotics-sdk:10.1.0-humble-$SOC
./docker_run.sh

  3. Run the demos by referring to the “Run Demo Applications” section.

3.1.2. On the Visualization PC

  1. Set up the SDK git repository and the workspace:

    wget -O init_setup.sh https://raw.githubusercontent.com/TexasInstruments/edgeai-robotics-sdk/master/init_setup.sh
source ./init_setup.sh
cd ~/j7ros_home
PLATFORM=pc make scripts [GPUS=y]

  2. Pull and Run the Docker image for the visualization PC.

    docker pull ghcr.io/texasinstruments/robotics-sdk:10.1.0-humble-viz
docker tag ghcr.io/texasinstruments/robotics-sdk:10.1.0-humble-viz robotics-sdk:10.1.0-humble-viz
./docker_run.sh

For those interested in building the SDK Docker image and the SDK ROS packages, please refer to the following sections.

3.2. Set Up Docker Environment on the Target

In the ROS 2 Docker container environment, ROS Humble and necessary libraries and tools are installed.

  1. To generate the scripts for building and running a Docker image for ROS 2 Humble:

    root@am6x-sk:~/j7ros_home$ make scripts

    Make sure that two bash scripts, docker_build.sh and docker_run.sh, are generated.

  2. To build the Docker image:

    root@am6x-sk:~/j7ros_home$ ./docker_build.sh

    This step may take some time, depending on the network speed. Once “docker build” is completed, you can check the resulting Docker image with docker images.

  3. To start/run the Docker container:

    root@am6x-sk:~/j7ros_home$ ./docker_run.sh

    It is important to use docker_run.sh script to start a Docker container, as the script includes all the necessary settings to leverage all the cores and hardware accelerators of the TI Processor.

  4. To build the ROS applications, inside the Docker container:

    root@j7-docker:~/j7ros_home/ros_ws$ colcon build --base-paths /opt/robotics_sdk/ros2 --cmake-force-configure

# TDA4VM: In case "colcon build" fails (e.g., due to limited memory), "--executor sequential" option can be added as follows
root@j7-docker:~/j7ros_home/ros_ws$ colcon build --base-paths /opt/robotics_sdk/ros2 --executor sequential --cmake-force-configure

root@j7-docker:~/j7ros_home/ros_ws$ source install/setup.bash

Tip

Docker Run: Please note that docker_run.sh includes --rm argument by default. Just remove the --rm argument in docker_run.sh in case you want to do “docker commit” after exiting a Docker container. A short information about several useful Docker commands is provided in this link.

3.3. Set Up Docker Environment on the Remote PC for Visualization

Note

If your Ubuntu PC (for visualization) uses an Nvidia GPU driver, please ensure that the Nvidia Container Toolkit (“nvidia-docker” or “nvidia-docker2”, depending on Ubuntu distribution) is installed before running docker_run.sh script. Additionally, when generating scripts, make sure to add the argument GPUS=y (see Step 1 below).

You can choose any folder, but init_setup.sh script sets up ${HOME}/j7ros_home as the working directory.

  1. To generate bash scripts for building and running a Docker image for ROS 2 Humble:

    user@pc:~/j7ros_home$ PLATFORM=pc make scripts

    If the Ubuntu PC uses an Nvidia GPU driver, please add one more argument GPUS=y:

    user@pc:~/j7ros_home$ PLATFORM=pc make scripts GPUS=y

    Make sure that two bash scripts, docker_build.sh and docker_run.sh, are generated.

  2. To build the ROS 2 Docker image:

    user@pc:~/j7ros_home$ ./docker_build.sh

    It may take some time building the Docker image. The Docker image built can be listed with docker images.

  3. Run the ROS 2 Docker container:

    user@pc:~/j7ros_home$ ./docker_run.sh

  4. Build the ROS nodes for visualization:

    root@pc-docker:~/j7ros_home/ros_ws$ colcon build --base-paths src/robotics_sdk/ros2
root@pc-docker:~/j7ros_home/ros_ws$ source install/setup.bash

3.4. Run Demo Applications

The table below summarizes the launch commands that you can use in the Docker container for each demo, on the target SK board, and on the remote visualization PC. For more details, see the following subsections.

Launch arguments can be passed to the following launch commands.

Note

Installed Camera ID and subdev ID for cameras: You can check the camera ID (cam_id) and subdev ID (subdev_id) for the camera attached to the SK board by running /opt/edgeai-gst-apps/scripts/setup_cameras.sh. You can use the alias setup_cameras inside the SDK container.

When a new camera is connected to the SK board while you are already inside the SDK container, it is important to run the camera setup command.

  • To specify a camera recognized as /dev/video-{usb,imx219,imx390}-camX and /dev/v4l-{imx219,imx390}-subdevY, use the arguments cam_id:=X and subdev_id:=Y.

  • To specify the serial number of the ZED camera (found in the original box), use the argument zed_sn, which should start with ‘SN’ followed by the serial number.

Note

For your convenience, the SDK Docker container comes pre-configured with a variety of handy aliases. These aliases are specifically designed for building and launching demo applications, as well as for visualization tasks. Details about these aliases can be found in the ~/set_aliases.sh file within the container. Alternatively, you can also refer to the $SDK_DIR/docker/set_aliases.sh file.

Demo (Input Source)

Launch command on Target

Launch command on Remote Visualization PC

Stereo Vision (ROSBAG)

ros2 launch ti_sde bag_sde_launch.py

ros2 launch ti_viz_nodes rviz_sde_launch.py

Stereo Vision (ZED camera)

ros2 launch ti_sde zed_sde_launch.py cam_id:=X zed_sn:=SNxxxxx

same as above

Stereo Vision with point-cloud (ROSBAG)

ros2 launch ti_sde bag_sde_pcl_launch.py

ros2 launch ti_viz_nodes rviz_sde_pcl_launch.py

Stereo Vision with point-cloud (ZED camera)

ros2 launch ti_sde zed_sde_pcl_launch.py cam_id:=X zed_sn:=SNxxxxx

same as above

Semantic Segmentation CNN (ROSBAG)

ros2 launch ti_vision_cnn bag_semseg_cnn_launch.py

ros2 launch ti_viz_nodes rviz_semseg_cnn_launch.py

Semantic Segmentation CNN (ZED camera)

ros2 launch ti_vision_cnn zed_semseg_cnn_launch.py cam_id:=X zed_sn:=SNxxxxx

same as above

Semantic Segmentation CNN (Mono camera)

ros2 launch ti_vision_cnn gscam_semseg_cnn_launch.py cam_id:=X

same as above

Semantic Segmentation CNN (IMX219 camera)

ros2 launch ti_vision_cnn gscam_semseg_cnn_imx219_launch.py cam_id:=X subdev_id:=Y

same as above

Semantic Segmentation CNN (IMX390 camera)

ros2 launch ti_vision_cnn gscam_semseg_cnn_imx390_launch.py cam_id:=X subdev_id:=Y

same as above

Object Detection CNN (ROSBAG)

ros2 launch ti_vision_cnn bag_objdet_cnn_launch.py

ros2 launch ti_viz_nodes rviz_objdet_cnn_launch.py

Object Detection CNN (ZED camera)

ros2 launch ti_vision_cnn zed_objdet_cnn_launch.py cam_id:=X zed_sn:=SNxxxxx

same as above

Object Detection CNN (Mono camera)

ros2 launch ti_vision_cnn gscam_objdet_cnn_launch.py cam_id:=X

same as above

Object Detection CNN (IMX219 camera)

ros2 launch ti_vision_cnn gscam_objdet_cnn_imx219_launch.py cam_id:=X subdev_id:=Y

same as above

Object Detection CNN (IMX390 camera)

ros2 launch ti_vision_cnn gscam_objdet_cnn_imx390_launch.py cam_id:=X subdev_id:=Y

same as above

6D Pose Estimation CNN (ROSBAG)

ros2 launch ti_vision_cnn bag_6dpose_cnn_launch.py

ros2 launch ti_viz_nodes rviz_6dpose_cnn_launch.py width:=1280 height:=960

Human Pose Estimation CNN (ROSBAG)

ros2 launch ti_vision_cnn bag_humanpose_cnn_launch.py

ros2 launch ti_viz_nodes rviz_humanpose_cnn_launch.py

Human Pose Estimation CNN (Mono camera)

ros2 launch ti_vision_cnn gscam_humanpose_cnn_launch.py cam_id:=X

same as above

3D Obstacle Detection (ROSBAG)

ros2 launch ti_estop bag_estop_launch.py

ros2 launch ti_viz_nodes rviz_estop_launch.py

3D Obstacle Detection (ZED camera)

ros2 launch ti_estop zed_estop_launch.py cam_id:=X zed_sn:=SNxxxxx

same as above

Object Detection with 3D Spatial Information (ROSBAG)

ros2 launch ti_objdet_range bag_objdet_range_launch.py

ros2 launch ti_viz_nodes rviz_objdet_range_launch.py

Object Detection with 3D Spatial Information (ZED camera)

ros2 launch ti_objdet_range zed_objdet_range_launch.py cam_id:=X zed_sn:=SNxxxxx

same as above

Visual Localization (ROSBAG)*

ros2 launch ti_vl bag_visloc_launch.py

ros2 launch ti_viz_nodes rviz_visloc_launch.py

Camera + Radar Fusion (ROSBAG)

ros2 launch ti_objdet_radar bag_objdet_radar_launch.py

ros2 launch ti_viz_nodes rviz_objdet_radar_launch.py

Camera + Radar Fusion (IMX219, IWR6843)

ros2 launch ti_objdet_radar gscam_mmwave_objdet_radar_launch.py cam_id:=X

same as above

* Visual location is supported only on TDA4VM, AM68A, and AM69A.

Tip

You can use TMUX inside the ROS Docker container to split the current terminal window into multiple panes. Below are some useful basic keys for using TMUX. You can find a full list of keys here.

  • tmux: Start a tmux session.

  • Ctrl + b, followed by ": Split pane vertically.

  • Ctrl + b, followed by ↑ or ↓: Switch to the pane in the respective direction.

  • Ctrl + b, followed by x: Close the current pane.

3.5. DDS Implementation Options

In the ROS 2 Docker images both for the target SK board and Ubuntu PC, two popular DDS implementations are installed by default:

  • eProsima Fast DDS (default DDS for ROS 2 Humble)

  • Eclipse Cyclone DDS (additionally installed)

To ensure smooth running of the out-of-box demos, the following DDS selections are made in the ROS 2 Docker containers by default on each platform.

Platform

DDS Choice

Note

Target SK board

Eclipse Cyclone DDS

Provides better performance, especially with “rosbag play”

Visualization PC

eProsima Fast DDS

Provides better Ctrl+C response

You can switch the DDS implementation in each launch session by setting the environment variable RMW_IMPLEMENTATION. For example,

To use the eProsima Fast DDS,

RMW_IMPLEMENTATION=rmw_fastrtps_cpp ros2 ...

To use the Eclipse Cyclone DDS,

RMW_IMPLEMENTATION=rmw_cyclonedds_cpp ros2 ...