10. action, action server, action client 설명

이번 시간에는 드디어 ROS의 통신 메커니즘 마지막으로 action에 대해 배워보겠습니다.

예제를 살펴보시죠!!

미로 탈출

$ roslaunch gcamp_gazebo maze_world.launch

본 예제는 설명이 살짝 필요합니다.

로봇을 초록 박스가 있는 탈출구까지 이동시켜야 합니다.

로봇이 회전하는 방향은 사진과 같습니다.

로봇은 회전한 뒤, 지난 topic 예제처럼 벽과 일정한 거리를 두고 멈추도록 되어 있습니다.

2, 1, 0, ... 처럼 로봇에게 이동해야 할 방향을 줘 보세요.

그럼 action server & client를 실행시켜 보도록 하겠습니다.

maze_action_server

# 새 터미널
$ rosrun action_tutorial maze_action_server.py
==== MazeActionClass Constructed ====
==== Waiting for Client Goal...  ====

maze_action_client

숫자를 모두 입력한 뒤, 끝내고 싶다면 stop을 입력합니다.

# 새 터미널
$ rosrun action_tutorial maze_action_client.py
[INFO] [1610254457.453111, 322.000000]: Action Server Found.../maze_action_server
Enter numbers [or stop] : 
2
1
stop
('Your sequence list : ', [2, 1])
[INFO] [1610254462.019717, 326.139000]: State Result from Server : 0
feedback_msg: "Turning to Down"
feedback_msg: "Moving Forward ..."
feedback_msg: "Turning to Right"
feedback_msg: "Moving Forward ..."
[...]

# server 창에도 지속적으로 이러한 내용들이 나올 것입니다.
==== Maze Action Server Executing ====
Turning Sequence : 2
Turning Sequence : 1
[...]

주어진 명령을 모두 실행한 뒤에도 로봇이 초록 박스에 도달하기 못하면, server 터미널에서 실패했다는 빨간 글자가 나오게 됩니다.

Action 설명

이전 service 강의에서 다음과 같은 부분이 혹시 기억나시나요?

A topic이 실행되는 동안, 다른 B topic도 같이 실행될 수 있습니다. 반면, service는 현재 진행중인 service의 request가 처리되는 동안, 다른 service는 기다리고 있어야 합니다.

action은 service와 비슷합니다. 하지만 큰 차이점이 있는데요.

결론부터 말씀드리자면,

action client는 action server가 response를 보내기 전까지 기다리지 않고, 다른 일을 할 수 있습니다!

action client은 request를 보낸 뒤에도 지속적으로 feedback을 받을 수 있습니다!!

image from : The Construct

사진과 같이 client와 server가 주고받는 내용은 크게 5가지가 있습니다. 더불어 이들이 전개되는 순서를 살펴보면 다음과 같습니다.

client ⇒ server goal (service request와 유사합니다.)

server ⇒ client feedback

client ⇒ server cancel

server ⇒ client status

server ⇒ client result

하나씩 살펴보겠습니다. 👍👍

client ⇒ server goal : 이전 service resquest와 유사하게 server로 요청을 합니다.

server ⇒ client feedback : goal에 얼마나 도달했는지등의 지속적인 피드백을 주고받습니다.

client ⇒ server cancel : feedback을 지켜보던 client가 부득이하게 goal을 취소하고 싶은 경우 cancel을 요청할 수 있습니다.

server ⇒ client status : Server가 작업중인 동안 client가 다른 일을 할 수 있다고 말했죠? 그러기 위해서는 server의 상태, status를 알아야 할 것입니다.

server ⇒ client result : 모든 요청된 작업이 완료되면, server는 result를 반환합니다.

그래서, action server를 실행시킨 뒤, rostopic list를 실행시켜보면, 다음과 같이 기본 5개의 리스트를 확인할 수 있습니다.

$ rostopic list 
...
/maze_action_server/cancel
/maze_action_server/feedback
/maze_action_server/goal
/maze_action_server/result
/maze_action_server/status

💡

