Skip to content

Commit

Permalink
review fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
jmastrangelo-cpr committed Apr 9, 2024
1 parent c70e4de commit 6e19433
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ computes. If assisted teleop is enabled the UGV will use this velocity.

  **Message Type:** geometry_msgs/Polygon

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

#### /assisted_teleop/obstacle_map
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -613,7 +613,7 @@ string error_message
#### clearpath_safety_msgs/ObstacleMap.msg {#msg-obstacle-map}

```
# Assisted teleoperation message indicating the threat level of obstacles surrounidng the platform
# Assisted teleoperation message indicating the threat level of obstacles surrounding the platform
float32[] threat_level
```
Expand Down
16 changes: 10 additions & 6 deletions docs_outdoornav_user_manual/features/assisted_teleoperation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ teleoperate their UGV safely, without worry of colliding into obstacles.
</center>


The assisted teleoperation features is intended to work with on the following sources of velocity input:
The assisted teleoperation feature is intended to work with the following sources of velocity input:

| Input source | Topic |
|--------------|--------|
Expand All @@ -51,18 +51,22 @@ The Assisted teleop feature will **NOT** work on the following sources of veloci
| Keyboard Command | `/kb_teleop/cmd_vel` |
| Interactive Marker | `/twist_marker_server/cmd_vel` |

The Assisted Teleoperation feature can be activated/disactivated according to your required application requirements.
The Assisted Teleoperation feature can be activated/deactivated according to your required application requirements.
This can be done by setting the **ENABLE_ASSISTED_TELEOP** environment variable in the
`/opt/onav/<onav_version>/config/autonomy.env` file, where *onav_version*
is the currently running version of OutdoorNav.

## Functionality

The intended use for
The intended purpose for the assisted teleoperation feature is to provide some software level safety for users while they are teleoperating the UGV.
This feature is intended to solely provide software level safety and does not use any hardware level PLCs to trigger a motor disconnect. It is to be
treated as a tool that provides a sense of security to the user, such that they will not accidentally crash the UGV any obstacles. The feature
constantly monitors the 2D/3D LiDAR sensor data that it is provided and uses this information to control the velocity of the UGV. As the UGV
approaches obstacles, it will decrease the velocity of the UGV and will bring the UGV to a complete stop if the user continues to drive
towards the oncoming obstacle.

For visualization details of the assisted teleoperation feature, please consult the [UI Manual Mode](../web_user_interface/ui_manual_mode.mdx) page.


### Enable/Disable from the UI

From the OutdoorNav UI you are able to enable/disable the "Teleop Assist" by using the toggle that is located by the UI joystick.
Expand All @@ -84,10 +88,10 @@ Below are the errors/warnings you may see:
| Error/Warning | Reason |
|---------------|--------|
| **"Error: Failed to communicate with the Assisted Teleop node"** | The assisted teleoperation node is not running or has crashed |
| **"Error: No sensors configured"** | The assisted teleoperation node is running but no sensors have been configured to be used as obstacle detection sources |
| **"Error: No sensors configured"** | The assisted teleoperation node is running but no sensors have been configured to be used as obstacle detection sources |
| **"Error: Invalid twist_mux configuration"** | The twists mux configuration has been modified and does not satisfy the requirements for safe operation under the requirements of assisted teleoperation |
| **"Error: Unknown platform type"** | The assisted teleoperation node cannot determine the type of platform you are on |
| **"WARNING: Assisted teleoperation OFF due to service"** | The UI toggle switch or the `/assisted_teleop/enable` service has disabled assited teloperation |
| **"WARNING: Assisted teleoperation OFF due to service"** | The UI toggle switch or the `/assisted_teleop/enable` service has disabled assisted teloperation |
| **"WARNING: Assisted teleoperation OFF due to joystick override"** | The enable/disable button on the UGV remote joystick has been pressed |
| **"WARNING: Assisted teleoperation OFF due to sensor timeout"** | Communication has been lost between the assisted teloperation node and one of the configured 2D/3D detection sensors. |
| **"Warning: Robot is in a collision state and cannot be driven while assisted teleop is enabled. Please disable assisted teleop to recover."** | The robot is is a state where is is too close to an obstacle. This will mostly occur when you are at a charge dock but may also occur if you are driving/rotating in a tight space. You may need to disable the Teleop Assist to continue remote operation |
Expand Down
4 changes: 3 additions & 1 deletion docs_outdoornav_user_manual/release_notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ toc_max_heading_level: 4
software as long as they are eligible to be upgraded to the newest version.
Please contact [Support](./support.mdx) for more information.
- New visualization of status command in CLI tool
- Added a filebrowser extension to access/view the robot filesystem
- Added a filebrowser extension to access/view the robot filesystem for easier
media access

### API Features

Expand All @@ -40,6 +41,7 @@ toc_max_heading_level: 4
installed causes duplication of axis driver. Please contact [Support](./support.mdx)
if you run into this issue.
- 2344: Autonomy not going down during low-power mode
- 2360: Waypoint/Map modes use different mouse click to open context menus

## 0.11.0

Expand Down

0 comments on commit 6e19433

Please sign in to comment.