Skip to content

Commit

Permalink
document new angular limit parameters in AckermannSteering.hh
Browse files Browse the repository at this point in the history
Signed-off-by: Sikiru Salau <[email protected]>
  • Loading branch information
siksal committed Jan 30, 2025
1 parent a13e650 commit f7395db
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions src/systems/ackermann_steering/AckermannSteering.hh
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,17 @@ namespace systems
/// element is optional, and the default value is 50Hz.
///
/// - `<min_velocity>`: Minimum velocity [m/s], usually <= 0.
/// - `<min_angular_velocity>`: Minimum angular velocity [m/s], usually <= 0.
/// - `<max_velocity>`: Maximum velocity [m/s], usually >= 0.
/// - `<max_angular_velocity>`: Maximum angular velocity [m/s], usually >= 0.
/// - `<min_acceleration>`: Minimum acceleration [m/s^2], usually <= 0.
/// - `<min_angular_acceleration>`: Minimum angular acceleration [m/s^2], usually <= 0.
/// - `<max_acceleration>`: Maximum acceleration [m/s^2], usually >= 0.
/// - `<min_jerk Minimum>`: jerk [m/s^3], usually <= 0.
/// - `<max_jerk Maximum>`: jerk [m/s^3], usually >= 0.
/// - `<max_angular_acceleration>`: Maximum angular acceleration [m/s^2], usually >= 0.
/// - `<min_jerk>`: Minimum jerk [m/s^3], usually <= 0.
/// - `<min_angular_jerk>`: Minimum jerk [m/s^3], usually <= 0.
/// - `<max_jerk>`: Maximum jerk [m/s^3], usually >= 0.
/// - `<max_angular_jerk>`: Maximum jerk [m/s^3], usually >= 0.
///
/// - `<topic>`: Custom topic that this system will subscribe to in order to
/// receive command messages. This element is optional, and the
Expand Down

0 comments on commit f7395db

Please sign in to comment.