Skip to content

Logging

pathplannerlib Index / Pathplannerlib / Logging

Auto-generated documentation for pathplannerlib.logging module.

PathPlannerLogging

Show source in logging.py:6

Signature

class PathPlannerLogging: ...

PathPlannerLogging.logActivePath

Show source in logging.py:58

Log the active path. This is used internally.

Arguments

  • path - The active path

Signature

@staticmethod
def logActivePath(path: Union[PathPlannerPath, None]) -> None: ...

PathPlannerLogging.logCurrentPose

Show source in logging.py:38

Log the current robot pose. This is used internally.

Arguments

  • pose - The current robot pose

Signature

@staticmethod
def logCurrentPose(pose: Pose2d) -> None: ...

PathPlannerLogging.logTargetPose

Show source in logging.py:48

Log the target robot pose. This is used internally.

Arguments

  • pose - The target robot pose

Signature

@staticmethod
def logTargetPose(pose: Pose2d) -> None: ...

PathPlannerLogging.setLogActivePathCallback

Show source in logging.py:29

Set the logging callback for the active path

Arguments

  • log_active_path - Consumer that accepts the active path as a list of poses. Can be null to disable logging this value.

Signature

@staticmethod
def setLogActivePathCallback(
    log_active_path: Callable[[List[Pose2d]], None],
) -> None: ...

PathPlannerLogging.setLogCurrentPoseCallback

Show source in logging.py:11

Set the logging callback for the current robot pose

Arguments

  • log_current_pose - Consumer that accepts the current robot pose. Can be null to disable logging this value.

Signature

@staticmethod
def setLogCurrentPoseCallback(log_current_pose: Callable[[Pose2d], None]) -> None: ...

PathPlannerLogging.setLogTargetPoseCallback

Show source in logging.py:20

Set the logging callback for the target robot pose

Arguments

  • log_target_pose - Consumer that accepts the target robot pose. Can be null to disable logging this value.

Signature

@staticmethod
def setLogTargetPoseCallback(log_target_pose: Callable[[Pose2d], None]) -> None: ...