ROS Topic 相关API接口与命令行介绍

本文涉及的产品
资源编排,不限时长
简介: ROS Topic 相关API接口与命令行介绍

一、Topic

1.1 常用函数接口

ros::Publisher类

// 两个重载函数模板,用于发布topic消息
template <typename M>
void publish(const boost::shared_ptr<M>& message) const

template <typename M>
void publish(const M& message) const
// 关闭与此发布者关联的广播
void shutdown()

// 还不知道怎么用,mark一下,有知道的欢迎评论区留言
boost::function<void(const SubscriberLinkPtr &)> getLastMessageCallback()

// 获取与此发布者关联的订阅者的数量
uint32_t getNumSubscribers() const

// 获取此发布者发布的topic
std::string getTopic() const

// 此发布者是否为锁存模式
// 锁存模式:记录发布的最后一条消息,每有订阅者连接发布一次最后一条消息
// 通过advertise函数设置
bool isLatched() const

ros::Subscriber类

// 获取与此订阅者关联的发布者的数量
uint32_t getNumPublishers() const

// 获取此订阅者订阅的topic
std::string getTopic() const

// 关闭与此订阅者关联的广播
void shutdown ()

1.2 常用命令行工具

rostopic相关

rostopic bw    显示主题使用的带宽
rostopic delay 显示带header的topic的网络延迟
rostopic echo  将消息打印到屏幕
rostopic find  按类型查找主题
rostopic hz    显示主题的发布率
rostopic info  打印关于活动主题的信息
rostopic list  打印有关活动主题的信息
rostopic pub   将数据发布到主题
rostopic type  打印主题类型
1.2.1 rostopic bw
rostopic bw <topic-name>
rostopic bw /rosout

显示topic使用的带宽,显示的带宽是subscriber端的带宽,由于rostopic是用python实现的,所以实际速度可能会低于c++实现的ros节点。

比如topic为/rosout ,发布默认消息

c939c680b8fb41c6b67dcddb69286b0b.png

则subscribe端的带宽为

beb44f1274f946078fa960cf06b207eb.png

其中,

average:带宽。

mean:从开始通信到现在,每次通信的平均数据量。

min:从开始通信到现在,最小的一次通信数据量。

max:从开始通信到现在,最大的一次通信数据量。

window:应该是从开始通信到现在接收数据的次数,但到100就不再增加了。作者代码里使用队列存储时间戳记录通信,通过获取队列大小得到通信次数,为限制内存开销,作者将队列大小限制为100,将队首元素pop,并将新时间戳加入队列,但pop后作者没有对记录通信次数的变量加1,所以window到100就不再增加了。

1.2.2 rostopic delay
rostopic delay <topic-name>
rostopic delay /rosout

显示带header的topic的网络延迟(因为header会记录msg发出时的时间戳),即msg从advertiser发出到subscriber接收经过的时间。

自己写一个测试topic /log 代码如下,

#!/usr/bin/python3
#-*- coding:utf-8 -*-

import rospy
from rosgraph_msgs.msg import Log

if __name__ == '__main__':

    rospy.init_node('log')

    log = rospy.Publisher('/log', Log, queue_size=10)

    rate = rospy.Rate(10)

    while not rospy.is_shutdown():
        log_msg = Log()
        log_msg.header.stamp = rospy.get_rostime()

        log.publish(log_msg)
        rospy.loginfo("Publish log message %s", log_msg)

        rate.sleep()

则该topic的网络延迟为

671f6f5da545415dad863f64ec14d61a.png

其中,

average delay :从开始通信到现在,所有通信的平均延迟时间,单位:s

min:从开始通信到现在,所有通信中延迟时间最小的一次

max:从开始通信到现在,所有通信中延迟时间最大的一次

std dev:从开始通信到现在,所有通信延迟数据的标准差,表征延迟数据的波动大小,标准差越小表示延迟数据波动越小。

window:和 rostopic bwwindow 一样,不过它的队列大小限制为50000。

1.2.3 rostopic echo
rostopic echo <topic-name>
rostopic echo /rosout

将消息内容打印到屏幕

d4cf5b07e28b4c65a0ac4eceb142d5d0.png

rostopic echo 有自己的参数选项,如下,

rostopic echo --offset    
rostopic echo --filter
rostopic echo -c
rostopic echo -b
rostopic echo -p
rostopic echo -p --nostr
rostopic echo -p --noarr
rostopic echo -w
rostopic echo -n
rostopic echo --offset

