跳到主要内容

RFrame 使用入口

本文是 RFrame 用户文档的统一入口。新用户按「上手路径」顺序阅读;接入具体业务时直接订阅对应接口清单。

1. 上手路径​

按顺序读:

  1. 《RFrame 编译指南》—— deb 安装布局(/usr/local/lib)、CMake 接入 find_package(r-frame)、component/target 选择、Python wheel、环境变量。
  2. 《RFrame 开发指南》—— AppCore 生命周期、业务日志(C++/Python)、Channel API、HybridChannel / HybridRpcChannel 用法清单、JSON 配置加载与代码内创建配置、常见问题。
  3. 《RFrame 部署指南》—— 软件包安装、插件 catalog、全局运行配置。
  4. 《RFrame CLI 用户手册》—— rframe 命令行(bag / topic / service / discovery),用于观测、调试和录制回放。

2. 业务接口清单​

清单中每条接口都内嵌了可直接加载的 channels JSON 配置,复制即可用,无需手工转换格式。

清单内容通道数
导航接口清单导航 topic / service 通道配置8
状态信息接口清单状态机、电池状态与故障诊断 topic / service 通道配置4
传感器相机话题清单传感器相机图像 topic 通道配置10
运动与底盘接口清单7条反馈 Topic、2条控制 Topic、11个 Service;双灵巧手控制 Topic 与机器人构型相关。20

清单配置的使用方式(JSON 文件加载、全局配置加载、多通道批量加载)见《RFrame 开发指南》§7。

3. 示例源码​

清单和指南中引用的 channel / log 示例源码以 deb 包交付:

sudo apt install robby-r-frame-example

安装后位于 /opt/robby/RFrameExample/(src/channel、src/log、python/、config/),每个模块目录可独立编译,编译方法见《RFrame 编译指南》。