2.2커스텀 msg, srv 만들기

1.3장에서 토픽으로 std_msgs/String을 주고받았고, 1.4장에서 AddTwoInts 서비스를 썼습니다. 모두 ROS2가 미리 만들어 둔 타입입니다. 로봇을 만들다 보면 이런 질문이 생깁니다. 모터 이름과 온도와 상태를 한 번에 보내고 싶은데, 맞는 타입이 없습니다.

먼저 있는 타입을 찾는다

타입을 새로 만들기 전에 이미 있는 것을 확인합니다. 속도는 geometry_msgs/Twist, 거리 센서는 sensor_msgs/Range, 레이저 스캔은 sensor_msgs/LaserScan처럼 로봇에 흔한 데이터는 대부분 표준 타입이 있습니다. 표준 타입을 쓰면 RViz와 rqt, Nav2 같은 기존 도구가 그 메시지를 바로 이해합니다.

없을 때 std_msgs/String에 "motor_left,31.5" 같은 문자열을 넣는 방법이 있지만 권하지 않습니다. 받는 쪽이 문자열을 직접 쪼개야 하고, 형식이 바뀌어도 컴파일러나 도구가 알려 주지 않습니다. 필드마다 이름과 타입을 가진 메시지를 정의하면 이 문제가 사라집니다.

.msg 파일

메시지 타입은 .msg 텍스트 파일 하나로 정의합니다. 한 줄에 필드 하나를 타입 이름 순서로 적습니다.

# my_interfaces/msg/SensorReading.msg
# 모터 온도 센서의 측정값 한 번
string name
float32 temperature

uint8 OK=0
uint8 HOT=1
uint8 status 0

• # 뒤는 주석입니다.
• uint8 OK=0 처럼 이름이 대문자이고 =가 있는 줄은 상수입니다. 필드가 아니라 타입에 붙는 고정값입니다.
• uint8 status 0 처럼 이름 뒤에 값을 적으면 그 필드의 기본값입니다.
• 파일 이름은 대문자로 시작하는 CamelCase(SensorReading)입니다. 필드 이름은 소문자와 숫자, 밑줄만 씁니다(temperature, left_speed).

쓸 수 있는 타입

다른 메시지를 필드로 넣을 때는 패키지/타입 형식으로 씁니다. 같은 패키지 안의 메시지는 패키지 이름을 생략할 수 있습니다. 시간표(스탬프)가 필요하면 std_msgs/Header header를 첫 필드로 둡니다. 센서 메시지들이 이 관례를 따릅니다.

.srv 파일

서비스는 요청과 응답을 --- 줄로 나눠 한 파일에 적습니다. 1.4장에서 본 AddTwoInts.srv와 같은 구조입니다.

# my_interfaces/srv/SetThreshold.srv
# 과열로 볼 온도를 바꿔 달라는 요청
float32 limit
---
bool accepted
string message

요청에는 바꿀 값을, 응답에는 성공 여부와 이유를 담았습니다. 응답에 bool success와 string message 한 쌍을 두는 방식은 서비스에서 흔한 관례입니다. 호출한 쪽이 실패했을 때 사유를 읽을 수 있습니다.

직접 써 보기

아래 실행기에는 위의 두 파일이 정의 파일로 들어 있습니다(편집기 위쪽 읽기 전용 상자). 코드에서는 from my_interfaces.msg import SensorReading처럼 불러 씁니다. 에뮬레이터는 .msg의 정의를 읽어 같은 모양의 Python 클래스를 만듭니다. 실제 ROS2에서는 빌드할 때 rosidl이 이 클래스를 생성합니다.

먼저 클래스가 어떻게 생겼는지 만져 봅니다.

# 모터 온도 센서의 측정값 한 번
string name
float32 temperature

uint8 OK=0
uint8 HOT=1
uint8 status 0

# 과열로 볼 온도를 바꿔 달라는 요청
float32 limit
---
bool accepted
string message

이제 센서, 모니터, 관리자 세 노드가 이 타입으로 통신합니다. 센서가 SensorReading을 토픽으로 보내고, 모니터가 기준 온도(처음 30도)와 비교해 status를 정합니다. 관리자는 4.5초에 서비스 SetThreshold로 기준을 40도로 올려 달라고 요청합니다.

