vector_pursuit_controller package from vector_pursuit_controller repo

vector_pursuit_controller

Package Summary

Tags No category tags.
Version 1.0.1
License Apache-2.0
Build type AMENT_CMAKE
Use RECOMMENDED

Repository Summary

Checkout URI https://github.com/blackcoffeerobotics/vector_pursuit_controller.git
VCS Type git
VCS Version master
Last Updated 2024-10-11
Dev Status DEVELOPED
CI status No Continuous Integration
Released RELEASED
Tags No category tags.
Contributing Help Wanted (0)
Good First Issues (0)
Pull Requests to Review (0)

Package Description

Vector Pursuit Controller

Additional Links

No additional links.

Maintainers

  • Kostubh Khandelwal
  • Gaurav Gupta
  • Arthur Gomes

Authors

No additional authors.

Line Coverage Function Coverage

Vector Pursuit Controller

This ROS2 Humble package contains a plugin for the Nav2 Controller Server that implements the Vector Pursuit path tracking algorithm. It leverages Screw Theory to achieve accurate path tracking and comes with active collision detection. The controller has a very low computational overhead and is very easy and simple to deploy. It tracks path orientation in a geometrically-meaningful way making it an ideal replacement for the Pure Pursuit Algorithm in scenarios where path following accuracy is vital. It consumes 15% of a single core on an ARM cortex-A72 CPU @ 1.8GHz and is designed to track paths at speeds upto 4.5m/s.

https://github.com/user-attachments/assets/5a660fa0-054c-4b14-aecd-d9cfe471930b

Get Started

These are minimal, to-the-point instructions for experienced ROS2/Nav2 users. Beginners are recommended to read the Quickstart Tutorial for a simple 4-step example to try out the controller in a Gazebo simulation.

  1. Install the package binaries.
    sudo apt-get install ros-humble-vector-pursuit-controller
    
  1. Edit the controller_server parameters of the Nav2 stack to include the vector pursuit plugin along with its default configuration. Nav2’s controller server supports multiple controller plugins at the same time and instructions for setting it up can be found in the official docs.

  2. Build the workspace and source it, then run the nav2 stack/controller server.

Features Offered

These are additional features on top of the core Vector Pursuit algorithm that extend its functionality. | Feature | Description | |———|————-| | Adaptive Lookahead Distance | The lookahead distance is used to find the target pose on the path. This target pose is used to guide the robot along the path. This distance can be scaled as per the robot’s velocity to ensure that the robot aims further along the path when moving at greater velocity. The adaptive lookahead distance is computed as the product of the robots current linear velocity and the value set in lookahead_time.| | Collision Aware Linear Velocity | The robot’s linear velocity is automatically scaled preemptively when in proximity to obstacles and completely halted when a collision is imminent. | | Approach Aware Linear Velocity | The robots linear velocity is automatically scaled when nearing a goal pose, this prevents overshoot. | | On Point Rotation | The controller will first rotate on point when attempting to chase a target pose at a heading which is more than the robots current heading by a configurable angle. | | Optional Reversing | The controller will output reverse velocity if the lookahead point is behind the robot (x coordinate of the lookahead point in the robot’s base_link is -ve). |

Configuration

Core Parameters

The following parameters tune the core path-tracking algorithm and are not needed by the additional features.

Parameter Description
k As per equation 3.52 of the Vector Pursuit Algorithm, k is a constant that relates the time taken for rotation and translation. The relationship is rotation_time = k * translation_time. Increasing k will result in a faster translation and decreasing k will, in turn, result in faster rotation.
desired_linear_vel Target linear velocity.
min_linear_velocity Magnitude of the minimum commandable linear velocity.
min_turning_radius Minimum turning radius. The min_turning_radius of the controller should be equal to or less than the minimum turning radius of the planner (in case it is available). This ensures the controller can follow the path generated by the planner and not get stuck in a loop.
max_lateral_accel Maximum allowed lateral acceleration. This is used to slowdown the robot while making sharp turns. Higher values result in a higher achievable linear velocity at a turn.
max_linear_accel Maximum linear acceleration.
use_interpolation Calculate lookahead point exactly at the lookahead distance. Otherwise select a discrete point on the path.
use_heading_from_path If set to true, uses the orientation from the path poses otherwise, computes appropriate orientations. Only set to true if ypu are using a planner that takes robot heading into account like Smac Planner.
max_robot_pose_search_dist Maximum search distance for target poses.

