自定义action消息

柔光的暖阳◎ 2023-02-25 02:23 28阅读 0赞

# Action消息规范 #

## 消息规范[¶][Link 1] ##

![format_png][]

client端和server端进行通讯的规范，是依靠数据特定格式进行定义的。

client端和server端间可以不去区分编程语言，按照规范即可进行通讯，与语言无关。

我们通常用`.action`文件来去定义一个传输规范，这个定义出来的规范就是action消息。

action消息包三个部分：

*  Goal： client请求的消息规范
 *  Result：server端响应的结果规范
 *  Feedback：server端响应的进度反馈规范

对于每一个阶段的消息规范，都是遵循Msg消息定义的格式的。

## 自定义Action消息[¶][Link 2] ##

Action的消息规范主要是为了描述`Client端`和`Server端`交互的数据格式，具体来说，就是为了去描述`Goal`，`Feedback`，`Result`的数据格式。

通常我们会新建一个package来管理并且定义Action的消息格式。以当前案例为例，我们会去新建好一个叫做`demo_action_msgs`的package，新建过程中，我们添加必要的依赖`roscpp`，`rospy`，`rosmsg`, `actionlib_msgs`。然后删除不必要的文件夹`src`，`include`。

Tip

需要特别注意的是，我们在此处要添加一个额外的依赖`actionlib_msgs`，这个依赖是为我们添加action消息必要的依赖

### 1. 新建action消息描述文件[¶][Link 3] ###

在package下创建名称为`action`的文件夹，接着在`Action`文件夹中创建`CountNumber.action`文件，内容如下:

int64 max
    float64 duration
    ---
    int64 count
    ---
    float64 percent

Tip

action消息描述文件，必须放到`action`目录下，后缀必须是`.action`，这个是编码规范。

action文件中，被`---`分隔为三个部分。

第一个部分：描述的是`Goal`

第二个部分：描述的是`Result`

第三个部分：描述的是`Feedback`

### 2. 配置package.xml文件[¶][Link 4] ###

在`package.xml`文件中添加运行时消息生成

<build_depend>message_generation</build_depend>
    <exec_depend>message_runtime</exec_depend>

### 3.配置CMakeLists.txt文件[¶][Link 5] ###

find\_package配置[¶][Link 6]

配置`find_package`,添加`message_generation`，效果如下:

find_package(catkin REQUIRED COMPONENTS
            actionlib_msgs
            roscpp
            rosmsg
            rospy
            message_generation
            )

generation\_message配置[¶][Link 7]

配置`generation_message`，添加`actionlib_msgs`，效果如下:

generate_messages(
            DEPENDENCIES
            actionlib_msgs
            std_msgs
    )

catkin\_package配置[¶][Link 8]

配置`catkin_package`，添加依赖，结果如下：

<table> 
 <tbody> 
  <tr> 
   <td> <pre>1
2
3
4
5
6</pre> </td> 
   <td> <pre><code>catkin_package(
        #  INCLUDE_DIRS include
        #  LIBRARIES demo_actions
        CATKIN_DEPENDS actionlib_msgs roscpp rosmsg rospy
        #  DEPENDS system_lib
)
</code></pre> </td> 
  </tr> 
 </tbody> 
</table>

add\_action\_files配置[¶][Link 9]

配置`add_action_files`，添加action文件，效果如下：

catkin_package(
            #  INCLUDE_DIRS include
            #  LIBRARIES demo_actions
            CATKIN_DEPENDS actionlib_msgs roscpp rosmsg rospy
            #  DEPENDS system_lib
    )

### 4. 编译action消息[¶][Link 10] ###

来到workspace下面，进行代码编译

catkin_make

Tip

编译完成后，会在`devel/include/demo_action_msgs`目录下产出多个头文件。格式如下：

`action文件名Action.h`，`action文件名Goal.h`，`action文件名Result.h`，`action文件名Feedback.h`，`action文件名ActionGoal.h`，`action文件名ActionResult.h`，`action文件名ActionFeedback.h`

[Link 1]: http://robot.czxy.com/docs/ros/action/msg/#_1
[format_png]: /images/20230209/29ff3e00965044a0b950e2d5562230f1.png
[Link 2]: http://robot.czxy.com/docs/ros/action/msg/#action
[Link 3]: http://robot.czxy.com/docs/ros/action/msg/#1-action
[Link 4]: http://robot.czxy.com/docs/ros/action/msg/#2-packagexml
[Link 5]: http://robot.czxy.com/docs/ros/action/msg/#3cmakeliststxt
[Link 6]: http://robot.czxy.com/docs/ros/action/msg/#find_package
[Link 7]: http://robot.czxy.com/docs/ros/action/msg/#generation_message
[Link 8]: http://robot.czxy.com/docs/ros/action/msg/#catkin_package
[Link 9]: http://robot.czxy.com/docs/ros/action/msg/#add_action_files
[Link 10]: http://robot.czxy.com/docs/ros/action/msg/#4-action