API 参考总览

本节按源码文件列出当前 Python 实现中的全部有效函数和方法,包括公共接口、ROS 回调、控制核心、内部辅助函数与离线测试入口。三引号字符串中停用的旧代码不计入有效 API。

当前共收录 225 个有效函数/方法,分布在 24 个源码文件中。

模块 函数/方法数 内容
FW_class.py 21 固定翼状态、MAVROS 通信、模式切换、姿态/推力控制以及速度向量转换。
VTOL_class.py 22 垂起固定翼的多旋翼/固定翼状态管理、转换服务和两阶段控制。
Rotor_class.py 17 多旋翼状态订阅、自动起飞以及位置、速度、加速度设定值发布。
uav_controller/spawn_uav.py 12 供多机示例读取状态、向统一控制话题发布指令的轻量封装。
myPID.py 2 带 P/I/D 分项限幅、总输出限幅和状态边界保护的离散 PID。
useful_function.py 5 姿态、经纬度相对坐标和速度—纵向控制量转换工具。
vector_vtol.py 2 垂起固定翼控制节点的控制指令回调。其主循环在模块顶层实现。
get_local_pose.py 1 把 Gazebo ModelStates 中的真值状态转发为单机或多机视觉位姿/速度话题。
single_demo/spawn_uav.py 12 单机算法读取 MAVROS 与 Gazebo 状态、发送速度/姿态命令的主要开发接口。
gvf_circle.py 6 二维圆轨迹隐式函数、梯度、切向量与归一化导航向量场。
gvf_inclined_circle.py 13 圆柱面与倾斜平面交线的三维导航向量场。
gvf_lissajous.py 6 带辅助路径参数的三维 Lissajous 参数曲线导航向量场。
gvf_poly.py 14 多项式参数轨迹的高维 GVF、混合收敛矩阵与圆轨迹兼容实现。
Polynomial.py 14 分段三次多项式的系数、位置以及一至三阶导数计算。
PolynomialTraj.py 24 多维三次多项式轨迹、误差导数、曲率/挠率与路径参数管理。
plottrajectory3d.py 7 订阅无人机位姿并生成多种参考轨迹的三维绘图工具。
DesirePath.py 6 二维折线路径投影、提前点和期望速度计算。
PathFollow.py 7 基于双积分质点模型和连续时间 LQR 的领航路径跟踪器。
Follower.py 6 把机体系编队偏移映射到航迹坐标系,并用 LQR 跟踪领航者。
ConsensusFollow.py 8 融合路径收敛项、图拉普拉斯一致性项和 LQR 的分布式编队控制器。
FormationFun.py 2 圆形与紧凑矩形编队偏移生成函数。
leader_uav.py 4 领航者 ROS 集成:更新状态、计算姿态并广播领航状态。
follower_uav.py 8 跟随者 ROS 集成:订阅领航信息并计算编队控制量。
consensus_uav.py 6 一致性编队 ROS 集成:按图拓扑交换参考点并计算控制量。

接口稳定性

当前源码没有单独声明稳定的公共 Python API。开发时建议把 single_demo/scripts/uav_lib/spawn_uav.py 中的状态属性与 control_send() 视为上层主要入口;控制器类和算法库中的其他方法应按源码版本管理。