rosaction list가 아님에 주의하세요!!!

topic의 msg, service의 srv가 있듯이, action에도 주고받는 데이터 형식이 있습니다. 바로 action입니다.

이 action은 goal, result, feedback으로 구성되어 있으며, service와 비슷하게 ---로 구분됩니다.

Fibonacci.action

#goal definition
int32 order
---
#result definition
int32[] sequence
---
#feedback
int32[] sequence

형식은 service와 비슷한데, 실제로 조회할 때에는 rosmsg로 조회하니, 혼동하지 않도록 주의합시다.

$ rosmsg list | grep Fibonacci
actionlib_tutorials/FibonacciAction
actionlib_tutorials/FibonacciActionFeedback
actionlib_tutorials/FibonacciActionGoal
actionlib_tutorials/FibonacciActionResult
actionlib_tutorials/FibonacciFeedback
actionlib_tutorials/FibonacciGoal
actionlib_tutorials/FibonacciResult

여기서 의문이 생기는데요, 분명, action은 다섯 종류의 주고받는 형식이 있다고 했는데, 위의 파일에는 세가지만 적혀 있습니다⁉️

나머지 cancel, status는 action에서 지정해둔 고유값이 있습니다. status에 대해서 살펴봅시다.

uint8 PENDING         = 0   # The goal has yet to be processed by the action server
uint8 ACTIVE          = 1   # The goal is currently being processed by the action server
uint8 PREEMPTED       = 2   # The goal received a cancel request after it started executing
                            #   and has since completed its execution (Terminal State)
uint8 SUCCEEDED       = 3   # The goal was achieved successfully by the action server (Terminal State)
uint8 ABORTED         = 4   # The goal was aborted during execution by the action server due
                            #    to some failure (Terminal State)
uint8 REJECTED        = 5   # The goal was rejected by the action server without being processed,
                            #    because the goal was unattainable or invalid (Terminal State)
uint8 PREEMPTING      = 6   # The goal received a cancel request after it started executing
                            #    and has not yet completed execution
uint8 RECALLING       = 7   # The goal received a cancel request before it started executing,
                            #    but the action server has not yet confirmed that the goal is canceled
uint8 RECALLED        = 8   # The goal received a cancel request before it started executing
                            #    and was successfully cancelled (Terminal State)
uint8 LOST            = 9   # An action client can determine that a goal is LOST. This should not be
                            #    sent over the wire by an action server

#Allow for the user to associate a string with GoalStatus for debugging
string t

actionlib_msgs/GoalStatus Documentation

GoalID goal_iduint8 statusuint8 PENDING = 0 # The goal has yet to be processed by the action server uint8 ACTIVE = 1 # The goal is currently being processed by the action server uint8 PREEMPTED = 2 # The goal received a cancel request after it started executing # and

http://docs.ros.org/en/kinetic/api/actionlib_msgs/html/msg/GoalStatus.html

예제를 실행하기 전에, 앞선 미로찾기 예제를 이해하기에는 선행 지식들이 적지 않기에, 이번 강의에서는 wiki.ros.org/에서 제공하는 예시들을 우선 살펴본 뒤에, 다음 강의에서 미로찾기 예제 코드를 살펴보고자 합니다.

~~OpenCV, 파이썬 패키지와 Class, Quaternion과 Euler Angle에 대한 지식이 필요합니다.~~

💡

요지는, action의 사용사례를 보임과 동시에, ROS Action에 대한 진입장벽은 낮추기 위함이라 생각해주시면 감사합니다. 😉

간단 예제 실행

$ roslaunch action_tutorial fibonacci_server.launch
[INFO] [1610620215.219295]: Fibonacci Action Server Executing, creating fibonacci sequence of order 20 with seeds 0, 1
[INFO] [1610620234.220412]: Succeeded calculating the Fibonacci