# 모터 온도 센서의 측정값 한 번
string name
float32 temperature

uint8 OK=0
uint8 HOT=1
uint8 status 0

# 과열로 볼 온도를 바꿔 달라는 요청
float32 limit
---
bool accepted
string message

실제로는 어떻게 만드나

브라우저에서는 정의 파일을 실행기에 넘기면 끝이지만, 실제 ROS2에서는 인터페이스를 패키지로 만들고 빌드해야 합니다. 3.6장과 3.7장에서 패키지와 워크스페이스를 다룹니다. 이 절은 그때 따라 할 수 있도록 순서를 미리 보여 줍니다.

인터페이스는 별도 패키지에 둔다

.msg와 .srv는 Python만으로 이루어진 패키지(ament_python)에 넣을 수 없습니다. 인터페이스 코드를 생성하려면 ament_cmake 패키지가 필요합니다. 그래서 인터페이스만 모은 패키지를 따로 만듭니다.

cd ~/ros2_ws/src
ros2 pkg create --build-type ament_cmake my_interfaces
mkdir -p my_interfaces/msg my_interfaces/srv

그다음 msg/SensorReading.msg와 srv/SetThreshold.srv를 위 내용으로 만듭니다. 폴더 구조는 이렇습니다.

my_interfaces/
├─ CMakeLists.txt
├─ package.xml
├─ msg/
│  └─ SensorReading.msg
└─ srv/
   └─ SetThreshold.srv

CMakeLists.txt와 package.xml

CMakeLists.txt에는 두 가지를 추가합니다. 인터페이스 생성 도구를 찾고, 어떤 파일에서 코드를 만들지 알려 줍니다.

find_package(rosidl_default_generators REQUIRED)

rosidl_generate_interfaces(${PROJECT_NAME}
  "msg/SensorReading.msg"
  "srv/SetThreshold.srv"
)

ament_package() 줄 앞에 find_package와 rosidl_generate_interfaces를 둡니다. 새 파일을 만들 때마다 목록에 줄을 더해야 합니다. 빠뜨리면 그 파일은 빌드되지 않습니다.

package.xml에는 생성 도구와 실행 시 라이브러리, 그리고 이 패키지가 인터페이스 패키지라는 표시를 넣습니다.

<buildtool_depend>rosidl_default_generators</buildtool_depend>
<exec_depend>rosidl_default_runtime</exec_depend>
<member_of_group>rosidl_interface_packages</member_of_group>

빌드하고 확인한다

cd ~/ros2_ws
colcon build --packages-select my_interfaces
source install/setup.bash
ros2 interface show my_interfaces/msg/SensorReading

ros2 interface show가 파일 내용을 그대로 보여 주면 성공입니다. 목록에서 찾으려면 ros2 interface list | grep my_interfaces를 씁니다. 터미널을 새로 열었다면 source install/setup.bash를 다시 해야 보입니다.

노드 패키지에서 쓰기

이 타입을 쓰는 노드 패키지의 package.xml에 의존성을 적습니다.

<depend>my_interfaces</depend>

Python 코드는 에뮬레이터와 같습니다. from my_interfaces.msg import SensorReading. 인터페이스 패키지를 고치고 다시 빌드한 뒤에는 이 타입을 쓰는 패키지도 다시 빌드하는 편이 안전합니다.

막혔을 때

한눈에 정리

1. 타입을 만들기 전에 표준 타입이 있는지 먼저 찾는다.
2. .msg는 한 줄에 타입 이름, 기본값은 이름 뒤에, 상수는 대문자 이름에 =로 적는다.
3. .srv는 ---로 요청과 응답을 나눈다. 응답에는 성공 여부와 사유를 넣어 두는 것이 관례다.
4. 인터페이스는 ament_cmake 패키지에 두고 rosidl_generate_interfaces에 파일을 등록해 빌드한다.
5. 쓰는 쪽은 package.xml에 의존성을 적고 from 패키지.msg import 타입으로 불러 쓴다.

확인 문제

다음 장

2.3장에서는 같은 방식으로 .action 파일을 정의하고, 오래 걸리는 일을 맡는 액션 서버와 클라이언트를 Python으로 작성합니다.