ROS-rospy | Malloy Yuan的博客

type

status

date

slug

summary

1. rospy与主要接口

1.1. rospy vs roscpp

rospy是Python版本的ROS客户端库，提供了Python编程需要的接口，你可以认为rospy就是一个Python的模块(Module)。这个模块位于/opt/ros/kineetic/lib/python2.7/dist-packages/rospy之中。

rospy包含的功能与roscpp相似，都有关于node、topic、service、param、time相关的操作。但同时rospy和roscpp也有一些区别：

rospy没有一个NodeHandle，像创建publisher、subscriber等操作都被直接封装成了rospy中的函数或类，调用起来简单直观。

rospy一些接口的命名和roscpp不一致，有些地方需要开发者注意，避免调用错误。

相比于C++的开发，用Python来写ROS程序开发效率大大提高，诸如显示、类型转换等细节不再需要我们注意，节省时间。但Python的执行效率较低，同样一个功能用Python运行的耗时会高于C++。因此我们开发SLAM、路径规划、机器视觉等方面的算法时，往往优先选择C++。

ROS中绝大多数基本指令，例如rostopicroslaunch都是用python开发的，简单轻巧。

2. ROS中Python代码的组织方式

要介绍rospy，就不得不提Python代码在ROS中的组织方式。通常来说，Python代码有两种组织方式，一种是单独的一个Python脚本，适用于简单的程序，另一种是Python模块，适合体量较大的程序。

2.1. 单独的Python脚本

对于一些小体量的ROS程序，一般就是一个Python文件，放在script/路径下，非常简单。

2.2. Python模块

当程序的功能比较复杂，放在一个脚本里搞不定时，就需要把一些功能放到Python Module里，以便其他的脚本来调用。ROS建议我们按照以下规范来建立一个Python的模块：

在src下建立一个与你的package同名的路径，其中存放_init_.py以及你的模块文件。这样就建立好了ROS规范的Python模块，你可以在你的脚本中调用。如果你不了解init.py的作用，可以参考这篇博客http://www.cnblogs.com/Lands-ljk/p/5880483.html ROS中的这种Python模块组织规范与标准的Python模块规范并不完全一致，你当然可以按照Python的标准去建立一个模块，然后在你的脚本中调用，但是我们还是建议按照ROS推荐的标准来写，这样方便别人去阅读。

通常我们常用的ROS命令，大多数其实都是一个个Python模块，源代码存放在ros_comm仓库的tools路径下：https://github.com/ros/ros_comm/tree/lunar-devel/tools 你可以看到每一个命令行工具（如rosbag、rosmsg）都是用模块的形式组织核心代码，然后在script/下建立一个脚本来调用模块。

3. 常用rospy的API

这里分类整理了rospy常见的一些用法，请你浏览一遍，建立一个初步的影响。具体API请查看http://docs.ros.org/api/rospy/html/rospy-module.html

3.1. Node相关

返回值	方法	作用
ㅤ	rospy.init_node(name, argv=None, anonymous=False)	注册和初始化node
MasterProxy	rospy.get_master()	获取master的句柄
bool	rospy.is_shutdown()	节点是否关闭
ㅤ	rospy.on_shutdown(fn)	在节点关闭时调用fn函数
str	get_node_uri()	返回节点的URI
str	get_name()	返回本节点的全名
str	get_namespace()	返回本节点的名字空间
...	...	...

3.2. Topic相关

函数：

返回值	方法	作用
[[str, str]]	get_published_topics()	返回正在被发布的所有topic名称和类型
Message	wait_for_message(topic, topic_type, time_out=None)	等待某个topic的message
ㅤ	spin()	触发topic或service的回调/处理函数，会阻塞直到关闭节点
...	...	...

Publisher类：

返回值	方法	作用
ㅤ	init(self, name, data_class, queue_size=None)	构造函数
ㅤ	publish(self, msg)	发布消息
str	unregister(self)	停止发布
...	...	...

Subscriber类：

返回值	方法	作用
ㅤ	init_(self, name, data_class, call_back=None, queue_size=None)	构造函数
ㅤ	unregister(self, msg)	停止订阅
...	...	...

3.3. Service相关

函数：

返回值	方法	作用
ㅤ	wait_for_service(service, timeout=None)	阻塞直到服务可用
...	...	...

Service类(server)：

返回值	方法	作用
ㅤ	init(self, name, service_class, handler)	构造函数，handler为处理函数，service_class为srv类型
ㅤ	shutdown(self)	关闭服务的server
...	...	...

ServiceProxy类(client)：

返回值	方法	作用
ㅤ	init(self, name, service_class)	构造函数，创建client
ㅤ	call(self, args, *kwds)	发起请求
ㅤ	call(self, args, *kwds)	同上
ㅤ	close(self)	关闭服务的client
...	...	...

3.4. Param相关

函数：

返回值	方法	作用
XmlRpcLegalValue	get_param(param_name, default=_unspecified)	获取参数的值
[str]	get_param_names()	获取参数的名称
ㅤ	set_param(param_name, param_value)	设置参数的值
ㅤ	delete_param(param_name)	删除参数
bool	has_param(param_name)	参数是否存在于参数服务器上
str	search_param()	搜索参数
...	...	...

3.5. 时钟相关

函数：

返回值	方法	作用
Time	get_rostime()	获取当前时刻的Time对象
float	get_time()	返回当前时间，单位秒
ㅤ	sleep(duration)	执行挂起
...	...	...

Time类：