在打印的消息中显示advertiser发布时间与subscriber接收时间的偏移量,和delay一样,topic要有header,否则打印中没有时间戳。

rostopic echo --offset /topic_name

测试程序如下:

自定义msg:

# HeaderString.msg
# 自定义msg
std_msgs/Header header
string data

offset节点源文件:

package名称为mbot_communication,自建包需相应修改

#include "ros/ros.h"
#include "mbot_communication/HeaderString.h"

int main(int argc, char **argv)
{
    ros::init(argc, argv, "offset");

    ros::NodeHandle n;
    ros::Publisher chatter_pub = n.advertise<mbot_communication::HeaderString>("/offset", 1000);

    ros::Rate loop_rate(5);

    int count = 0;

    while (ros::ok())
    {
        mbot_communication::HeaderString msg;
        msg.header.stamp = ros::Time::now();
        std::stringstream ss;
        ss << "hello world " << count;
        msg.data = ss.str();

        chatter_pub.publish(msg);

        ROS_INFO("sec: %d, nsec: %d, data: %s", msg.header.stamp.sec, msg.header.stamp.nsec, msg.data.c_str());

        ros::spinOnce();

        loop_rate.sleep();
        ++count;
    }

    return 0;
}

启动offset节点后,执行以下命令会有相应打印:

f2dc35ccd4674304bcbb7829ec45c297.png

其中,

stamp是时间戳,这里是advertiser发布时间与subscriber接收时间的偏移量,stamp = advertiser发布时间戳 - subscriber接收时间戳,secs是秒,nsecs是纳秒,1秒= $1*10^{-9}$ 纳秒,上图第一个消息的偏移量就是 $-1+998923014*10^{-9} = -0.001076986(s)$ 。

rostopic echo --filter

显示与指定python语法的逻辑表达式匹配的消息

rostopic echo --filter "逻辑表达式"  /topic_name
rostopic echo --filter "m.data=='foo'"  /topic_name

可以对消息内容做逻辑匹配,比如上述自定义 /offset topic,只显示seq为偶数的消息,

6f92926dce5847feabddcd5cf881d06a.png

默认消息变量为 m,使用.表示字段包含关系,只支持匹配数字和字符串,

支持python的所有内置运算符和内置函数,比如对于数字,支持 +-***///% 等数学运算,&|~^<<>> 等位运算,pow()abs()round()max() 等内置函数,对于字符串,支持 split()upper()find()len() 等内置函数,就是那种使用时不需要另外import包的函数在这里都支持。

对于逻辑运算支持 ==!=><>=<=andor 等。

另外,如果和字符或字符串进行比较,需要用 '' 括起来。

再给两个例子,其他自己探索吧:

a1c3f8e134e940599b9de8275841e812.png

cbaa2c003e35474c9db4774adb2dc87a.png

rostopic echo -c

打印每条消息前清除屏幕,不能与 -p 一起使用。

rostopic echo -c /topic_name
rostopic echo -b

显示bag文件中录制的topic

rostopic echo -b log_file.bag /topic_name

录制了一段/offset的消息,使用该命令打印如下:

4e3fb4e96153401cb74192d23c17b8f8.png

.bag有特定的编码格式,不能直接打开,如果想直接查看bag记录的内容而不想每次播放bag,可以使用这个命令将bag内容重定向,offset.txt文件就可以随时打开查看了。

2b521acb8d6b4697be7c0ef4ae9f0d6a.png

rostopic echo -b 一起用的还有一个 -a 参数选项,用来显示 bag 文件中记录的所有消息,也就是 rostopic echo -b log_file.bag 后面如果接 topic 名字,就显示对应 topic 的消息内容,如果接 -a 就显示所有消息。

77c5926499ea4dcfbb768b9adcc45f28.png

02b3f68a96554e2aa32ed76d643a9bdb.png

95d51e8a4e9547dbb0e1d6e4f4dc28f3.png

显示所有消息时,是按照记录时的时间顺序打印每条消息的。

rostopic echo -p

以 matlab/octave 友好的格式显示消息。不能与 -c 一起使用。

rostopic echo -p /topic_name

45d2b29c435b45bab75c3d7a496cf130.png

其中,以%开头的第一行是标题,按顺序对应每行以 , 隔开的变量名。

rostopic echo -p 还有两个参数选项,--nostr--noarr ,分别代表 忽略字符串忽略数组

a5be5274cbb3492faaf501a4136c5bc7.png

