Difference between revisions of "Advantech Robotic Suite/Container"

From ESS-WIKI
Jump to: navigation, search
 
(23 intermediate revisions by one other user not shown)
Line 18: Line 18:
 
 
 
 
  
<span style="font-size:1.3em;">'''List of Advantech Robotic Suite Container:'''</span>
+
<span style="font-size:1.3em;">'''List of Advantech Robotic Suite Containers:'''</span>
  
{| border="1" cellpadding="1" cellspacing="1" data-endline="54" data-startline="40" style="width: auto;"
+
{| border="1" cellpadding="1" cellspacing="1" data-endline="54" data-startline="40" style="width: 100%;"
 
|-
 
|-
! style="width: 200px;" | Docker Container
+
! style="width: 15%;" | Docker Container
! style="width: auto;" | Content
+
! style="width: 65%;" | Content
! style="width: auto;" | Note
+
! style="width: 20%;" | Note
 
|-
 
|-
| style="width: 200px; text-align: center;" | edge-ros2-foxy
+
| style="padding: 5px; text-align: center;" | [[Advantech_Robotic_Suite/Container/Develop_ROS_Container|dev-ros2-foxy]]
| style="width: auto;" | Advantech add-ons services includes [[Advantech_Robotic_Suite/SUSI_Node|SUSI Node]], [[Advantech_Robotic_Suite/Modbus-Master_Node|Modbus-Master Node]], [[Advantech_Robotic_Suite/OPCUAClient_Node|OPCUAClient Node]] and<br/> [[Advantech_Robotic_Suite/ROS2_DBMS|ROS2 bag database]] based on ROS2 Foxy.&nbsp;
+
| style="padding: 5px;" | This container provides a pre-configured ROS2 Foxy environment along with examples for subscribing to and controlling ros2 nodes in '''edge-ros2-foxy'''.
| style="width: auto;" | &nbsp;
+
| style="padding: 5px;" | Request: <ul style="margin: 0; padding-left: 15px;">
 +
<li>Advantech Robotic Suite 1.3.0 or higher</li>
 +
<li>x86 architecture only</li>
 +
</ul>
 +
 
 
|-
 
|-
| style="width: 200px; text-align: center;" | dev-ros2-foxy
+
| style="padding: 5px; text-align: center;" | [[Advantech_Robotic_Suite/Container/Develop_ROS_Container|dev-ros2-humble]]
| style="width: auto;" | This container provides a pre-configured ROS2 Foxy environment along with examples<br/> for subscribing to and controlling ros2 nodes in '''edge-ros2-foxy'''.
+
| style="padding: 5px;" | This container provides a pre-configured ROS2 Humble environment along with examples for subscribing to and controlling ros2 nodes in '''edge-ros2-foxy'''.
| style="width: auto;" | Only supported in Advantech Robotic Suite v1.3.0 or higher on x86.
+
| style="padding: 5px;" | Request: <ul style="margin: 0; padding-left: 15px;">
|}
+
<li>Advantech Robotic Suite 1.5.0 or higher</li>
 +
<li>x86 architecture only</li>
 +
</ul>
  
 +
|-
 +
| style="padding: 5px; text-align: center;" | [[Advantech_Robotic_Suite/Container/Utility_ROS_Container|util-ros2-humble]]
 +
| style="padding: 5px;" | This container is a ready-to-use ROS2 toolkit with rviz, rqt, cartographer, nav2, and moveit. It's great for building robots quickly.
 +
| style="padding: 5px;" | Request: <ul style="margin: 0; padding-left: 15px;">
 +
<li>Advantech Robotic Suite 1.5.0 or higher</li>
 +
<li>x86 architecture only</li>
 +
</ul>
  
= Develop ROS Container =
+
|}
  
Develop ROS container image that assists developers in building its own ROS containerized applications.
+
<!--
 +
<span style="font-size:1.3em;">'''List of Advantech Robotic Suite Extension Containers:'''</span>
  
