Composition

在運行Robot時，有時需要一些簡單的程式幫我們做一些簡單的pipeline工作，像是影像濾波器處理完後丟給影像壓縮的流水線，但如果分成不同Node跑在不同thread上時，在傳遞資料時會有一些額外的開銷，所以ROS提供了一個機制叫做Nodelet，可以將多個小Node跑在同一個thread中避免不必要的訊息複製。這個機制可以想像是一個生產線，可以慢慢的把不同的工具和工法加進去輸送帶，去精修或微調產線。

而ROS中運行程式主要靠兩個單位:

1. Node，會經由catkin build變成一個可執行的binary檔案
2. Nodelet，在編譯之後會變成一個library檔案，會在runtime時被容器(Nodelet Manager)呼叫。

在ROS2中這種機制則叫做Composistion，用來管理多個小任務(component)。Nodelet改名成Component，而Nodelet Manager改名成Component Container，整體的概念是一樣的。其中改善了ROS的一些缺點，像是Node和Component可以共用API。

雖然Nodelet和Component都有提供多執行序的功能，但僅適合對順序不敏感的工作，例如Pointcloud的passthrough filter會拆成x-y-z分開過濾，順序不影響最後結果的話就可以用多執行序。如果想確保訊息的傳遞順序，例如影像處理要先降噪再做特徵點偵測，則要使用單執行緒的方式。

撰寫Component

因為Component是shared library，他不會有main function，而其通常繼承自rclcpp::Node，所以我們可以在constructor中撰寫我們的程式。另外要注意的點是，Component是強制單執行緒的，所以要盡量簡化處理的工作，也不要使用Blocking的工作造成程式卡頓。

這邊我們參照官方給的Talker Component範例。

...
#include "rclcpp_components/register_node_macro.hpp"

RCLCPP_COMPONENTS_REGISTER_NODE(composition::Talker)

可以看到是沒有main，還有底下的RCLCPP_COMPONENTS_REGISTER_NODE，這是用來註冊Component的，讓ROS2知道這個library是一個Component。

而CMakeLists.txt可以參考範例，有幾個必要加入的項目:

find_package(rclcpp_components REQUIRED)

add_library(talker_component SHARED
  src/talker_component.cpp)
ament_target_dependencies(talker_component
  "rclcpp"
  "rclcpp_components"
  "std_msgs")
rclcpp_components_register_nodes(talker_component "composition::Talker")

範例上有額外的target_compile_definitions(talker_component PRIVATE "COMPOSITION_BUILDING_DLL")是給Windows Compile用的。set(node_plugins則是build test時用來管理file structure的。

在ROS2中要把component轉換成node變得非常簡單，只要寫一個簡單的node:

#include <rclcpp/rclcpp.hpp>

#include <memory>

#include "composition/talker_component.hpp"

int main(int argc, char ** argv)
{
  // Force flush of the stdout buffer.
  setvbuf(stdout, nullptr, _IONBF, BUFSIZ);

  rclcpp::init(argc, argv);

  rclcpp::spin(
    std::make_shared<composition::TalkerComponent>(
      rclcpp::NodeOptions()));

  rclcpp::shutdown();

  return 0;
}

接著在CMakeLists.txt中加入:

add_executable(talker_node src/driver/talker_node.cpp)
ament_target_dependencies(talker_node
  rclcpp
)
target_link_libraries(talker_node talker_component)

這樣就可以把component轉換成node了，當然component也還是可以直接被container呼叫。

執行

Component其實是個大坑，真的要介紹的話至少要兩到三篇。礙於篇幅和自己也不太熟悉手刻container，這邊直接給出範例的執行方式，對於其他細節有興趣的可以參考官方的教學。

1. 首先去下載demos/composition範例package:

   cd ~/Downloads
   git clone -b foxy https://github.com/ros2/demos.git
   cp -r demos/composition ~/ros2_ws/src
   

2. colcon編譯:

   cd ~/ros2_ws
   colcon build --packages-select composition
   source install/setup.bash
   

3. 查看component的list:

   ros2 component types
   # 可以看到所有可以用的component
   (... components of other packages here)
   composition
   composition::Talker
   composition::Listener
   composition::Server
   composition::Client
   

4. 使用ROS2的Services讓Composition跑起來

   ros2 run rclcpp_components component_container
   

   這邊component_container是官方提供的container，是用Single Thread的方式運行component。
   開啟另一個terminal，檢查component container是否運行成功:

   ros2 component list
   # 可以看到component的名稱
   /ComponentManager
   

5. 在第二個terminal中載入talker component:

   ros2 component load /ComponentManager composition composition::Talker
   # 可以看到載入的component ID和node名稱
   Loaded component 1 into '/ComponentManager' container node as '/talker'
   

   此時第一個terminal會顯示talker node發布的訊息。

6. 接著開啟第三個terminal來載入listener component:

   ros2 component load /ComponentManager composition composition::Listener
   # 可以看到載入的component ID和node名稱
   Loaded component 2 into '/ComponentManager' container node as '/listener'
   

   此時第一個terminal會顯示talker和listener node的訊息。

7. 查看container中的component:

   ros2 component list
   # 可以看到載入的component ID和node名稱
   /ComponentManager
       1  /talker
       2  /listener
   

用launch來執行

上面的步驟會需要開很多個terminal，但常常composition是用來做一些pipeline的工作，所以我們可以用launch來幫我們一次執行多個component。
可以到ros2_ws/src/composition/launch中看到官方提供的範例，這邊我們來看看composition_demo.launch.py:

import launch
from launch_ros.actions import ComposableNodeContainer
from launch_ros.descriptions import ComposableNode


def generate_launch_description():
    """Generate launch description with multiple components."""
    container = ComposableNodeContainer(
            name='my_container',
            namespace='',
            package='rclcpp_components',
            executable='component_container',
            composable_node_descriptions=[
                ComposableNode(
                    package='composition',
                    plugin='composition::Talker',
                    name='talker'),
                ComposableNode(
                    package='composition',
                    plugin='composition::Listener',
                    name='listener')
            ],
            output='screen',
    )

    return launch.LaunchDescription([container])

ComposableNodeContainer是用來呼叫container。接著可以看到他的composable_node_descriptions是一個list，可以載入多個components，這邊我們載入了talker和listener component。最後回傳一個launch.LaunchDescription物件。

接著我們來執行:

ros2 launch composition composition_demo.launch.py

這樣一行就可以達成我們剛剛用三個terminal做的事情。

ROS nodelet vs. ROS2 component

Reference

• About Composition
• Composing multiple nodes in a single process
• ROS2 demos
• ROS nodelet