使用 --nostr 参数选项后,忽略掉了字符串类型的 frame_iddata

rostopic echo -w

以固定宽度 NUM_WIDTH 打印所有数值,如果 NUM_WIDTH 小于实际宽度,则以实际宽度打印。

rostopic echo -w NUM_WIDTH /topic_name

5198d6b37ecf4c26bb3fa4b1349aba77.png

每个数字的宽度为13,实际宽度不足13的,在数字前面补空格。

符合python的 % 占位符规则,具体可查询 python % 占位符

rostopic echo -n

打印接收到的 COUNT 条消息并退出。

rostopic echo -n COUNT /topic_name

cddc7c75f28a46da80ef1522397c264d.png

1.2.4 rostopic find
rostopic find <msg-type>
rostopic find rosgraph_msgs/Log

按照 topic 的消息类型查找运行的 topic

50f15b813aba40c0b2442294f5e542ec.png

1.2.5 rostopic hz
rostopic hz <topic-name>
rostopic hz /rosout

显示主题的发布率。默认情况下,报告的速率是 rostopic 运行期间的平均速率。

933a9b01006342c19ab1d63bf38067ed.png

rostopic delay 的打印类似,其中,

average rate :从开始通信到现在,所有通信的平均发布率,单位:Hz

min:从开始通信到现在,所有通信中发布周期最小的一次

max:从开始通信到现在,所有通信中发布周期最大的一次

std dev:从开始通信到现在,所有通信发布周期的标准差,表征发布周期的波动大小,标准差越小表示波动越小。

window:从开始通信到现在接收数据的次数,队列限制大小50000。

rostopic hz 的参数选项如下:

rostopic hz -w 
rostopic hz --filter
rostopic hz -w

使用窗口大小(样本数)报告速率,以对速率进行时间局部估计。

如不使用 -w 选项,报告的平均速率时从开始通信以来所有通信的平均速率,如使用 -w 则为最近 WINDOW_SIZE 次通信的平均速率。

 rostopic hz -w WINDOW_SIZE /topic_name

e89e72ecbc8b43298b8e9ca72c0d6a87.png

rostopic hz --filter

仅报告指定python语法的逻辑表达式匹配的消息的速率。

逻辑表达式的使用规则同 rostopic echo --filter

此选项对性能有很大影响,不应用于高速率主题。

rostopic hz --filter FILTER_EXPR /topic_name

36acf129bf4941549c8e4252d1a9abc2.png

1.2.6 rostopic info
rostopic info <topic-name>
rostopic info /rosout

打印 topic 的信息

478c1af0509642f1929bd19e42533be8.png

其中,

Type:是 topic 的消息类型

Publishers:是该 topic 的发布者节点名,如果是通过 rostopic 指令发布,则节点名称就是 /rostopic_7739_1651069588197 的命名形式,其中 7739 是节点的 PID(线程ID),

1651069588197 是什么不知道(如果你知道欢迎评论区留言)

Subscribers:是该 topic 的订阅者节点名。

http://Yogo:40683/ 是该节点的网络地址,

02b7478864d14dd480491ccc4304947e.png

1.2.7 rostopic list

列出当前运行的topic

c1acb605aaa845dd9852fee590d3e1bf.png

rostopic的参数选项如下:

rostopic list <namespace>    # 列出指定命名空间中的topic
rostopic list -b <bag_file>  # 列出bag文件中的topic
rostopic list -p  # 只列出发布者
rostopic list -s  # 只列出订阅者
rostopic list -v  # 详细模式
rostopic list --host  # 按主机名分组列表
rostopic list <名空间>

列出指定命名空间中的topic,关于ROS的命名空间,见 ROS WiKi/Names/Graph Resource Names

rostopic list /up

dabc8bab3c8f4314a4ae842ae503ea25.png

rostopic list -b

列出bag文件中的topic

rostopic list -b all.bag

e048cdd2782b4148b5e4051bca2e213c.png

rostopic list -p

只列出有发布者的topic

rostopic list -p
rostopic list -s

只列出有订阅者的topic

rostopic list -s

7daff6fa334042f498eacbc41f9e5d6d.png

rostopic list -v

列出所有topic的详细信息

rostopic list -v

95c00d8a758f4e30951ba9538fc053ab.png

其中包括topic的属性(发布者/订阅者)、topic名、topic消息类型(方括号里的)、该topic发布者/订阅者的数量。

rostopic list --host

按主机名分组列表