== How To ==
+
{| border="1" cellpadding="1" cellspacing="1" data-endline="54" data-startline="40" style="width: 100%;"
 
+
|-
=== Start docker container ===
+
! style="width: 15%;" | Docker Container
 
+
! style="width: 65%;" | Content
'''Step1: Launch the docker container of dev-ros2-foxy'''
+
! style="width: 20%;" | Note
<syntaxhighlight lang="bash">
+
|-
$ cd /usr/local/Advantech/ros/container/docker
+
| style="padding: 5px; text-align: center;" | [[Advantech Robotic Suite/Container/usbcam ROS Container|usbcam-ros2-humble]]
$ ./launch.sh dev-ros2-foxy
+
| style="padding: 5px;" | This container includes a pre-configured ROS node for USB cameras, allowing easy integration of video streams into ROS2 as messages.
</syntaxhighlight>
+
| style="padding: 5px;" | Request:<ul style="margin: 0; padding-left: 15px;">
 
+
<li>Advantech Robotic Suite 1.5.0 or higher</li>
'''Step2: Accessing the container for development and debugging'''
+
<li>x86 architecture only</li>
<syntaxhighlight lang="bash">
+
</ul>
$ docker exec -it dev-ros2-foxy bash
+
|-
</syntaxhighlight>
+
| style="padding: 5px; text-align: center;" | [[Advantech Robotic Suite/Container/realsense ROS Container|realsense-ros2-humble]]
 
+
| style="padding: 5px;" | This container provides a ready-to-use ROS node for Intel RealSense cameras, simplifying the conversion of depth, color, and point cloud data into ROS2 messages.
&nbsp;
+
| style="padding: 5px;" | Request:<ul style="margin: 0; padding-left: 15px;">
 
+
<li>Advantech Robotic Suite 1.5.0 or higher</li>
=== Examples ===
+
<li>x86 architecture only</li>
 
+
</ul>
Examples demonstration&nbsp;on how to subscribe to and control services of other ROS2 nodes.
+
|-
 
+
| style="padding: 5px; text-align: center;" | [[Advantech Robotic Suite/Container/Openvino Object Detection ROS Container|openvino_object_detection-ros2-humble]]
*'''[[Advantech_Robotic_Suite/Sample_Node#c.2B.2B_sample|C++ sample]]'''
+
| style="padding: 5px;" | This container demonstrates Intel OpenVINO's object detection in ROS2, enabling real-time detection using image topics or physical cameras, making it suitable for computer vision applications.
*'''[[Advantech_Robotic_Suite/Sample_Node#rclnodejs_sample|rclnodejs sample]]'''
+
| style="padding: 5px;" | Request:<ul style="margin: 0; padding-left: 15px;">
*'''[[Advantech_Robotic_Suite/Sample_Node#rclpy_sample|rclpy sample]]'''
+
<li>Advantech Robotic Suite 1.5.0 or higher</li>
*'''[[Advantech_Robotic_Suite/SUSI_Node|SUSI Node]]'''
+
<li>x86 architecture only</li>
*'''[[Advantech_Robotic_Suite/Modbus-Master_Node|Modbus-Master Node]]'''
+
</ul>
*'''[[Advantech_Robotic_Suite/OPCUAClient_Node|OPCUAClient Node]]'''<br/> &nbsp;
+
|}
 
+
-->
=== Stop docker container ===
 
 
 
<syntaxhighlight lang="bash">
 
$ cd /usr/local/Advantech/ros/container/docker
 
$ ./stop.sh dev-ros2-foxy
 
</syntaxhighlight>
 
 
 
&nbsp;
 
 
 
== Build Your Docker Container ==
 
 
 
To build a Docker container for your ROS2 application and integrate Advantech's add-ons services, you can following the steps.
 
 
 
=== Step1: Define a Dockerfile ===
 
 
 
Create a file called "Dockerfile" that specifies the instructions for building the container based on '''dev-ros2-foxy'''. This file includes details such as the base image, dependencies, environment variables, and commands to run inside the container.
 
<pre>FROM advigw/dev-ros2-foxy:1.0.0
 
 
 
# 1. Copy prerequisites of your application into the container
 
# WORKDIR /root
 
# COPY prerequisite/<your_application> /root/prerequisite
 
 
 
# 2. Install dependencies or libraries
 
# RUN apt-get update
 
