《动手学ROS2》4.2话题通信实现(Python)

本系列教程作者：小鱼
公众号：鱼香ROS
QQ交流群：139707339
教学视频地址：小鱼的B站
完整文档地址：鱼香ROS官网
版权声明：如非允许禁止转载与商业用途。

4.2.1 话题通信Python实现

本节小鱼将带你一起，通过Python完成李四发布话题（sexy_girl）《艳娘传奇》。

大家都知道白嫖是不对的（看了小鱼视频一定要一键三连），这里我们再加一个需求，让作家李四订阅一个话题来收稿费（sexy_girl_money），让王二发布（sexy_girl_money）话题来支付稿费。

接下来快和小鱼一起动手学习编写Python的话题发布者和订阅者吧~

1.发布话题(sexy_girl)

1.1 如何编写

如何创建一个话题发布者呢？其实很简单，大家记得我们创建作家这个类WriterNode的时候让其继承了Node节点，像下面这样：

class WriterNode(Node):

这是什么意思呢？

大家是否还记得小鱼在3.4.3章节中，介绍的面向对象编程OOP，其中就小鱼说到OOP的三大特性之一的继承，这种在自己类的名字里写一个Node的意思就是让WriterNode继承于Node，这样WriterNode就能拥有Node所具备的属性和能力（行为）。

大家可以把Node理解成人类，作家类（WriterNode）继承于人类（Node）,李四是一名作家，也可以说李四是一个人类,人类所具备的手和脚等器官（属性），能说话、吃饭、刷B站和关注小鱼的公众号了，通过继承WriterNode也具备这些能力，李四作为作家类的对象自然可以完成上述动作。

那代码里的WriterNode继承Node之后，会具备什么能力呢？在本节中用到了以下四个能力：

• 创建一个话题发布者的能力
• 创建一个定时器的能力
• 创建一个话题订阅者的能力
• 获取日志打印器的能力

除了上述四种能力之外，Node节点所具备的详细的能力可以查看API：https://docs.ros2.org/foxy/api/rclpy/index.html

接下来我们就依次调用WriterNode所继承的能力来实现订阅发布功能。

1.2 编写程序

编写一个话题发布者一流程：

1. 导入消息类型

2. 声明并创建发布者

3. 编写发布逻辑发布数据

用VsCode打开上一章中town_ws工作空间，并打开li4.py。我们在其中添加代码即可。

添加完成后WriterNode类中代码如下：

#!/usr/bin/env python3
import rclpy
from rclpy.node import Node
# 1. 导入消息类型
from std_msgs.msg import String


class WriterNode(Node):
    """
    创建一个李四节点，并在初始化时输出一个话
    """
    def __init__(self,name):
        super().__init__(name)
        self.get_logger().info("大家好，我是%s,我是一名作家！" % name)
        # 2.创建并初始化发布者成员属性pubnovel
        self.pub_novel = self.create_publisher(String,"sexy_girl", 10) 

        #3. 编写发布逻辑
        # 创建定时器成员属性timer
        self.i = 0 # i 是个计数器，用来算章节编号的
        timer_period = 5  #每5s写一章节话
        self.timer = self.create_timer(timer_period, self.timer_callback)  #启动一个定时装置，每 1 s,调用一次time_callback函数


    def timer_callback(self):
        """
        定时器回调函数
        """
        msg = String()
        msg.data = '第%d回：潋滟湖 %d 次偶遇胡艳娘' % (self.i,self.i)
        self.pub_novel.publish(msg)  #将小说内容发布出去
        self.get_logger().info('李四:我发布了艳娘传奇："%s"' % msg.data)    #打印一下发布的数据，供我们看
        self.i += 1 #章节编号+1

1.3 代码讲解

1.3.1 创建发布者

self.create_publisher(String,"sexy_girl", 10) 

小鱼这里使用create_publisher方法来创建的发布者，该方法一共有三个参数，第一个是方法类型，第二个是话题名称，第三个是消息队列长度，第一个参数我们这里添了String，需要注意的是，这里的String并非Python自带的字符串类型，我们使用

from std_msgs.msg import String

从std_msgs.msg中导入了String类，那std_msgs是什么呢？

std_msgs是ROS2自带的接口类型，其中规定了我们常用的大多数消息类型，可以使用下面的指令来查看std_msgs中所有的消息类型。

ros2 interface package std_msgs

大家可以根据自己的传输需要选择适合自己的消息类型，比如我们接下来想让李四收钱，我们将消息类型设置为UInt32，无符号整型，毕竟收钱没有收成负数的。

还可以使用 ros2 interface list查看所有ros2自带的消息类型。

需要注意的是，ros2中自带的类型基本上能够满足我们日常做机器人时的使用，但如果ros2中的消息类型不能满足我们的需求时，也可以选择自己定义消息类型。

