ROS2 공부 - colcon

colcon은 ROS 2의 빌드 시스템 중 하나입니다. ROS 2는 CMake 기반 빌드 시스템을 사용하며, colcon은 CMake를 기반으로한 ROS 2 패키지의 빌드, 테스트, 패키징 및 설치를 자동화하는 빌드 도구입니다. colcon은 ROS 2 Galactic 이상 버전에서 사용 가능합니다.

colcon은 다음과 같은 기능을 제공합니다.

 

1. 빌드 : CMake 기반의 ROS2 패키지를 빌드할 수 있따. 또한, 다중 패키지 빌드, 특정 패키지 빌드, 일부 빌드 스텝만 실행하는 등의 유연한 빌드 옵션을 제공한다.

2. 테스트 : 패키지의 유닛 테스트 및 안티그레이션 테스트를 실행할 수 있다.

3. 패키징 : 빌드된 패키지를 ROS2 패키지 포맷으로 패키징할 수 있다.

4. 설치 : 빌드된 패키지를 로컬 또는 시스템 전역으로 설치할 수 있다.

 

colcon의 사용방법은 다음과 같습니다. 

 

1. 새로운 ROS 2 패키지 생성: 

colcon create <package_name>

2. ROS2 패키지 빌드: 

colcon build

3. 특정 ROS2 패키지 빌드: 

colcon build --packages-select <package_name>

4. 특정 빌드 타겟만 빌드:

colcon build --packages-select <package_name> --targets-select <target_name>

5. 패키지 빌드 후, 테스트 실행:

colcon test

6. 패키지 빌드 후, 설치: 

colcon install

• colcon은 다양한 환경에서 ROS 2 패키지를 빌드할 수 있으며, 다중 빌드, 디버그 빌드, 속도 최적화 빌드 등의 빌드 옵션을 지원합니다.
• 또한, catkin 빌드 시스템과 호환성을 유지하면서도 colcon은 catkin 빌드 시스템의 한계를 극복할 수 있는 기능을 제공합니다.
• 따라서, colcon은 ROS 2 패키지 개발 및 배포에 필수적인 도구 중 하나입니다.colcon은 다양한 환경에서 ROS 2 패키지를 빌드할 수 있으며, 다중 빌드, 디버그 빌드, 속도 최적화 빌드 등의 빌드 옵션을 지원합니다.
• 또한, catkin 빌드 시스템과 호환성을 유지하면서도 colcon은 catkin 빌드 시스템의 한계를 극복할 수 있는 기능을 제공합니다. 따라서, colcon은 ROS 2 패키지 개발 및 배포에 필수적인 도구 중 하나입니다.

Source an Underlay 

• ROS 2 패키지를 빌드하기 위해서는 해당 패키지가 의존하는 라이브러리나 패키지들이 먼저 설치되어 있어야 합니다. 이러한 라이브러리나 패키지들은 ROS 2 설치 시 함께 설치되며, 환경 변수를 통해 ROS 2 설치 경로를 지정하여 사용할 수 있습니다.
• 하지만, 만약 새로운 ROS 2 패키지를 개발하거나 기존 패키지를 수정하여 빌드하려면, 해당 패키지가 의존하는 라이브러리나 패키지들도 함께 빌드해야 합니다. 이를 위해서는 새로운 작업 공간을 만들어야 합니다.
• 작업 공간은 기존 ROS 2 설치 경로 위에 오버레이되어, 해당 작업 공간에서 빌드된 패키지들을 사용할 수 있도록 설정하는 것을 말합니다. 이 작업 공간을 설정하는 방법으로는 소스 설치 또는 바이너리 설치에서 제공하는 설정 스크립트를 소싱하여 설정하는 방법이 있습니다.
• 일반적으로, 모든 패키지를 동일한 작업 공간에 배치하는 것보다는 적은 수의 패키지를 반복하여 빌드하는 경우, 오버레이를 사용하는 것이 좋습니다. 이를 통해 필요한 패키지만 빌드하여 작업 시간을 단축할 수 있습니다.
• 따라서, 오버레이는 colcon을 사용하여 ROS 2 패키지를 빌드하기 위해 필요한 작업 공간을 설정하는 방법 중 하나입니다.

오버레이란

오버레이란?

