服务数据的定义与使用
1、前言
在前面两篇文章中《客户端 Client 的编程实现》、《服务端Server的编程实现》学习到了 Spawn 和Trigger 两种已经在 ROS 中已经定义好的服务数据类型的使用方式。但在很多场景下面这种 ROS 已经定义好的服务数据类型并不能完全满足我们的需求。而在之前《话题消息的定义与使用》我们自定义的话题消息中,我们使一个发布者 Publisher 和订阅者 Subscriber 不断地发布和订阅 Person 信息,但我们现在不希望 Publisher 不断地发送数据,更希望用 Service 的机制每 request 一次才去发送一次,同时可以知道是否发送成功,那我们就需要使用到 Service 服务数据的定义了。
2、模型
3、开始自定义服务
步骤一:定义 srv 文件
在learning_service
目录下新建srv
文件夹,用来存放后续的服务类文件。
与之前一样,在srv
文件夹下新建Person.srv
文件,输入以下内容并保存:
string name
uint8 age
uint8 sex
uint8 unknown = 0
uint8 male = 1
uint8 female = 2
---
string result
1、上一篇提到,
---
上方指的是 request 的内容,---
下方指的是 response 的内容。
2、这里写的并不是cpp,也不是python。但他在编译过程中会由ros自动编译成cpp或python。
步骤二:在 package.xml 中添加功能包依赖
打开learning_service
文件夹下的package.xml
文件。
如果你的电脑安装了浏览器,xml文件可能会由浏览器默认打开,不能编辑。可以在这个目录下打开命令行,输入
gedit package.xml
指令打开文件。
在最下方如图所示的地方添加以下语句,并保存:
<build_depend>message_generation</build_depend>
<exec_depend>message_runtime</exec_depend>
<build_depend>用于添加编译依赖,这里添加
message_generation
功能包
<exec_depend<用于添加执行依赖,这里添加message_runtime
功能包
步骤三:在 CMakeLists.txt 添加编译选项
打开learning_service
文件夹下的CMakeLists.txt
。
-
在最上方的
find_package
中添加message_generation
:这一步是为了添加功能包依赖。
-----
----- -
找到
Declare ROS dynamic reconfigure parameters
的位置,在上方添加如下语句:
add_service_files(FILES Person.srv)
generate_messages(DEPENDENCIES std_msgs)
-
第一句话,告诉编译器
Person.srv
是我们定义的服务接口 -
第二句话,告诉编译器在编译
Person.srv
文件的时候,需要依赖哪些库/包。这里我们需要依赖std_msgs
,刚刚我们写的如string
、uint8
,就是在std_msgs
中定义的。
- 找到
catkin specific configuration
(即## Build ##
上方),在图示位置修改以下语句:
CATKIN_DEPENDS geometry_msgs roscpp rospy std_msgs turtlesim message_runtime
做完以上三步,保存退出。
回到工作空间的根目录catkin_ws
下,打开命令行,输入指令catkin_make
进行编译。
编译成功后,可以在/learning_topic/devel/include/learning_service/
路径下,找到刚刚编写的Person.srv
文件已经被编译成为Person.h
文件。
注意到该路径下相比于自定义话题多了两个文件,分别是
PersonReq uest.h
和PersonResp onse.h
,这是因为刚刚编写的/srv/Person.srv
文件中的---
起了作用,---
上方的内容会编译成PersonReq uest.h
,---
下方的内容会编译成PersonResp onse.h
,但是这两个.h
都会被Person.h
包含,所以我们在用的时候只需要include Person.h
即可,它会自动包含另外两个.h
文件。Person.h
里包含另外两个.h
:
步骤四:编写 cpp 程序
在图示路径下使用touch
命令建立两个cpp文件,命名为person_client.cpp
和person_server.cpp
。代码如下。
person_client.cpp:
/**
* 该例程将请求/show_person服务,服务数据类型learning_service::Person
*/
#include <ros/ros.h>
#include "learning_service/Person.h"
int main(int argc, char** argv)
{
// 初始化ROS节点
ros::init(argc, argv, "person_client");
// 创建节点句柄
ros::NodeHandle node;
// 发现/spawn服务后,创建一个服务客户端,连接名为/spawn的service
ros::service::waitForService("/show_person");
ros::ServiceClient person_client = node.serviceClient<learning_service::Person>("/show_person");
// 初始化learning_service::Person的请求数据
learning_service::Person srv;
srv.request.name = "Tom";
srv.request.age = 20;
srv.request.sex = learning_service::Person::Request::male;
// 请求服务调用
ROS_INFO("Call service to show person[name:%s, age:%d, sex:%d]",
srv.request.name.c_str(), srv.request.age, srv.request.sex);
person_client.call(srv);
// 显示服务调用结果
ROS_INFO("Show person result : %s", srv.response.result.c_str());
return 0;
};
person_server.cpp:
/**
* 该例程将执行/show_person服务,服务数据类型learning_service::Person
*/
#include <ros/ros.h>
#include "learning_service/Person.h"
// service回调函数,输入参数req,输出参数res
bool personCallback(learning_service::Person::Request &req,
learning_service::Person::Response &res)
{
// 显示请求数据
ROS_INFO("Person: name:%s age:%d sex:%d", req.name.c_str(), req.age, req.sex);
// 设置反馈数据
res.result = "OK";
return true;
}
int main(int argc, char **argv)
{
// ROS节点初始化
ros::init(argc, argv, "person_server");
// 创建节点句柄
ros::NodeHandle n;
// 创建一个名为/show_person的server,注册回调函数personCallback
ros::ServiceServer person_service = n.advertiseService("/show_person", personCallback);
// 循环等待回调函数
ROS_INFO("Ready to show person informtion.");
ros::spin();
return 0;
}
cpp文件编写好后,再次编写刚刚的CMakeLists.txt
文件,对刚刚编写cpp内容进行配置。
找到## Install ##
位置的上方,添加以下语句,保存。
说明:这里相比之前配置
CMakeLists.txt
,多了add_dependencies
的语句目的是让可执行文件(前两句做的工作)和动态生成的文件产生依赖关系
add_executable(person_server src/person_server.cpp)
target_link_libraries(person_server ${catkin_LIBRARIES})
add_dependencies(person_server ${PROJECT_NAME}_gencpp)
add_executable(person_client src/person_client.cpp)
target_link_libraries(person_client ${catkin_LIBRARIES})
add_dependencies(person_client ${PROJECT_NAME}_gencpp)
步骤五:编译、运行
步骤和之前的一模一样。(注意如果之前没有修改过.bashrc文件的话就需要在每次打开新终端运行rosrun
命令前执行一次source devel/setup.bash
语句)
cd ~/catkin_ws
catkin_make
roscore
rosrun learning_service person_server
rosrun learning_service person_client
如果已经修改过环境变量,并且可以找到功能包对应的可执行文件,然而执行
rosrun
命令时也无法自动补全功能包名称,这个时候执行一遍rospack list
命令即可。
4、小知识
每次运行一个新的程序之前,最好先把 roscore 重启一遍,因为在 roscore 里面有一个参数服务器,如果程序运行很多的话,里面可能会有些参数名字一样,就会有可能产生冲突,会造成一些莫名其妙的问题,比如说某个功能包找不到、某个程序执行不了、明明之前是没问题的但是突然就用不了了。这个时候就要检查一下你的 roscore 是不是一直运行,如果是的话,里面已经保存了很多以前的参数,需要把它给清掉。