# 새 터미널 실행
$ rosrun action_tutorial fibonacci_action_client.py
==== Sending Goal to Server ====
sequence: [0, 1, 1]
sequence: [0, 1, 1, 2]
sequence: [0, 1, 1, 2, 3]
sequence: [0, 1, 1, 2, 3, 5]
sequence: [0, 1, 1, 2, 3, 5, 8]
sequence: [0, 1, 1, 2, 3, 5, 8, 13]
sequence: [0, 1, 1, 2, 3, 5, 8, 13, 21]
(...)

위 예제는 피보나치 수열을 action으로 구현한 것입니다.

피보나치 수열이란?

image from : wiki

사실 피보나치 수열이 중요하기보다 action server & client에 대해 배우는 것이 목적이기 때문에, 짧게 넘어가겠습니다. client 부분부터 보겠습니다!!

Fibonacci Action Client

#! /usr/bin/env python

"""
Fibonacci Action Client

referenced from wiki.ros.org

url: http://wiki.ros.org/actionlib_tutorials/Tutorials/Writing%20a%20Simple%20Action%20Client%20%28Python%29 
"""

import rospy
import actionlib
from actionlib_tutorials.msg import FibonacciAction, FibonacciGoal

# Action Status (primitive)
PENDING = 0
ACTIVE = 1
PREEMPTED = 2
SUCCEEDED = 3
ABORTED = 4
REJECTED = 5
PREEMPTING = 6
RECALLING = 7
RECALLED = 8
LOST = 9


def fb_callback(feedback):
    print(feedback)


rospy.init_node("fibonacci_client")
rate = rospy.Rate(5)

client = actionlib.SimpleActionClient("fibonacci_action_server", FibonacciAction)
client.wait_for_server()

goal = FibonacciGoal()
goal.order = 20

print("==== Sending Goal to Server ====")
client.send_goal(goal, feedback_cb=fb_callback)

state_result = client.get_state()

while state_result < PREEMPTED:
    # Doing Stuff while waiting for the Server to give a result....
    rate.sleep()
    state_result = client.get_state()

if state_result == SUCCEEDED:
    rospy.logwarn("Action Done State Result : " + str(client.get_result()))

else:
    rospy.logerr("Something went wrong, result state : " + str(state_result))

하나씩 차근차근 짚어가겠습니다. action client는 service client와 아주 유사하기 때문에, 쉽게 이해할 수 있습니다.

import 부분

import rospy
import actionlib
from actionlib_tutorials.msg import FibonacciAction, FibonacciGoal

client가 필요한 것은 Goal이며 위와 같이 [해당-action-이름]Goal로 import 할 수 있습니다.

💡

service는 이렇게 import 했습니다 .

from service_tutorial.srv import ControlTurningMessage, ControlTurningMessageRequest

action Goal status

# Action Status (primitive)
PENDING = 0
ACTIVE = 1
PREEMPTED = 2
SUCCEEDED = 3
ABORTED = 4
REJECTED = 5
PREEMPTING = 6
RECALLING = 7
RECALLED = 8
LOST = 9

앞서 배웠던 바와 같이 GoalStatus를 보기 쉽게 상수로 정의해 두었습니다.

client 생성, wait_for_server

rospy.init_node("fibonacci_client")
rate = rospy.Rate(5)

client = actionlib.SimpleActionClient("fibonacci_action_server", FibonacciAction)
client.wait_for_server()

actionlib.SimpleActionClient("server-name", "action-type-name")

Action Client는 위와 같이 생성하며, server의 이름과 동일해야 함에 유의합니다!

service client와 마찬가지로, server가 실행될 때까지 기다려야 하며 구현은 위와 같습니다.

💡

service client 복습

rospy.wait_for_service("/control_robot_angle")
service_client = rospy.ServiceProxy("/control_robot_angle", ControlTurningMessage)

send_goal, feedback

def fb_callback(feedback):
    print(feedback)

(...)

goal = FibonacciGoal()
goal.order = 20

print("==== Sending Goal to Server ====")
client.send_goal(goal, feedback_cb=fb_callback)

여기까지는 service와 아주 유사하지요??

Fibonacci.action

#goal definition
int32 order
---
#result definition
int32[] sequence
---
#feedback
int32[] sequence