Feature Parameters

These parameters are used to tune and control the behaviour of | Feature | Parameter | Description | |———|———–|————-| | Adaptive Lookahead Distance | use_velocity_scaled_lookahead_dist | enable/disable | || min_lookahead_dist | Minimum lookahead distance. | || max_lookahead_dist | Maximum lookahead distance. | || lookahead_time | The time in seconds to integrate the current linear velocity to get the scaled lookahead distance | | Collision Aware Linear Velocity | use_collision_detection | Enable/disable collision detection. | || use_cost_regulated_linear_velocity_scaling | Enable/disable cost-regulated linear velocity scaling. | || inflation_cost_scaling_factor | Factor for inflation cost scaling. | || max_allowed_time_to_collision_up_to_target | Maximum time allowed for collision checking. | || cost_scaling_dist | Distance for cost-based velocity scaling. | || cost_scaling_gain | Gain factor for cost-based velocity scaling. | | Approach Aware Linear Velocity | approach_velocity_scaling_dist | The distance to goal at which velocity scaling will begin. Set to 0 to disable. | || min_approach_linear_velocity | The minimum velocity this scaling can produce. | | On Point Rotation | use_rotate_to_heading | Enable/disable rotate-to-heading behavior. Will override reversing if both are enabled. | || rotate_to_heading_angular_vel | Angular velocity for rotating to heading. | || rotate_to_heading_min_angle | Minimum angle to trigger rotate-to-heading behavior. | || max_angular_accel | Maximum angular acceleration. | | Optional Reversing | allow_reversing | Will move in reverse if the lookahead point is behind the robot. |

Default Parameters

controller_server:
  ros__parameters:
    use_sim_time: True
    controller_frequency: 20.0
    min_x_velocity_threshold: 0.001
    min_y_velocity_threshold: 0.5
    min_theta_velocity_threshold: 0.001
    failure_tolerance: 0.3
    progress_checker_plugin: "progress_checker"
    goal_checker_plugins: ["general_goal_checker"]
    controller_plugins: ["FollowPath"]

    # Progress checker parameters
    progress_checker:
      plugin: "nav2_controller::SimpleProgressChecker"
      required_movement_radius: 0.25
      movement_time_allowance: 10.0

    # Goal checker parameters
    general_goal_checker:
      plugin: "nav2_controller::SimpleGoalChecker"
      xy_goal_tolerance: 0.25
      yaw_goal_tolerance: 0.25
      stateful: True
    
    FollowPath:
      plugin: "vector_pursuit_controller::VectorPursuitController"
      k: 5.0
      desired_linear_vel: 0.5
      min_turning_radius: 0.25
      lookahead_dist: 1.0
      min_lookahead_dist: 0.5
      max_lookahead_dist: 1.5
      lookahead_time: 1.5
      rotate_to_heading_angular_vel: 0.5
      transform_tolerance: 0.1
      use_velocity_scaled_lookahead_dist: false
      min_linear_velocity: 0.0
      min_approach_linear_velocity: 0.05
      approach_velocity_scaling_dist: 0.5
      max_allowed_time_to_collision_up_to_target: 1.0
      use_collision_detection: true
      use_cost_regulated_linear_velocity_scaling: true
      cost_scaling_dist: 0.5
      cost_scaling_gain: 1.0
      inflation_cost_scaling_factor: 3.0
      use_rotate_to_heading: true
      allow_reversing: false
      rotate_to_heading_min_angle: 0.5
      max_angular_accel: 3.0
      max_linear_accel: 2.0
      max_lateral_accel: 0.2
      max_robot_pose_search_dist: 10.0
      use_interpolation: true
      use_heading_from_path: false
      approach_velocity_scaling_dist: 1.0

Quickstart Tutorial

We require a robot running the Nav2 stack to use the Vector Pursuit Controller. This example will utilise BCR Bot, a simulated, differential-drive robot with a sample Nav2 stack. An installation of ROS2 Humble is needed along with Git on an Ubuntu Machine.

  1. Install the package binaries.
    sudo apt-get install ros-humble-vector-pursuit-controller
    
  1. Install other ROS2 dependencies required for this tutorial.
	sudo apt-get install -y ros-humble-ros-gz-sim ros-humble-ros-gz-bridge ros-humble-ros-gz-interfaces ros-humble-bcr-bot ros-humble-navigation2 ros-humble-nav2-bringup  
	
  1. Run the ROS2 demo launch file.
	ros2 launch vector_pursuit_controller bcr_bot_demo.launch.py
	

