RflySimSDK 开发者参考手册¶
欢迎来到 RflySim 开发者底层接口中心。本板块完全对应原 RflySimAPIs 开发包文档,提供了一系列极度开放的 API,您可以在仿真中以编程方式与硬件、环境以及飞行器算法层进行深度交互。
🚀 使用方法概览¶
Python SDK 使用流程¶
- 安装环境: 安装 Python 环境和核心依赖包(即您安装的各种 RflySim 工具平台)。
- 配置编辑器: 配置代码编辑器环境(如 VS Code 及相关解释器设置)。
- 调用接口: 按本文档调用
RflySimAPIs中的各类接口函数(图像获取、状态轮询、发送操控指令)。
Simulink 工具箱使用流程¶
- 安装环境: 安装配套版本的 MATLAB 及 Simulink 工具箱。
- 配置生成: 基于
PSP配置自动代码生成流水线环境。 - 模型搭建: 在模型中拖拽使用相应的模块和桥接接口进行联合验证。
📚 常用功能与协议速查¶
- BAT 脚本参数速查说明:控制
CopterSim和环境启动的控制台及 BAT 批处理参数。 - 平台通信协议汇总:涵盖各种模块间数据通信的 UDP/TCP/串行协议定义。
🐍 Python SDK 核心模块汇总¶
为了覆盖 Sim-to-Real 的全架构验证需求,我们提供以下细分技术栈的接口类库:
-
📡 网络通信相关
comm 模块接口:包含
NetSimAPIV4,NetUavAPI和局域网数据转发与 Redis 同步机制。 -
🚁 载具模型与控制相关
ctrl 模块接口:包含基础离线控制 API、
DllSimCtrlAPI(与 DLL 综合模型交互)及PX4MavCtrl。 -
🛡️ 故障预测与健康管理 (PHM)
phm 模块接口:包含自动化测试配置协议、自动化命令注入 (
AutoMavCmd) 与云端数据记录 (MavDataRec)。 -
🐝 无人机集群多机协同
swarm 模块接口:包含
crazyflie,VehicleApi以及配合DistSim的分布式集群接口。 -
🎮 三维仿真引擎交互
ue 模块接口:包含场景资源控制表、
UE4CtrlAPI(控制天气、时间、视角)及UEMapServe。 -
👁️ 机器视觉处理
vision 模块接口:包含
VisionConfig,以及从场景获取三维画面的CameraCtrlApi,VisionCaptureApi。
🟩 MATLAB / Simulink 工具箱清单¶
RflySim 原生支持向 Simulink 开放全部总线功能,开发者可通过拖拽图形模块实现底层联合仿真:
| 子工具箱库名 | 核心组件描述 |
|---|---|
| Sensors and Actuators | 传感器与执行器交互底层逻辑模型 |
| uORB Read and Write | 直接与底层飞控 uORB 消息订阅与发布桥接 |
| RflySim APIs | 底层控制算法验证必备的 C/C++ 接口库 |
| RflySim Model | 动力学与三维场景仿真联合核心模型 |
| RflySim PHM | 自动化安全飞行包线与极端环境故障注入通道 |
| RflySim Swarm & Vision | 面向高层次的数据生成与集群状态提取支持 |
💡 进阶开发提示: 如需直接更改飞控底层架构或进行更高级别的话题通讯,请参考 ROS / ROS2 节点底层接口库。