중요!! Action만의 기능!!

while state_result < PREEMPTED:
    # Doing Stuff while waiting for the Server to give a result....
    rate.sleep()
    state_result = client.get_state()

if state_result == SUCCEEDED:
    rospy.logwarn("Action Done Result : " + str(client.get_result()))

else:
    rospy.logerr("Something went wrong, result state : " + str(state_result))

# Action Status (primitive)
PENDING = 0
ACTIVE = 1
PREEMPTED = 2
SUCCEEDED = 3
ABORTED = 4
REJECTED = 5
PREEMPTING = 6
RECALLING = 7
RECALLED = 8
LOST = 9

action은 위와 같이 server로부터 아직 요청을 실행중이라는 상태가 돌아오면, 그동안 다른 일을 하도록 할 수가 있습니다!! 현 예제에서는 큰 작업은 할당하지 않았지만, 실제 로봇을 만들다보면 정말 유용한 기능일 것입니다. 👍👍👍

다음으로 Action Server 코드를 살펴보도록 하겠습니다.

Fibonacci Action Server

#! /usr/bin/env python

"""
Fibonacci Action Server

referenced from wiki.ros.org

url: http://wiki.ros.org/actionlib_tutorials/Tutorials/Writing%20a%20Simple%20Action%20Server%20using%20the%20Execute%20Callback%20%28Python%29#Compiling
"""

import rospy
import actionlib
from actionlib_tutorials.msg import FibonacciFeedback, FibonacciResult, FibonacciAction

g_feedback = FibonacciFeedback()
g_result = FibonacciResult()


def execute_cb(goal):
    r = rospy.Rate(5)
    success = True

    g_feedback.sequence = []
    g_feedback.sequence.append(0)
    g_feedback.sequence.append(1)

    rospy.loginfo(
        "Fibonacci Action Server Executing, creating fibonacci sequence of order %i with seeds %i, %i"
        % (goal.order, g_feedback.sequence[0], g_feedback.sequence[1])
    )

    for i in range(1, goal.order):
        if _as.is_preempt_requested():
            rospy.loginfo("The goal has been cancelled/preempted")
            _as.set_preempted()
            success = False
            break

        g_feedback.sequence.append(g_feedback.sequence[i] + g_feedback.sequence[i - 1])
        _as.publish_feedback(g_feedback)
        r.sleep()

    if success:
        g_result.sequence = g_feedback.sequence
        rospy.loginfo("Succeeded calculating the Fibonacci")
        _as.set_succeeded(g_result)


rospy.init_node("fibonacci")

_as = actionlib.SimpleActionServer(
    "fibonacci_action_server", FibonacciAction, execute_cb, False
)
_as.start()

print("==== Waiting for Client Goal...  ====")

rospy.spin()

goal_callback 부분이 상당히 길지요? 차근차근 뜯어봅시다!!

import, global variables

import rospy
import actionlib
from actionlib_tutorials.msg import FibonacciFeedback, FibonacciResult, FibonacciAction

g_feedback = FibonacciFeedback()
g_result = FibonacciResult()

server단에는 Feedback, Result가 필요합니다.

callback안에서도 사용하기 위해 전역 변수로 할당하였습니다.

main

rospy.init_node("fibonacci")

_as = actionlib.SimpleActionServer(
    "fibonacci_action_server", FibonacciAction, execute_cb, False
)
_as.start()

print("==== Waiting for Client Goal...  ====")

rospy.spin()

actionlib.SimpleActionServer( "server-name", "action-type-name", "execute_cb", "auto_start")

Action Server는 위와 같이 생성하며, 첫번째 인자는 Client 생성 시에 동일하게 기입해야 제대로 작동합니다.

False로 적혀 있는 부분은 auto_start라는 매개변수인데요, 말 그대로 server를 생성 후 자동 실행할 것인지 설정하는 매개변수이며, 지금은 _as.start()를 통해 수동으로 실행시키고 있습니다.

callback

