Apollo自动驾驶平台CyberRT Python API详解-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00925/article/details/148361040

Apollo自动驾驶平台CyberRT Python API详解

apollo An open autonomous driving platform 项目地址: https://gitcode.com/gh_mirrors/apo/apollo

前言

在自动驾驶系统的开发中，实时性和可靠性是至关重要的。Apollo平台中的CyberRT框架正是为解决这些问题而设计的分布式通信中间件。本文将深入解析CyberRT框架的Python API接口，帮助开发者快速上手使用Python进行自动驾驶系统的开发。

CyberRT Python API概述

CyberRT的核心功能虽然是用C++开发的，但为了满足不同开发者的需求，官方提供了完整的Python接口封装。这些Python接口直接调用了底层的C++实现，没有使用第三方封装工具（如swig），这使得接口更加高效且易于维护。

核心功能模块

1. 节点与消息通信

在CyberRT中，节点(Node)是通信的基本单元，开发者可以通过节点创建消息的读取器(Reader)和写入器(Writer)。

基本使用流程

创建节点实例
为节点创建Reader或Writer
对于Writer，使用write方法发送消息
对于Reader，在spin方法中处理回调函数

关键API详解

class Node:
    def create_writer(self, name, data_type, qos_depth=1):
        """
        创建消息写入器
        参数:
            name: 通道名称
            data_type: 消息类型(protobuf类)
            qos_depth: 服务质量队列深度
        """
        
    def create_reader(self, name, data_type, callback, args=None):
        """
        创建消息读取器
        参数:
            name: 通道名称
            data_type: 消息类型
            callback: 消息回调函数
            args: 传递给回调函数的额外参数
        """
        
    def spin(self):
        """启动消息循环处理"""

2. 记录文件操作

CyberRT提供了完善的记录文件(record)操作接口，可以方便地进行数据的录制和回放。

记录读取器(RecordReader)

class RecordReader:
    def read_messages(self, start_time=0, end_time=18446744073709551615):
        """读取指定时间范围内的消息"""
        
    def get_messagenumber(self, channel_name):
        """获取指定通道的消息数量"""
        
    def get_channellist(self):
        """获取记录文件中的所有通道列表"""

记录写入器(RecordWriter)

class RecordWriter:
    def open(self, path):
        """打开记录文件"""
        
    def write_channel(self, channel_name, type_name, proto_desc):
        """写入通道信息"""
        
    def write_message(self, channel_name, data, time, raw=True):
        """写入消息数据"""

3. 时间操作

CyberRT提供了精确的时间操作接口，这对于自动驾驶系统中的时间同步至关重要。

class Time:
    @staticmethod
    def now():
        """获取当前时间"""
        
    @staticmethod
    def mono_time():
        """获取单调时间(不受系统时间调整影响)"""
        
    def sleep_until(self, nanoseconds):
        """精确休眠到指定时间"""

4. 定时器

定时器是自动驾驶系统中常用的组件，CyberRT提供了简洁的定时器接口。

class Timer:
    def set_option(self, period, callback, oneshot=0):
        """
        设置定时器选项
        参数:
            period: 定时周期(毫秒)
            callback: 定时回调函数
            oneshot: 是否只执行一次(0:循环执行 1:执行一次)
        """

实战示例

示例1：消息订阅与发布

消息发布者(Talker)

import time
from cyber_py3 import cyber
from cyber.proto.unit_test_pb2 import ChatterBenchmark

def test_talker():
    msg = ChatterBenchmark()
    msg.content = "Hello from Python!"
    msg.stamp = 9999
    
    node = cyber.Node("python_talker")
    writer = node.create_writer("chatter", ChatterBenchmark)
    
    while not cyber.is_shutdown():
        time.sleep(1)
        msg.stamp += 1
        writer.write(msg)
        print(f"Sent message: {msg}")

消息订阅者(Listener)

from cyber_py3 import cyber
from cyber.proto.unit_test_pb2 import ChatterBenchmark

def callback(data):
    print(f"Received message: {data}")

def test_listener():
    node = cyber.Node("python_listener")
    node.create_reader("chatter", ChatterBenchmark, callback)
    node.spin()

示例2：记录文件操作

from cyber_py3 import record
from cyber.proto.unit_test_pb2 import Chatter

# 写入记录文件
writer = record.RecordWriter()
writer.open("test.record")
msg = Chatter()
msg.timestamp = 1000
writer.write_message("chatter", msg.SerializeToString(), 1000000)

# 读取记录文件
reader = record.RecordReader("test.record")
for channel_name, msg, datatype, timestamp in reader.read_messages():
    if datatype == "apollo.cyber.proto.Chatter":
        parsed_msg = Chatter()
        parsed_msg.ParseFromString(msg)
        print(parsed_msg)