# RUN apt-get install <some_dependency>
 
 
 
# 3. Execute your application automatically upon container startup.
 
# CMD [<application_command>]
 
</pre>
 
 
 
=== Step2: Build the Docker image ===
 
 
 
Use the Docker command-line to build the Docker image based on the Dockerfile. This process involves pulling the necessary base image, executing the instructions in the Dockerfile, and creating a layered image with all the specified components.
 
<syntaxhighlight lang="bash">
 
$ docker build -t ros-example -f Dockerfile .
 
</syntaxhighlight>
 
 
 
=== Step3: Define the Docker Compose services ===
 
 
 
Create a file called "docker-compose.yml", in the Docker Compose file, define the services, their image references, and any necessary configurations such as environment variables, port mappings, volume bindings, etc. Use the syntax provided by Docker Compose to define each service.
 
<pre>version: '2.0'
 
 
 
services:
 
  ros-example:
 
    image: ros-example
 
    container_name: ros-example
 
    restart: always
 
    networks:
 
    - adv-ros-network
 
    logging:
 
      options:
 
      max-size: 10M
 
    environment:
 
    - ROS_DOMAIN_ID=${ROS_DOMAIN_ID}
 
 
 
networks:
 
  adv-ros-network:
 
    name: adv-ros-network
 
</pre>
 
 
 
=== Step4: Start the containers using Docker Compose ===
 
 
 
Execute the docker-compose up command in the directory where the Docker Compose file is located. This command will start the containers as defined in the Compose file.<br/> <span style="color:red;">Note: When using the docker-compose command, please avoid using 'sudo' if you need to use the ROS_DOMAIN_ID environment variable. Otherwise, the variable may not be found during execution.</span>
 
<syntaxhighlight lang="bash">
 
$ docker-compose -f docker-compose.yml up -d
 
</syntaxhighlight>
 
 
 
=== Step5: Test and validate ===
 
 
 
Open a new interactive bash shell within the container.
 
<syntaxhighlight lang="bash">
 
$ docker exec -it ros-example bash
 
</syntaxhighlight>
 
 
 
Then test [[#Examples|ROS2 Example]] and your applications in container.
 

Latest revision as of 02:07, 18 September 2025

Introduction

  ROS applications may rely on specific ROS distribution, software versions, libraries, and configurations. Using containers ensures consistent application behavior across different environments, as the container encapsulates the required dependencies and environment settings, independent of the host system.
Advantech Robotic Suite offers Docker Container framework for simplifies the development, deployment, and management of ROS systems.

 

Advantech Robotic Suite container framework provides the following benefits:

  • Portability: Containers are portable units that can run on different systems and platforms, be it in development, testing, or production environments. This makes it easier to deploy and share ROS applications across different machines and environments.
  • Isolation: Containers provide an isolated environment, separating ROS applications from the host system and other containers. This helps prevent conflicts and interference between different applications, enhancing system stability and reliability.
  • Reproducibility: Containers ensure that the runtime environment of an application remains consistent across different deployments and executions, ensuring reproducibility. This is valuable for developers, testers, and operators, as they can reproduce and debug issues in different environments.
  • Scalability: Container technology offers scalability, allowing for quick replication and scaling of container instances based on demand. This makes it easier to add new nodes, services, or topics to the ROS system and dynamically adjust the number of containers based on the workload.

 

List of Advantech Robotic Suite Containers:

Docker Container Content Note
dev-ros2-foxy This container provides a pre-configured ROS2 Foxy environment along with examples for subscribing to and controlling ros2 nodes in edge-ros2-foxy. Request:
  • Advantech Robotic Suite 1.3.0 or higher
  • x86 architecture only
dev-ros2-humble This container provides a pre-configured ROS2 Humble environment along with examples for subscribing to and controlling ros2 nodes in edge-ros2-foxy. Request:
  • Advantech Robotic Suite 1.5.0 or higher
  • x86 architecture only
util-ros2-humble This container is a ready-to-use ROS2 toolkit with rviz, rqt, cartographer, nav2, and moveit. It's great for building robots quickly. Request:
  • Advantech Robotic Suite 1.5.0 or higher
  • x86 architecture only