Vector Pursuit Algorithm

Vector pursuit is a geometric path-tracking method that uses the theory of screws. It is similar to other geometric methods in that a look-ahead distance is used to define a current goal point, and then geometry is used to determine the desired motion of the vehicle. On the other hand, it is different from current geometric path-tracking methods, such as follow-the-carrot or pure pursuit, which do not use the orientation at the look-ahead point. Proportional path tracking is a geometric method that does use the orientation at the look-ahead point. This method adds the current position error multiplied by some gain to the current orientation error multiplied by some gain, and therefore becomes geometrically meaningless since terms with different units are added. Vector pursuit uses both the location and orientation of the look-ahead point while remaining geometrically meaningful. It first calculates two instantaneous screws for translation and rotation, and then combines them to form a single screw representing the required motion. Then it calculates a desired turning radius from the resultant screw.

The centerlines of the instantaneous screws are constrained to lie on the vehicle’s y-axis to accomodate one of the non-holonomic contraints. The screw for correcting the translational error, $t is chosen as the center of a circle which intersects the origins of both the vehicle coordinate system and the look-ahead coordinate system and is tangent to the vehicle’s current orientation. The screw for correcting the rotational error, $r is chosen to be centered at the vehicle frame origin so that no translation is associated with it.

translation_screw

Code Coverage

To generate an HTML webpage to view code coverage use:

genhtml code_coverage_report.info --output-directory ~/vector_pursuit_code_coverage_report

Acknowledgements

We acknowledge the contributions of:

  1. The author of Vector Pursuit Path Tracking for Autonomous Ground Vehicles, Jeffrey S. Wit.
  2. The Nav2 Regulated Pure Pursuit Controller project.
CHANGELOG

Changelog for package vector_pursuit_controller

1.0.1 (2024-09-03)

  • Fixed liniting issues
  • package manifest updated
  • updated readme
  • docs: Update README with detailed parameter descriptions and feature parameters
  • Updated parameter descriptions and values. Changed p_gain to k. Readme updates.
  • new tutorial added with launch and config in repo, readme updated
  • updated readme and code coverage report
  • Dyanmic parameter test
  • Update README.md to add video and fix typo
  • Merge pull request #1 from blackcoffeerobotics/devel-testing Improved test coverage and minor bug fixes
  • Improved test coverage, fixed turning radius calculation, updated optimal p_gain value in README
  • Linter updates
  • readme update, code coverage added, package manifest update
  • Added Screw calculation Updated the algorithm theory and added relevant diagrams for better understanding
  • initial commit
  • Contributors: Arthur, Arthur Gomes, Kostubh Khandelwal, exMachina316

Wiki Tutorials

This package does not provide any links to tutorials in it's rosindex metadata. You can check on the ROS Wiki Tutorials page for the package.

Launch files

No launch files found

Messages

No message files found.

Services

No service files found

Plugins

Recent questions tagged vector_pursuit_controller at Robotics Stack Exchange

No version for distro iron. Known supported distros are highlighted in the buttons above.
No version for distro jazzy. Known supported distros are highlighted in the buttons above.
No version for distro rolling. Known supported distros are highlighted in the buttons above.
No version for distro noetic. Known supported distros are highlighted in the buttons above.
No version for distro ardent. Known supported distros are highlighted in the buttons above.
No version for distro bouncy. Known supported distros are highlighted in the buttons above.
No version for distro crystal. Known supported distros are highlighted in the buttons above.
No version for distro eloquent. Known supported distros are highlighted in the buttons above.
No version for distro dashing. Known supported distros are highlighted in the buttons above.
No version for distro galactic. Known supported distros are highlighted in the buttons above.
No version for distro foxy. Known supported distros are highlighted in the buttons above.
No version for distro lunar. Known supported distros are highlighted in the buttons above.
No version for distro jade. Known supported distros are highlighted in the buttons above.
No version for distro indigo. Known supported distros are highlighted in the buttons above.
No version for distro hydro. Known supported distros are highlighted in the buttons above.
No version for distro kinetic. Known supported distros are highlighted in the buttons above.
No version for distro melodic. Known supported distros are highlighted in the buttons above.