1.3.2 编写发布逻辑发布数据

这里小鱼使用了一个方法来创建一个定时器

self.create_timer(timer_period, self.timer_callback)

这个定时器的作用就是根据传入的timer_period时间周期，每隔一个timer_period秒，调用一次self.timer_callback函数。

在self.timer_callback函数里，我们使用publish方法将数据（小说内容）发送出去。也就是说每1s中发送一次小说内容。

self.write.publish(msg)  #将小说内容发布出去

2.测试是否发布成功

完成上面的代码后，我们就可以编译运行节点了。

在VsCode中可以使用下面的命令打开和拆分终端：

单独编译李家村，可以使用下面的指令来单独编译某一个功能包。

colcon build --packages-select  village_li

运行节点

source install/setup.bash
ros2 run village_li li4_node

3.订阅收钱话题(sexy_girl_money)

毕竟作家还要过生活的，不能给别人免费看，所以作家要建立了一个收钱话题（sexy_girl_money），专门用来收艳娘传奇的稿费。

3.1 代码编写

创建话题订阅者的一般流程：

1. 导入订阅的话题接口类型

2. 创建订阅回调函数

3. 声明并创建订阅者

4. 编写订阅回调处理逻辑

在上一部分代码的基础上添加了创建订阅器的函数：

self.create_subscription(UInt32,"sexy_girl_money",self.recv_money_callback,10)

这句话的意思是创建订阅者，订阅话题sexy_girl_money,话题类型为UInt32,每次收到钱就去调用self.recv_money_callback函数存起来。

完整代码如下：

#!/usr/bin/env python3
import rclpy
from rclpy.node import Node
# 导入话题消息类型
from std_msgs.msg import String,UInt32

class WriterNode(Node):
    """
    创建一个李四节点，并在初始化时输出一个话
    """
    def __init__(self,name):
        super().__init__(name)
        self.get_logger().info("大家好，我是%s,我是一名作家！" % name)
        # 创建并初始化发布者成员属性pubnovel
        self.pubnovel = self.create_publisher(String,"sexy_girl", 10) 


        # 创建定时器成员属性timer
        self.i = 0 # i 是个计数器，用来算章节编号的
        timer_period = 5  #每5s写一章节话
        self.timer = self.create_timer(timer_period, self.timer_callback)  #启动一个定时装置，每 1 s,调用一次time_callback函数


        # 账户钱的数量
        self.account = 80
        # 创建并初始化订阅者成员属性submoney
        self.submoney = self.create_subscription(UInt32,"sexy_girl_money",self.recv_money_callback,10)
        

    def timer_callback(self):
        """
        定时器回调函数
        """
        msg = String()
        msg.data = '第%d回：潋滟湖 %d 次偶遇胡艳娘' % (self.i,self.i)
        self.pubnovel.publish(msg)  #将小说内容发布出去
        self.get_logger().info('李四:我发布了艳娘传奇："%s"' % msg.data)    #打印一下发布的数据，供我们看
        self.i += 1 #章节编号+1


    def recv_money_callback(self,money):
        """
        4. 编写订阅回调处理逻辑
        """
        self.account += money.data
        self.get_logger().info('李四：我已经收到了%d的稿费' % self.account)


def main(args=None):
    """
    ros2运行该节点的入口函数，可配置函数名称
    """
    rclpy.init(args=args) # 初始化rclpy
    node = WriterNode("li4")  # 新建一个节点
    rclpy.spin(node) # 保持节点运行，检测是否收到退出指令（Ctrl+C）
    rclpy.shutdown() # rcl关闭

4.测试是否订阅成功

再次编译运行李家村。

colcon build --packages-select  village_li
source install/setup.bash
ros2 run village_li li4_node

使用Ctrl+Shift+5切分一个终端出来，然后通过命令行发布话题数据：

ROS2支持下面两种方式，其中方式2最后是有一个空格的，大家注意

ros2 topic pub  /sexy_girl_money std_msgs/msg/UInt32 "{data: 10}"

你可以看到，李四已经收到共计50块钱的稿费了。

5.总结

至此，相信你已经掌握了，如何编写一个Python的节点并进行话题订阅和发布了。

下一节小鱼将带你一起，动手帮王二订阅sexy_girl话题，并支付稿费，让我们继续加油吧~

作者介绍：

我是小鱼，机器人领域资深玩家，现深圳某独脚兽机器人算法工程师一枚
初中学习编程，高中开始接触机器人，大学期间打机器人相关比赛实现月入2W+（比赛奖金）
目前在输出机器人学习指南、论文注解、工作经验，欢迎大家关注小智，一起交流技术，学习机器人