Skip to main content

rust_robotics_control/
lib.rs

1#![forbid(unsafe_code)]
2#![cfg_attr(not(feature = "std"), no_std)]
3//! Control and path tracking algorithms for the RustRobotics workspace.
4//!
5//! With default features disabled this crate is `no_std` (plus `alloc`) and
6//! the Tier 1 controllers — PID, Pure Pursuit, Stanley, and LQR Steer — build
7//! for bare-metal targets such as `thumbv7em-none-eabihf`. The sampling and
8//! optimization-based controllers (MPPI, MPC, cgmres, pusher-slider, racing,
9//! consensus ADMM, ...) need `std` for random number generation or the clarabel
10//! solver and are compiled only when the `std` feature is enabled.
11
12#[macro_use]
13extern crate alloc;
14
15#[cfg(feature = "std")]
16pub mod experiments;
17
18#[cfg(feature = "std")]
19pub mod admm_consensus;
20#[cfg(feature = "std")]
21pub mod arm_obstacle_navigation;
22#[cfg(feature = "std")]
23pub mod backstepping_control;
24#[cfg(feature = "std")]
25pub mod behavior_tree;
26#[cfg(feature = "std")]
27pub mod cbf_safety_filter;
28#[cfg(feature = "std")]
29pub mod cgmres_nmpc;
30#[cfg(feature = "std")]
31pub mod controller_arena;
32#[cfg(feature = "std")]
33pub mod ddp;
34#[cfg(feature = "std")]
35pub mod drone_3d_trajectory;
36#[cfg(feature = "std")]
37pub mod feedback_linearization;
38#[cfg(feature = "std")]
39pub mod ilqr;
40#[cfg(feature = "std")]
41pub mod lqr_control;
42#[cfg(feature = "std")]
43pub mod lqr_speed_steer_control;
44pub mod lqr_steer_control;
45#[cfg(feature = "std")]
46pub mod meta_control;
47#[cfg(feature = "std")]
48pub mod minimum_snap_trajectory;
49#[cfg(feature = "std")]
50pub mod model_predictive_trajectory_generator;
51#[cfg(feature = "std")]
52pub mod move_to_pose;
53#[cfg(feature = "std")]
54pub mod mpc;
55#[cfg(feature = "std")]
56pub mod mpc_control;
57#[cfg(feature = "std")]
58pub mod mppi;
59#[cfg(feature = "std")]
60pub mod n_joint_arm_3d;
61#[cfg(feature = "std")]
62pub mod n_joint_arm_control;
63#[cfg(feature = "std")]
64pub mod person_following_mppi;
65pub mod pid_controller;
66pub mod pure_pursuit;
67#[cfg(feature = "std")]
68pub mod pusher_slider;
69#[cfg(feature = "std")]
70pub mod racing_mppi_3d;
71#[cfg(feature = "std")]
72pub mod racing_mppi_motor;
73#[cfg(feature = "std")]
74pub mod racing_mppi_powertrain;
75#[cfg(feature = "std")]
76pub mod racing_mppi_quadrotor;
77#[cfg(feature = "std")]
78pub mod rear_wheel_feedback;
79#[cfg(feature = "std")]
80pub mod rocket_landing;
81#[cfg(feature = "std")]
82pub mod rrt_star_seven_joint_arm;
83#[cfg(feature = "std")]
84pub mod sliding_mode_control;
85mod spline_course;
86pub mod stanley_controller;
87#[cfg(feature = "std")]
88pub mod state_machine;
89#[cfg(feature = "std")]
90pub mod two_joint_arm_control;
91
92// Re-exports
93#[cfg(feature = "std")]
94pub use admm_consensus::{
95    solve_formation_consensus, solve_graph_consensus, solve_horizon_consensus, AdmmConfig,
96    AdmmReport, AgentSpec, AgentTrajectory, GraphConsensusReport, HorizonConsensusReport,
97};
98#[cfg(feature = "std")]
99pub use behavior_tree::{BehaviorStatus, BehaviorTree, Blackboard};
100#[cfg(feature = "std")]
101pub use cbf_safety_filter::{
102    simulate_cbf_navigation, CbfConvexObstacle2D, CbfFilterResult, CbfHalfspace2D, CbfNavConfig,
103    CbfNavReport, CbfSafetyFilter,
104};
105#[cfg(feature = "std")]
106pub use controller_arena::{
107    metrics_from_samples, run_controller_arena, ArenaControllerKind, ArenaMetrics, ArenaPreset,
108    ArenaRun, ArenaSample, ArenaScenario,
109};
110#[cfg(feature = "std")]
111pub use lqr_control::InvertedPendulumLQR;
112pub use lqr_steer_control::{LQRSteerConfig, LQRSteerController};
113#[cfg(feature = "std")]
114pub use meta_control::{
115    run_meta_control, MetaControlPolicy, MetaControlRun, MetaControlSample, MetaController,
116};
117#[cfg(feature = "std")]
118pub use move_to_pose::{MoveToPoseConfig, MoveToPoseController};
119#[cfg(feature = "std")]
120pub use mppi::{
121    MppiCircularObstacle2D, MppiConfig, MppiControl2D, MppiController2D, MppiGateRace2D,
122    MppiGateRaceReport2D, MppiMovingObstacle2D, MppiPlan2D, MppiRacingGate2D, MppiSampledPlan2D,
123    MppiSamplingDiagnostics2D, MppiState2D, MppiTerminalValueGrid2D,
124    MppiTerminalValueReplayBuffer2D, MppiTerminalValueReplayUpdateReport2D,
125    MppiTerminalValueUpdateConfig2D, MppiTerminalValueUpdateReport2D, MppiTerminalValueUpdater2D,
126    MppiTrackProjection2D, MppiWaypointTrack2D,
127};
128#[cfg(feature = "std")]
129pub use person_following_mppi::{
130    MppiPersonFollowingCandidate2D, MppiPersonFollowingConfig2D, MppiPersonFollowingSampler2D,
131    PersonFollowingMetricsAccumulator2D, PersonFollowingMetricsConfig2D,
132    PersonFollowingRolloutMetrics2D,
133};
134pub use pid_controller::{PIDConfig, PIDController};
135pub use pure_pursuit::{PurePursuitConfig, PurePursuitController};
136#[cfg(feature = "std")]
137pub use pusher_slider::{
138    simulate_multi_push, simulate_push, simulate_push_with_obstacles, ContactMode, MultiPushReport,
139    PushReport, PusherCommand, PusherMppiConfig, PusherMppiPlan, PusherSliderMppiController,
140    PusherSliderParams, SliderState,
141};
142#[cfg(feature = "std")]
143pub use racing_mppi_3d::{
144    simulate_lap_race, RacingDroneControl3D, RacingDroneDynamics3D, RacingDroneState3D,
145    RacingGateLap3D, RacingGatePlane3D, RacingLapReport3D, RacingMppi3DConfig,
146    RacingMppi3DController, RacingMppi3DPlan,
147};
148#[cfg(feature = "std")]
149pub use racing_mppi_motor::{
150    simulate_motor_race, MotorCommand, MotorMppiConfig, MotorMppiController, MotorMppiPlan,
151    MotorQuadParams, MotorQuadState, MotorRacingLapReport,
152};
153#[cfg(feature = "std")]
154pub use racing_mppi_powertrain::{
155    simulate_powertrain_race, simulate_powertrain_race_aware, simulate_powertrain_race_budgeted,
156    ChargeBudget, PowertrainLapReport, PowertrainMppiController, PowertrainParams, PowertrainState,
157};
158#[cfg(feature = "std")]
159pub use racing_mppi_quadrotor::{
160    simulate_quadrotor_race, QuadrotorControl, QuadrotorLapReport, QuadrotorMppiConfig,
161    QuadrotorMppiController, QuadrotorMppiPlan, QuadrotorParams, QuadrotorState,
162};
163#[cfg(feature = "std")]
164pub use rear_wheel_feedback::{RearWheelFeedbackConfig, RearWheelFeedbackController};
165pub use stanley_controller::{StanleyConfig, StanleyController};
166#[cfg(feature = "std")]
167pub use state_machine::StateMachine;
168#[cfg(feature = "std")]
169pub use two_joint_arm_control::TwoJointArm;