def execute_cb(goal):
    r = rospy.Rate(5)
    success = True

    g_feedback.sequence = []
    g_feedback.sequence.append(0)
    g_feedback.sequence.append(1)

    rospy.loginfo(
        "Fibonacci Action Server Executing, creating fibonacci sequence of order %i with seeds %i, %i"
        % (goal.order, g_feedback.sequence[0], g_feedback.sequence[1])
    )

    for i in range(1, goal.order):
        if _as.is_preempt_requested():
            rospy.loginfo("The goal has been cancelled/preempted")

goal_callback은 client로부터의 goal을 매개변수로 받게 되며, FibonacciAction이 어떻게 생겼는지 다시 한 번 보겠습니다.

Fibonacci.action

#goal definition
int32 order
---
#result definition
int32[] sequence
---
#feedback
int32[] sequence

피보나치 로직, is_preempt_requested()

		for i in range(1, goal.order):
        if _as.is_preempt_requested():
            rospy.loginfo("The goal has been cancelled/preempted")
            _as.set_preempted()
            success = False
            break

        g_feedback.sequence.append(g_feedback.sequence[i] + g_feedback.sequence[i - 1])
        _as.publish_feedback(g_feedback)
        r.sleep()

    if success:
        g_result.sequence = g_feedback.sequence
        rospy.loginfo("Succeeded calculating the Fibonacci")
        _as.set_succeeded(g_result)

callback 중에서도 핵심인 for문 안을 가져왔습니다.

지금의 경우 order 만큼 반복하며 피보나치 수열을 만들고, list 자료형을 가진 sequence에 append하고 있지요?

action의 성격상, 짧은 request - response 보다, 길고 복잡한 request가 많이 사용될 것입니다. (짧은 request - response가 필요한 경우 저라면 service를 쓰겠습니다.)

긴 실행 동안 feedback을 보내고, 도중에 client가 cancel, 혹은 preempt(선점)을 요청할 수도 있기에 이에 대한 처리가 구현되어 있습니다.

💡

이때, 그냥 강제로 client를 종료하는 것과 cancel request는 엄연히 다름에 주의합니다. 예를 들어, ctrl + c를 통해 강제종료를 시키면, server단에서는 아래와 같은 warning을 발생시킵니다.

[WARN] [1610621159.608869]: Inbound TCP/IP connection failed: connection from sender terminated before handshake header received. 0 bytes were received. Please check sender for additional details.

if success로 시작하는 부분은 ROS에서 제공하는 것이 아닌, 보편적으로 많이 사용되는 python flag를 구현한 것으로 ROS API를 참고하여 더 다양한 기능을 구현할 수 있을 것입니다.

actionlib: actionlib.simple_action_server.SimpleActionServer Class Reference

The SimpleActionServer implements a singe goal policy on top of the ActionServer class.

http://docs.ros.org/en/hydro/api/actionlib/html/classactionlib_1_1simple__action__server_1_1SimpleActionServer.html

[Tip] AxClient

$ rosrun actionlib axclient.py /fibonacci_action_server
or
# 이전에 ~/.bashrc에 추가했습니다 :)
$ axclient /fibonacci_action_server

Goal 부분에 원하는 order를 넣어서 SEND GOAL을 클릭하면, 보기 좋게 Feedback과 Result를 확인할 수 있습니다. 대신 rosrun actionlib axclient.py 뒤에, 이름을 잘 맞춰줘야 합니다. rostopic list 로 볼 수 있겠지요?

자 🙏 여기까지, ROS의 통신 메커니즘을 모두 살펴보았습니다. 앞으로 이어지는 몇개의 강의들을 보다 심화된 예제를 분석해보고자 합니다. 해당 부분은 필수적이 아니며 제가 제목에도 [Option]을 붙여두겠습니다!!

저작자표시 비영리 동일조건

Swiming_Lab

10. action, action server, action client 설명

10. action, action server, action client 설명

미로 탈출

Action 설명

간단 예제 실행

Fibonacci Action Client

Fibonacci Action Server

[Tip] AxClient

티스토리툴바