Skip to content

Commit

Permalink
Merge branch 'development-onav-0.12' of https://github.com/clearpathr…
Browse files Browse the repository at this point in the history
…obotics/cpr-documentation into development-onav-0.12
  • Loading branch information
dobrienCP committed Apr 11, 2024
2 parents c38c7ba + d1b2516 commit 51b954c
Show file tree
Hide file tree
Showing 73 changed files with 10,192 additions and 30 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,10 +154,12 @@ Next, to start the development of a new version, the latest released version of

For Example, for making a new release after humble, the contents of `docs_versioned_docs/version-ros2humble/` would be copied to `docs/`. This folder will then be built as the "next" version. Once enabled, this version will be available in the version drop down (just like how it is visible for OutdoorNav - http://docs.clearpathrobotics.com/docs_outdoornav_user_manual/next/index).

Enable the visibility of the "next" version by setting
Enable the visibility of the "next" version by setting

```
includeCurrentVersion: true,
```

in `docusaurus.config.js` alongside `id: "docs",`. Ensure to reset this to false before releasing the changes.

Continue through to step 9 of the workflow above to complete the update. Once complete, continue to the release phase.
Expand Down Expand Up @@ -198,11 +200,11 @@ includeCurrentVersion: false,

5. Empty the docs folder leaving only the .keep file (such that the folder is still tracked by git).

6. When ready, publish your branch on GitHub, and submit a Pull Request to merge your changes into the _development_ branch.
Be sure to include the updates to the following:
- docs_versioned_docs/
- docs_versioned_sidebars/
- docs_versions.json
6. When ready, publish your branch on GitHub, and submit a Pull Request to merge your changes into the _development_ branch.
Be sure to include the updates to the following:
- docs_versioned_docs/
- docs_versioned_sidebars/
- docs_versions.json

</details>

Expand Down
17 changes: 4 additions & 13 deletions docs_outdoornav_user_manual/getting_started/system_setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -217,19 +217,10 @@ different tasks that can be accomplished while operating the UGV.
- Overview of the buttons required to operate the UGV in Manual
Mode (teleoperation).

- Instructions to send the UGV on autonomous navigation missions,
including:

> - Adding Waypoints to the map
> - Creating missions
> - Viewing and updating missions
> - Adding task to missions, such as **Move PTZ** camera,
> **Save Image**, **Dock/Undock** UGV, **Wait**, etc....
> - Start/Stop/Pause missions
- Description of the docking procedures allowing the user to dock
and undock the UGV autonomously. Recovery instructions are also
described.
- Overview of how to send missions using the Map mode.

- Overview of how to send missions using the Waypoint mode.

2. **Application Programming Interface:** Details on how to control the
UGV programmatically.
3. **OutdoorNav Features** Details on the features available as part of the
Expand Down
15 changes: 5 additions & 10 deletions docs_outdoornav_user_manual/getting_started/terminal_interface.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -213,22 +213,17 @@ onav start <TARGET_VERSION>
## Upgrading the OutdoorNav Software

After receiving a notice that a new version of the OutdoorNav Software is
available, use the `onav install` command with the appropriate version.
Note that `onav install` runs the following commands in sequence:

- `onav download`
- `onav configure`
- `onav upgrade`

For example, to upgrade from 0.11.0 to 0.12.0, run the following command:
available, use the `onav upgrade` command with the appropriate version.
For example, to upgrade to the newest avialbel version that you are eligible
to receive, run the following command:

```
onav install 0.12.0
onav upgrade
```

:::note

The `download` step requires internet access to download the new software.
The upgrade requires internet access to download the new software.
Confirm that the OutdoorNav Computer has internet access by running a command
such as:

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "OutdoorNav User Manual",
"position": 1
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Application Programming Interface",
"position": 7
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "API Endpoints",
"position": 2
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: API Endpoints
sidebar_label: API Endpoints
sidebar_position: 2
toc_min_heading_level: 2
toc_max_heading_level: 4
---

The ROS 1 Noetic API can be used to monitor and manage OutdoorNav Software. Details
are available through the child pages.

- [Platform API](platform_api.mdx)
- [Autonomy API](autonomy_api.mdx)
- [Mission Manager API](mission_manager_api.mdx)
- [Definitions](definitions.mdx)

Loading

0 comments on commit 51b954c

Please sign in to comment.