引言
ROS 中各个 node 通过 topic 传输数据。topic 可以直观理解成通讯管道,每个 topic 里面传输的 message 具有相同的类型。之所以为 message 设定不同的类型,主要目的是传输数据方便。
例如某个 topic 中传递的是某一点的坐标,那么可以用 geometry_msgs/Point
类型的 message,其内部数据结构如下:
float64 x
float64 y
float64 z
即三维空间中的坐标 x,y,z,每个坐标值的类型都是 float64。
再例如,topic 中传递的数据不仅要包括某点的坐标,还要有对应的测量时间,此时可以用 geometry_msgs/PointStamped
类型的 msg,内部结构如下:
std_msgs/Header header
geometry_msgs/Point point
该 msg 结构包括两部分:
-
std_msgs/Header
类型的 header field -
geometry_msgs/Point
类型的 point field
进一步地,std_msgs/Header
类型的 msg 结构如下:
uint32 seq
time stamp
string frame_id
包括该 msg 的序号,时间戳,所在参考系的 id。可见,msg 类型可以嵌套,由简单的 msg 类型构造更复杂的类型,从而满足不同的传输需求。
另外有些 msg 结构中还可以包含 list,例如 geometry_msgs/PoseArray
内部数据结构如下:
std_msgs/Header header
geometry_msgs/Pose[] poses
其中 poses field 可以包含一组 geometry_msgs/Pose
类型的数据,即一个 list ,其中每个元素都是 geometry_msgs/Pose
类型。既然是 list,就可以用下边的方式赋值(仅做参考):
msg = PoseArray()
for i in range(10):
pose = Pose()
pose.position.x = i
msg.poses.append(pose)
pub.publish(msg)
使用场景例如在某个时刻检测到一组目标,传送它们对应的 poses。如果在 [ ]
中指定了数目,则数组中的元素数目必须匹配,如果仅仅是空的 [ ]
,则元素数目任意。
ROS 自带了大量的 msg 类型 (参考官网)。基本可以满足我们的需要。但也有些项目有特定的需求,需要自定义 msg 类型,以方便数据传输。
这篇文章主要介绍了如何自定义一个简单的 msg 类型,并像其他内置 msg 类型一样使用它。
目标
我们希望自定义一个 msg 类型,叫做 gps,内部数据结构如下:
string state
float32 x
float32 y
其中,state 对应 gps 工作的状态,x,y 对应 gps 的位置读数。
在定义了上述 gps msg 基础上,创建一个节点发布 gps 数据,另一个节点接收该数据并计算 gps 当前读数(x,y)到原点的距离。
创建 gps msg 类型
在我的 workspace catkin_ws 中目前有一个 package,名为 agitr。为了简单起见,就直接把自定义的 msg 放在这个 package 中了。在这个 package 中建一个文件夹,名为 msg
,专门存放 gps msg 以及未来可能自定义的其他 msg。 用任意一款文本编辑器(vim, vs code, emacs ...)将前述 gps 数据结构写入一个文本文件中,命名为 gps.msg
。
创建完gps.msg
文件后,需要修改CMakeLists.txt
文件和package.xml
文件,以便后续的 catkin 编译。
- 在
CMakeLists.txt
文件中只需要两处修改:
find_package(catkin REQUIRED COMPONENTS message_generation)
add_message_files(
FILES
gps.msg
)
即
- 将 message_generation 这个 package 作为依赖加入 find_package( );
- 添加自定义的 gps.msg 文件
- 在package.xml文件中添加如下依赖:
<build_depend>message_generation</build_depend>
<exec_depend>message_runtime</exec_depend>
设置完上述两个文件之后,用 catkin_make 编译 package agitr
。然后,为了确认已经成功创建了 gps msg ,可以用命令
rosmsg list
查看所有可用的 ros msg。如果一切顺利,应该可以看到自定义的 msg: agitr/gps ,这里 msg 的命名规则为: package/msg。
gps 数据发布
编写名为 pytalker.py
的文件如下:
#!/usr/bin/env python
#coding=utf-8
import rospy
#导入自定义的数据类型
from agitr.msg import gps
def talker():
#Publisher 函数第一个参数是 topic 名称,第二个参数为数据类型,就是我们定义的 msg ,最后一个是缓存区队列的大小
#queue_size: None(不建议) #这将设置为阻塞式同步收发模式!
#queue_size: 0(不建议)#这将设置为无限缓冲区模式,很危险!
#queue_size: 10 or more #一般情况下,设为10 queue_size太大了会导致数据延迟、不同步.
pub = rospy.Publisher('gps_info',gps,queue_size=10)
rospy.init_node('pytalker',anonymous=True)
#更新频率是1hz
rate=rospy.Rate(1)
x=1.0
y=2.0
state='working'
while not rospy.is_shutdown():
# 发布 gps 位置 x,y,并不断更新
rospy.loginfo('Talker: GPS: x=%f,y=%f',x,y)
pub.publish(gps(state,x,y))
x=1.03*x
y=1.01*y
rate.sleep()
if __name__=='__main__':
talker()
可以将上述 python 程序存放在 catkin_ws/src/agitr/scripts
路径下。
gps 数据接收节点
名为pylistener.py
,代码如下:
#!/usr/bin/env python
#coding=utf-8
import rospy
import math
#导入mgs
from agitr.msg import gps
def callback(gps):
distance=math.sqrt(math.pow(gps.x,2)+math.pow(gps.y,2))
rospy.loginfo('Listener: GPS: distance=%f, state=%s', distance, gps.state)
def listener():
rospy.init_node('pylistener',anonymous=True)
#Subscriber函数第一个参数是topic的名称,第二个参数是接受的数据类型 第三个参数是回调函数的名称
rospy.Subscriber('gps_info', gps, callback)
rospy.spin()
if __name__=='__main__':
listener()
当我们建立了以上两个文件后,还要将它们设置为可执行文件,操作如下:
chmod +x pytalker.py
chmod +x pylistener.py
到这里就完成了所有的工作。通过以下命令测试 gps msg 的收发:
roscore
rosrun agitr pytalker.py
rosrun agitr pylistener.py
如果一切顺利,应该可以看到 pytalker 不断发布 gps 位置信息,pylistener 将 (x,y) 坐标转化为到原点的距离。
written by SH
revised by QP