• 오버레이(overlay)는 ROS 2에서 작업 공간(workspace)을 설정할 때 사용되는 개념입니다. 기존에 설치된 ROS 2 시스템에 새로운 패키지를 추가하거나, 기존 패키지를 수정하여 빌드하려면 작업 공간을 만들어야 합니다.
• 이때 오버레이란 기존 ROS 2 설치 경로 위에 새로운 작업 공간을 덮어씌우는 것을 의미합니다. 이렇게 하면 오버레이된 작업 공간에서는 기존 ROS 2 설치 경로에 없는 새로운 패키지나 패키지의 버전을 사용할 수 있게 됩니다.
• 오버레이된 작업 공간에서는 우선적으로 작업 공간 내에 설치된 패키지를 우선순위로 사용하게 됩니다. 만약 작업 공간 내에 설치된 패키지가 없다면, 기존 ROS 2 설치 경로에서 해당 패키지를 찾아서 사용하게 됩니다.
• 이를 통해 오버레이를 사용하면 기존 ROS 2 설치 경로를 변경하지 않고도 새로운 패키지를 추가하거나, 기존 패키지를 수정하여 빌드할 수 있습니다. 또한, 오버레이된 작업 공간을 사용하면 작업 공간 내에서 필요한 라이브러리와 패키지만 빌드하여 시간을 단축할 수 있습니다.

* node.js에서 패키지이름, 버전, 라이선스 등 패키지에 대한 정보를 package.json이라는 파일에 포함하는 것 과 같이 ROS2에서는 package.xml이 사용된다.

 

Build the workspace

• colcon build --symlink-install 명령어는 ROS 2 패키지를 빌드하고 설치하는 명령어입니다.
• colcon build는 빌드 작업을 수행하며, 각 패키지의 빌드 결과물은 build 디렉토리에 생성됩니다. --symlink-install 옵션은 빌드된 패키지를 시스템에 설치할 때, 패키지를 복사하는 대신 심볼릭 링크를 사용하여 패키지를 설치하도록 지정하는 옵션입니다. 이를 사용하면, 빌드된 패키지를 수정할 때마다 설치된 패키지도 함께 업데이트되어 편리합니다.
• 따라서 colcon build --symlink-install 명령어는 모든 패키지를 빌드하고, 빌드된 패키지를 시스템에 설치할 때, 심볼릭 링크를 사용하여 설치하도록 지정한 것입니다. 이 명령어를 실행하면, 각 패키지의 빌드 결과물은 build 디렉토리에, 설치된 패키지는 install 디렉토리에 생성됩니다.

 

패키지 빌드 후 테스트 실행

colcon test

 

Source the environment

 

• ROS 2 패키지를 빌드한 후, 빌드된 결과물은 `install` 디렉토리에 설치됩니다. 이 `install` 디렉토리에는 패키지에서 사용하는 실행 파일, 라이브러리, 런치 파일, 설정 파일 등이 포함되어 있습니다.
  
  그러나 `install` 디렉토리에 설치된 파일을 사용하기 위해서는 시스템의 환경 변수 중 `PATH`와 `LD_LIBRARY_PATH`에 해당 패키지의 경로를 추가해주어야 합니다. 이를 수동으로 추가하는 것은 번거롭고 실수하기 쉬우므로, `install` 디렉토리에는 `setup.bash` 또는 `setup.bat` 파일이 생성됩니다.
  
  `setup.bash` 파일은 `bash` 셸에서 사용되는 스크립트이며, `setup.bat` 파일은 `Windows`에서 사용되는 배치 파일입니다. 이 파일을 실행하면 해당 패키지의 경로와 라이브러리 경로가 환경 변수에 추가되고, 해당 패키지에서 내보낸 셸 명령을 사용할 수 있습니다.
  
  따라서, ROS 2 패키지를 빌드한 후 사용하려면, 먼저 `install` 디렉토리에 설치된 `setup.bash` 또는 `setup.bat` 파일을 실행하여 환경 변수를 설정해주어야 합니다. 이를 통해 해당 패키지의 실행 파일, 라이브러리 등을 시스템에서 사용할 수 있게 됩니다. 이후에는 해당 패키지에서 제공하는 기능을 사용할 수 있습니다.

source install/setup.bash

 

 

실습해보기

 

- 소스 환경을 사용하여 colcon이 실행한 파일을 실행할 수 있다. 

- 예제 에서 구독자 노드를 실행해 보겠다.

ros2 run examples_rclcpp_minimal_subscriber subscriber_member_function

- 다른 터미널에서 게시자 노드를 실행해 보겠다.

- 그전 해당 터미널에서 설정 스크립트를 소싱해야 한다. 즉,

source install/setup.bash

입력 후

ros2 run examples_rclcpp_minimal_publisher publisher_member_function

- 서로의 터미널에서 'Hello, world! idx' 가 출력되는 것을 볼 수 있다.