返回值	方法	作用
ㅤ	init(self, secs=0, nsecs=0)	构造函数
Time	now()	静态方法返回当前时刻的Time对象
...	...	...

Duration类：

返回值	方法	作用
ㅤ	init(self, secs=0, nsecs=0)	构造函数
...	...	...

4. topic in rospy

与5.3节类似，我们用python来写一个节点间消息收发的demo，同样还是创建一个自定义的gps类型的消息，一个节点发布模拟的gps信息，另一个接收和计算距离原点的距离。

4.1. 自定义消息的生成

gps.msg定义如下：

我们需要修改CMakeLists.txt文件，方法见5.3节，这里需要强调一点的就是，对创建的msg进行catkin_make会在~/catkin_ws/devel/lib/python2.7/dist-packages/topic_demo下生成msg模块（module）。有了这个模块，我们就可以在python程序中from topic_demo.msg import gps,从而进行gps类型消息的读写。

4.2. 消息发布节点

与C++的写法类似，我们来看topic用Python如何编写程序，见topic_demo/scripts/pytalker.py：

以上代码与C++的区别体现在这几个方面：

rospy创建和初始化一个node，不再需要用NodeHandle。rospy中没有设计NodeHandle这个句柄，我们创建topic、service等等操作都直接用rospy里对应的方法就行。

rospy中节点的初始化并一定得放在程序的开头，在Publisher建立后再初始化也没问题。

消息的创建更加简单，比如gps类型的消息可以直接用类似于构造函数的方式gps(state,x,y)来创建。

日志的输出方式不同，C++中是ROS_INFO()，而Python中是rospy.loginfo()

判断节点是否关闭的函数不同，C++用的是ros::ok()而Python中的接口是rospy.is_shutdown()

通过以上的区别可以看出，roscpp和rospy的接口并不一致，在名称上要尽量避免混用。在实现原理上，两套客户端库也有各自的实现，并没有基于一个统一的核心库来开发。这也是ROS在设计上不足的地方。

ROS2就解决了这个问题，ROS2中的客户端库包括了rclcpp(ROS Clinet Library C++)、rclpy(ROS Client Library Python),以及其他语言的版本，他们都是基于一个共同的核心ROS客户端库rcl来开发的，这个核心库由C语言实现。

4.3. 消息订阅节点

见topic_demo/scripts/pylistener.py：

在订阅节点的代码里，rospy与roscpp有一个不同的地方：rospy里没有spinOnce()，只有spin()。

建立完talker和listener之后，经过catkin_make，就完成了python版的topic通信模型。

5. Service in rospy

本节用python来写一个节点间，利用Service通信的demo，与5.4类似，创建一个节点，发布模拟的gps信息，另一个接收和计算距离原点的距离。

5.1. srv文件

在5.4节，我们已经说过要建立一个名为Greeting.srv的服务文件，内容如下：

然后修改CMakeLists.txt文件。ROS的catkin编译系统会将你自定义的msg、srv（甚至还有action）文件自动编译构建，生成对应的C++、Python、LISP等语言下可用的库或模块。许多初学者错误地以为，只要建立了一个msg或srv文件，就可以直接在程序中使用，这是不对的，必须在CMakeLists.txt中添加关于消息创建、指定消息/服务文件那几个宏命令。

5.2. 创建提供服务节点(server)

见service_demo/scripts/server_demo.py：

以上代码中可以看出Python和C++在ROS服务通信时，server端的处理函数有区别： C++的handle_function()传入的参数是整个srv对象的request和response两部分，返回值是bool型，显示这次服务是否成功的处理，也就是：

而Python的handle_function()传入的只有request，返回值是response，即：

这也是ROS在两种语言编程时的差异之一。相比来说Python的这种思维方式更加简单，符合我们的思维习惯。

5.3. 创建服务请求节点(client)

service_demo/srv/client.cpp内容如下：

以上代码中greetings_client.call("HAN",20)等同于greetings_client("HAN",20)。

6. param与time

6.1. param_demo

相比roscpp中有两套对param操作的API，rospy关于param的函数就显得简单多了，包括了增删查改等用法： rospy.get_param()，rospy.set_param()，rospy.has_param()，rospy.delete_param()，rospy.search_param()，rospy.get_param_names()。

下面我们来看看param_demo里的代码：

6.2. time_demo

6.3. 时钟

rospy中的关于时钟的操作和roscpp是一致的，都有Time、Duration和Rate三个类。首先，Time和Duration前者标识的是某个时刻（例如今天22:00），而Duration表示的是时长(例如一周)。但他们具有相同的结构（秒和纳秒）：

6.3.1. 创建Time和Duration：

rospy中的Time和Duration的构造函数类似，都是_init_(self,secs=0, nsecs=0),指定秒和纳秒(1ns = 10^{-9}s1n**s=10−9s)

关于Time、Duration之间的加减法和类型转换，和roscpp中的完全一致，请参考5.6节，此处不再重复。

6.3.2. sleep

关于sleep的方法，Rate类中的sleep主要用来保持一个循环按照固定的频率，循环中一般都是发布消息、执行周期性任务的操作。这里的sleep会考虑上次sleep的时间，从而使整个循环严格按照指定的频率。

6.3.3. 定时器Timer

rospy里的定时器和roscpp中的也类似，只不过不是用句柄来创建，而是直接rospy.Timer(Duration, callback)，第一个参数是时长，第二个参数是回调函数。

同样不要忘了rospy.spin()，只有spin才能触发回调函数。回调函数的传入值是TimerEvent类型，该类型包括以下几个属性：