编写与测试简单的Service和Client(Python)
01 导读
C++ 代码必须通过编译生成可执行文件;
python 代码是可执行文件,不需要编译;
- 开发的功能包都放在 catkin_ws 这样一个工作空间里;
- 新建的功能包取名为 service_example,实现两个整数求和为例,client 端节点向 server 端节点发送 a、b 的请求,server 端节点返回响应 sum=a+b 给 client 端节点;
服务编程流程
- 创建服务器
- 创建客户端
- 添加编译选项
- 运行可执行程序
02 功能包的创建
在 catkin_ws/src/ 目录下新建功能包 service_example,并在创建时显式的指明依赖 rospy 和 std_msgs,依赖 std_msgs 将作为基本数据类型用于定义我们的服务类型。打开命令行终端,输入命令:
1 | $ cd ~/catkin_ws/src |
03 在功能包中创建自定义服务类型
- 服务(srv): 一个 srv 文件描述一项服务。它包含两个部分:请求和响应。
服务类型的定义文件都是以.srv 为扩展名,srv 文件则存放在功能包的 srv 目录下。
- 服务通信过程中服务的数据类型需要用户自己定义,与消息不同,节点并不提供标准服务类型。
3.1 定义 srv 文件
srv 文件分为请求和响应两部分,由 ‘—‘ 分隔。
在功能包 service_example 目录下新建 srv 目录,然后在 service_example/srv/ 目录中创建 AddTwoInts.srv 文件
1 | int64 a |
其中a
和b
是请求,而sum
是响应。
3.2 在 package.xml 中添加功能包依赖
srv 文件被转换成为 C++,Python 和其他语言的源代码:
查看 package.xml
, 确保它包含一下两条语句:
1 | <build_depend>message_generation</build_depend> |
如果没有,添加进去。 注意,在构建的时候,我们只需要”message_generation”。然而,在运行的时候,我们只需要”message_runtime”。
3.3 在 CMakeLists.txt 添加编译选项
第一步,增加 message_generation
打开功能包中的 CMakeLists.txt 文件,利用 find_packag 函数,增加对 message_generation
的依赖,这样就可以生成消息了。 你可以直接在 COMPONENTS
的列表里增加 message_generation
,就像这样:
1 | find_package(catkin REQUIRED COMPONENTS |
有时候你会发现,即使你没有调用 find_package, 你也可以编译通过。这是因为 catkin 把你所有的功能包都整合在一起,因此,如果其他的功能包调用了 find_package,你的功能包的依赖就会是同样的配置。但是,在你单独编译时,忘记调用 find_package 会很容易出错。
第二步,删掉 #
,去除对下边语句的注释:
找到如下代码块:
1 | # add_service_files( |
用你自己定义的 srv 文件名(AddTwoInts.srv)替换掉那些Service*.srv
文件,修改好后的代码如下:
1 | add_service_files( |
第三步,msg 和 srv 都需要的步骤
在 CMakeLists.txt
中找到如下部分:
1 | # generate_messages( |
去掉注释并附加上所有你消息文件所依赖的那些含有.msg
文件的功能包(这个例子是依赖std_msgs
, 不要添加 roscpp,rospy),结果如下:
1 | generate_messages( |
原因:generate_messages 的作用是自动创建我们自定义的消息类型 .msg 与服务类型 .srv 相对应的 .h,由于我们定义的服务类型使用了 std_msgs 中的 int64 基本类型,所以必须向 generate_messages 指明该依赖。
第四步,由于增加了新的消息,所以我们需要重新编译我们的功能包:
目的:查看配置是否有问题
1 | $ cd ~/catkin_ws |
所有在 msg 路径下的.msg 文件都将转换为 ROS 所支持语言的源代码。生成的 C++ 头文件将会放置在~/catkin_ws/devel/include/service_example/
。 Python 脚本语言会在~/catkin_ws/devel/lib/python2.7/dist-packages/service_example/msg
目录下创建。
04 查看自定义的服务消息
通过 <功能包名 / 服务类型名> 找到该服务,打开命令行终端,输入命令:
1 | $ source ~/catkin_ws/devel/setup.bash |
05 功能包的源代码编写
功能包中需要编写两个独立可执行的节点,一个节点用来作为 client 端发起请求,另一个节点用来作为 server 端响应请求,所以需要在新建的功能包 service_example/scripts 目录下新建两个文件 server.py 和 client.py,并将下面的代码分别填入。
5.1 编写 Service 节点(server.py)
将创建一个简单的 service 节点(“server”),该节点将接收到两个整形数字,并返回它们的和。
如何实现一个服务器
- 初始化 ROS 节点;
- 创建 Server 实例;
- 循环等待服务请求,进入回调函数;
- 在回调函数中完成服务功能的处理,并反馈应答数据。
在 service_example 包中创建 scripts /server.py 文件:
1 | #!/usr/bin/env python |
在~/catkin_ws/src/service_example 下,让节点可执行:
1 | $ chmod +x scripts/server.py |
5.2 编写 Client 节点(client.py)
如何实现一个客户端
- 初始化 ROS 节点;
- 创建一个 Client 实例;
- 发布服务请求数据;
- 等待 Server 处理之后的应答结果。
在 service_example 包中创建 scripts /client.py 文件,并在其中粘贴以下內容:
1 | #!/usr/bin/env python |
在~/catkin_ws/src/service_example 节点可执行:
1 | $ chmod +x scripts/client.py |
代码解析:
我们可以像普通函数一样使用这个句柄并调用它:
1 | resp1 = add_two_ints(x, y) |
因为我们已经将服务的类型声明为 AddTwoInts,所以它会为你生成 AddTwoIntsRequest 对象(可以自由传递)。返回值是 AddTwoIntsResponse 对象。如果调用失败,可能会抛出 rospy.ServiceException,因此你应该设置适当的 try/except 块。
06 功能包的编译
我们使用 CMake 作为构建系统,是的,即使是 Python 节点也必须使用它。这是为了确保创建消息和服务时自动生成 Python 代码。
1 | $ cd ~/catkin_ws |
07 测试 service 和 client
7.1 运行 Service
第一步,打开一个命令行终端:
1 | $ roscore |
第二步,打开第二个命令行终端:
1 | # 用 rosrun <package_name> <node_name> 启动功能包中的发布节点。 |
你将看到如下的输出信息:
1 | Ready to add two ints. # Server 节点启动后的日志信息 |
7.2 运行 Client
现在,运行 Client 并附带一些参数:
打开第三个命令行客户端:
1 | $ source ~/catkin_ws/devel/setup.bash # 激活 catkin_ws 工作空间(必须有,必不可少) |
你将会看到如下的输出信息:
1 | # Client 启动后发布服务请求,并成功接收到反馈结果 |
现在,你已经成功地运行了你的第一个 Service 和 Client 程序。