rostopic list --host

f90d94a26dc34a119deb38b0db7925eb.png

其中,方括号里是主机名。

1.2.8 rostopic pub

将数据发布到主题

rostopic pub <topic-name> <topic-type> [data...]
rostopic pub /topic_name std_msgs/String "hello"

关于topic发布的三种模式:

  • latching mode
    • 记录发布的最后一条消息,每有订阅者连接,发布一次最后一条消息
    • 默认为这个模式
  • once mode
    • 保持latching模式3秒,然后退出。
  • rate mode
    • 可以自定义消息的发布频率

关于topic发布消息的数据源:

  • 命令行参数(最常用的方法)

    rostopic pub /topic_name std_msgs/String "hello"
    
  • 管道输入

    rostopic echo /chatter | rostopic pub /bar std_msgs/String
    

    这个没发现有什么好用的场景,就是把/chatter的消息内容转发给/bar了。

  • 通过YAML文件输入

    首先要有一个存有msg的文件,可以重定向topic内容:

    rostopic echo /chatter > chatter.bagy
    

    然后使用-f参数选项将文件内容输入到topic

    rostopic pub -f chatter.bagy /bar std_msgs/String
    

​ 关于YAML格式在ROS中的使用,见 YAML on the ROS command line

参数选项:

rostopic pub -l <topic-name> <topic-type> [data...]
rostopic pub --latch <topic-name> <topic-type> [data...]
rostopic pub -r RATE <topic-name> <topic-type> [data...]
rostopic pub -1 <topic-name> <topic-type> [data...]
rostopic pub --once <topic-name> <topic-type> [data...]
rostopic pub -f FILE <topic-name> <topic-type> [data...]
rostopic pub -l/--latch

-l--latch是一样的,代表latching mode

b4799621885c4dfe8ebf942ba67f2d42.png

发布者发布一次消息,并将最后一条消息保存等待,直到有新的订阅者连接,把保存的消息发给新的订阅者(每个新订阅者收到的都是这条保存的消息)

rostopic pub -r RATE

rate modeRATE的单位是Hz

ea57a9c5690a4c4b89e5d7d547808e94.png

发布者按10Hz的频率不停发布消息,订阅者一直接收消息。

rostopic pub -1/--once

-1(注意是数字1) 和 --once 是一样的,代表once mode

rostopic pub -f FILE

通过YAML文件输入

1.2.9 rostopic type

显示topic的消息类型

rostopic type <topic-name>
rostopic type /topic_name

eef9e3ee3fd340059819588f0c80b3e5.png

rosmsg 相关

rosmsg show 显示消息格式内容
rosmsg list 显示消息列表
rosmsg package 显示指定包中的所有消息列表
rosmsg packages 显示所有带有消息的包的列表
rosmsg md5 显示指定消息类型的 md5 总和
1.2.10 rosmsg show
rosmsg show <message type>
rosmsg show std_msgs/String

显示 ROS 消息类型中的字段。

cf54bad7ce384da89b222af18bc33f21.png

如果不知道包名称,也可以只写消息类型,该命令会在所有包中匹配:

c33b262e52894b5c947a3d37eab628d9.png

-r 选项

显示消息原始文件中的所有内容,包括注释。

rosmsg show -r <message-type>

f8d40998e63b4213bfd5fb2fe8378780.png

1.2.11 rosmsg list

显示所有消息列表

rosmsg list

2a34bf988b2c4269885b60aa43dda626.png

1.2.12 rosmsg package

显示指定包中的所有消息列表

rosmsg package <package-name> 
rosmsg package mbot_communication

2141cf78b3714d5b9e2475f406a39cb7.png

-r选项

将消息列表显示在一行

rosmsg package mbot_communication -s

5c6e41d066be4035956434105c3fd523.png

1.2.13 rosmsg packages

显示所有带有消息的包的列表。

rosmsg packages

a847945178114721819234217d77142a.png

-r选项

将包列表显示在一行

rosmsg packages -s

50f3fda05e54491cb89d6af6dd522ab1.png

1.2.14 rosmsg md5

显示指定消息类型的 md5 总和。如果编译的版本不匹配,会发出警告。

rosmsg md5 <message-type>
rosmsg md5 String

ddc4512ec3b14ab5bdb8af90c4eaf1d1.png

二、Service

