RFrame 使用入口
本文是二开通信接口与 SDK 文档的统一入口。新用户按「上手路径」顺序阅读;接入具体业务时直接订阅对应接口清单。
1. RFrame SDK 上手路径
本期面向二次开发优先开放 Channel 通信能力与 RFrame CLI 工具:通过 HybridChannel / HybridRpcChannel 接入 Topic 消息收发与 Service 请求响应,支持 JSON 通道配置加载,并提供 C++ / Python 使用示例;通过 CLI 完成通信发现、观测调试及数据录制回放。配套指南覆盖用户代码编译、运行部署,以及 AppCore 和日志等基础接入。
《RFrame 架构概览》用于了解平台整体设计与模块关系;本期开放范围及接入方式以本门户的 Channel、CLI 和配套指南为准。
按顺序读:
- 《RFrame 编译指南》—— deb 安装布局(
/usr/local/lib)、CMake 接入find_package(r-frame)、component/target 选择、Python wheel、环境变量。 - 《RFrame 开发指南》—— AppCore 生命周期、业务日志(C++/Python)、Channel API、HybridChannel / HybridRpcChannel 用法清单、JSON 配置加载与代码内创建配置、常见问题。
- 《RFrame 部署指南》—— 软件包安装、插件 catalog、全局运行配置。
- 《RFrame CLI 用户手册》——
rframe命令行(bag / topic / service / discovery),用于观测、调试和录制回放。
2. 业务通信接口清单
各清单提供 JSON 配置、Schema 和接口语义。运控双灵巧手接口与机器人构型相关,接入前需确认已配置 RYHand 执行器。
| 清单 | 内容 | 通道数 |
|---|---|---|
| 导航接口清单 | 导航 topic / service 通道配置 | 8 |
| 基础功能接口清单 | 状态机、电池状态与故障诊断 topic / service 通道配置 | 4 |
| 传感器相机话题清单 | 传感器相机图像 topic 通道配置 | 10 |
| 传感器功能清单 | 相机参数设置、传感器版本查询 Service;提供通道 JSON、类型 Schema 与调用示例。 | 2(按接口概览) |
| 运控接口清单 | 7条反馈 Topic、2条控制 Topic、11个 Service;双灵巧手控制 Topic 与机器人构型相关。 | 20 |
清单配置的使用方式(JSON 文件加载、全局配置加载、多通道批量加载)见《RFrame 开发指南》§7。
3. RFrame 示例源码
已安装示例位于 /opt/robby/RFrameExample/:C++ 示例在 cpp/(cpp/hybridchannel、cpp/hybridrpcchannel、cpp/log 等),Python 示例在 python/,配置在 config/。JSON 通道配置加载示例为 cpp/hybridchannel/channel_config_loader_example.cpp;C++ 示例按含 CMakeLists.txt 的模块目录独立编译,编译方法见《RFrame 编译指南》。路径已按 robby-r-frame-example 0.0.0~dev12+20260907201652 安装包核对。