Commands

pathplannerlib Index / Pathplannerlib / Commands

Auto-generated documentation for pathplannerlib.commands module.

FollowPathCommand

Signature

class FollowPathCommand(Command):
    def __init__(
        self,
        path: PathPlannerPath,
        pose_supplier: Callable[[], Pose2d],
        speeds_supplier: Callable[[], ChassisSpeeds],
        output: Callable[[ChassisSpeeds, DriveFeedforwards], None],
        controller: PathFollowingController,
        robot_config: RobotConfig,
        should_flip_path: Callable[[], bool],
        *requirements: Subsystem
    ): ...

FollowPathCommand().end

Show source in commands.py:149

Signature

def end(self, interrupted: bool): ...

FollowPathCommand().execute

Show source in commands.py:121

Signature

def execute(self): ...

FollowPathCommand().initialize

Show source in commands.py:83

Signature

def initialize(self): ...

FollowPathCommand().isFinished

Show source in commands.py:146

Signature

def isFinished(self) -> bool: ...

PathfindThenFollowPath

Show source in commands.py:385

Signature

class PathfindThenFollowPath(SequentialCommandGroup):
    def __init__(
        self,
        goal_path: PathPlannerPath,
        pathfinding_constraints: PathConstraints,
        pose_supplier: Callable[[], Pose2d],
        speeds_supplier: Callable[[], ChassisSpeeds],
        output: Callable[[ChassisSpeeds, DriveFeedforwards], None],
        controller: PathFollowingController,
        robot_config: RobotConfig,
        should_flip_path: Callable[[], bool],
        *requirements: Subsystem
    ): ...

PathfindingCommand

Show source in commands.py:163

Signature

class PathfindingCommand(Command):
    def __init__(
        self,
        constraints: PathConstraints,
        pose_supplier: Callable[[], Pose2d],
        speeds_supplier: Callable[[], ChassisSpeeds],
        output: Callable[[ChassisSpeeds, DriveFeedforwards], None],
        controller: PathFollowingController,
        robot_config: RobotConfig,
        should_flip_path: Callable[[], bool],
        target_path: PathPlannerPath = None,
        target_pose: Pose2d = None,
        goal_end_vel: float = 0,
        *requirements: Subsystem
    ): ...