相关实践学习
使用ROS创建VPC和VSwitch
本场景主要介绍如何利用阿里云资源编排服务,定义资源编排模板,实现自动化创建阿里云专有网络和交换机。
阿里云资源编排ROS使用教程
资源编排(Resource Orchestration)是一种简单易用的云计算资源管理和自动化运维服务。用户通过模板描述多个云计算资源的依赖关系、配置等,并自动完成所有资源的创建和配置,以达到自动化部署、运维等目的。编排模板同时也是一种标准化的资源和应用交付方式,并且可以随时编辑修改,使基础设施即代码(Infrastructure as Code)成为可能。 产品详情:https://www.aliyun.com/product/ros/
相关文章
|
8天前
|
人工智能 自然语言处理 API
Multimodal Live API:谷歌推出新的 AI 接口,支持多模态交互和低延迟实时互动
谷歌推出的Multimodal Live API是一个支持多模态交互、低延迟实时互动的AI接口,能够处理文本、音频和视频输入,提供自然流畅的对话体验,适用于多种应用场景。
52 3
Multimodal Live API:谷歌推出新的 AI 接口,支持多模态交互和低延迟实时互动
|
3天前
|
前端开发 API 数据库
Next 编写接口api
Next 编写接口api
|
10天前
|
XML JSON 缓存
阿里巴巴商品详情数据接口(alibaba.item_get) 丨阿里巴巴 API 实时接口指南
阿里巴巴商品详情数据接口(alibaba.item_get)允许商家通过API获取商品的详细信息,包括标题、描述、价格、销量、评价等。主要参数为商品ID(num_iid),支持多种返回数据格式,如json、xml等,便于开发者根据需求选择。使用前需注册并获得App Key与App Secret,注意遵守使用规范。
|
9天前
|
JSON API 开发者
淘宝买家秀数据接口(taobao.item_review_show)丨淘宝 API 实时接口指南
淘宝买家秀数据接口(taobao.item_review_show)可获取买家上传的图片、视频、评论等“买家秀”内容,为潜在买家提供真实参考,帮助商家优化产品和营销策略。使用前需注册开发者账号,构建请求URL并发送GET请求,解析响应数据。调用时需遵守平台规定,保护用户隐私,确保内容真实性。
|
9天前
|
搜索推荐 数据挖掘 API
淘宝天猫商品评论数据接口丨淘宝 API 实时接口指南
淘宝天猫商品评论数据接口(Taobao.item_review)提供全面的评论信息,包括文字、图片、视频评论、评分、追评等,支持实时更新和高效筛选。用户可基于此接口进行数据分析,支持情感分析、用户画像构建等,同时确保数据使用的合规性和安全性。使用步骤包括注册开发者账号、创建应用获取 API 密钥、发送 API 请求并解析返回数据。适用于电商商家、市场分析人员和消费者。
|
19天前
|
JSON API 开发工具
淘宝实时 API 接口丨淘宝商品详情接口(Taobao.item_get)
淘宝商品详情接口(Taobao.item_get)允许开发者获取商品的详细信息,包括基本信息、描述、卖家资料、图片、属性及销售情况等。开发者需注册账号、创建应用并获取API密钥,通过构建请求获取JSON格式数据,注意遵守平台规则,合理使用接口,确保数据准确性和时效性。
|
20天前
|
JSON 安全 API
Python调用API接口的方法
Python调用API接口的方法
86 5
|
20天前
|
JSON 缓存 监控
淘宝商品详情接口(Taobao.item_get)丨淘宝API接口指南
淘宝商品详情接口(Taobao.item_get)允许开发者通过HTTP GET方法获取淘宝商品的详细信息,包括商品ID、价格、库存等。请求需包含key、secret、num_iid等必选参数,支持缓存及多种返回格式。此接口广泛应用于电商数据分析、商品选品、价格监控等领域,提升商家运营效率。
|
24天前
|
JSON 搜索推荐 API
LAZADA关键词搜索API接口的获取与应用
Lazada作为东南亚领先的电商平台,为满足开发者和商户需求,开放了关键词搜索API接口。本文详细介绍该接口的获取与应用,助力提升电商业务效率。接口支持关键词搜索、指定搜索范围和排序方式,提供精准、灵活且全面的数据支持,促进电商应用和服务的优化与创新。
24 3
|
1月前
|
JSON API 数据库
电商拍立淘按图搜索API接口,数据格式示例
电商拍立淘按图搜索API接口系列为电商平台和购物应用提供了强大的图像搜索功能,以下是其文档说明的详细参考

推荐镜像

更多
下一篇
DataWorks