Skip to content

Commit

Permalink
Merge pull request #230 from clearpathrobotics/development-onav-0.12
Browse files Browse the repository at this point in the history
WIP: Add OutdoorNav 0.12 documentation
  • Loading branch information
jmastrangelo-cpr authored Apr 12, 2024
2 parents 73addc0 + 51b954c commit f885df6
Show file tree
Hide file tree
Showing 119 changed files with 12,399 additions and 266 deletions.
45 changes: 44 additions & 1 deletion docs_outdoornav_user_manual/api/api_endpoints/autonomy_api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,49 @@ The OutdoorNav software publishes to the topics in this section either
all the time or while an autonomous navigation missions is running. They
can be used to monitor the behaviour of OutdoorNav.


#### /assisted_teleop/cmd_vel

  **Message Type:** geometry_msgs/Twist

  **Description:** The safe output velocity from the assisted teleop node
computes. If assisted teleop is enabled the UGV will use this velocity.

#### /assisted_teleop/footprint

  **Message Type:** geometry_msgs/Polygon

  **Description:** The footprint that the assisted teleop node uses to compute
if it is in a collision state.

#### /assisted_teleop/obstacle_map

  **Message Type:** [clearpath_safety_msgs/ObstacleMap](definitions.mdx#msg-obstacle-map)

  **Description:** The radial mapping of detected obstacles used to populate the joystick
on the OutdoorNav UI.

#### /assisted_teleop/safe_path

  **Message Type:** nav_msgs/Path

  **Description:** The path used by assisted teleop to lookahead for collisions.

#### /assisted_teleop/safety_footprints

  **Message Type:** nav_msgs/Path

  **Description:** Footprint sets used for detecting obstacles and slowing
down the robot to a standstill. The footprints are modular in size
according to the current velocity of the robot.

#### /assisted_teleop/state

  **Message Type:** [clearpath_safety_msgs/AssistedTeleopState](definitions.mdx#msg-assisted-teleop-state)

  **Description:** The current state of the assisted teleop node including
any error conditions that may occur.

#### /control_selection/control_state

  **Message Type:** [clearpath_control_msgs/ControlSelectionState](definitions.mdx#msg-control-selection-state)
Expand Down Expand Up @@ -116,7 +159,7 @@ Unknown space that the robot uses to detect obstacles.

#### /navigation/local_plan

  **Message Type:** nav_msgs/msg/Path
  **Message Type:** nav_msgs/Path

  **Description:** The MPC local plan that the navigation uses to control
the robot along the reference path.
Expand Down
Loading

0 comments on commit f885df6

Please sign in to comment.