Skip to content

Commit fb2b9dd

Browse files
committed
ONAV-2279: Added in more images and cleaned up the waypoint mode page
1 parent af74737 commit fb2b9dd

File tree

18 files changed

+141
-218
lines changed

18 files changed

+141
-218
lines changed

docs_outdoornav_user_manual/api/api_endpoints/mission_manager_api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -389,7 +389,7 @@ service instead.
389389

390390
#### mission_manager/split_network_edge
391391

392-
**Service Type:** [clearpath_mission_manager_msgs/srv/SplitNetworkEdge](definitions.mxd#storage-splitnetworkedge)
392+
**Service Type:** [clearpath_mission_manager_msgs/srv/SplitNetworkEdge](definitions.mdx#storage-splitnetworkedge)
393393

394394
**Description:** Split an edge of network of paths map to create 2 edges connected to a new vertex between them. If
395395
`symmetrical` is set to `true` the new edges will be bidirectional, otherwise only the edge going in one direction is

docs_outdoornav_user_manual/features/mission_scheduler.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@ allows users to schedule groups of missions to run at a later time. These schedu
1313
For example, a user could create a schedule that will run 3 missions starting at 9 AM and run every hour 8 times. Once the last iteration is run, the
1414
schedule will disable itself and can be re-enabled to run again later. The view itself can be found in the image below and is elaborated further afterwards.
1515

16+
:::note
17+
18+
Presently only Waypoint Missions can be scheduled with the scheduler. A future update will allow users to schedule both Map and
19+
Waypoint Missions together in a single schedule.
20+
21+
:::
22+
1623
<center>
1724
<figure>
1825
<img src="/img/outdoornav_images/scheduler_screen.png" />

docs_outdoornav_user_manual/web_user_interface/ui_autonomous_mode.mdx

Lines changed: 3 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Web UI Autonomous Mode
3-
sidebar_label: Web UI Autonomous Mode
2+
title: Web UI Waypoint Mode
3+
sidebar_label: Web UI Waypoint Mode
44
sidebar_position: 3
55
toc_min_heading_level: 2
66
toc_max_heading_level: 4
@@ -39,26 +39,6 @@ These components are referred to throughout this manual.
3939
drag and drop this ghost waypoint to add a new waypoint to the mission between
4040
the other two waypoints.
4141

42-
## Map Settings
43-
44-
<center>
45-
<figure>
46-
<img src="/img/outdoornav_images/ui_map_settings.png" />
47-
<figcaption>Map settings</figcaption>
48-
</figure>
49-
</center>
50-
51-
To access the Map Settings: Menu → Settings → Map:
52-
53-
1. **Map Offset:** The map tiles used in this software are not
54-
perfectly aligned with the real world. Therefore, the user may need
55-
to apply an offset to the map so that the UGV's position in the
56-
real world matches its position on the map.
57-
2. **Change Datum:** The datum is represented by a blue marker on the
58-
map and should be set to a location within 10km of the test site.
59-
The user can change this value in the Map Settings page. Enter the
60-
new values and click the "Set Datum" button.
61-
6242
## Mission Creation
6343

6444
To create a new Mission first ensure that the UI is in "Edit Mode" (
@@ -153,69 +133,6 @@ To add a Task to the end of a Mission:
153133
assigned to them based on placement). Waypoints in the table will also have a small icon to indicate
154134
if tasks are assigned to the Waypoint accordingly.
155135

156-
- <img src="/img/outdoornav_images/dockTask_40px.png" width="30px"/> <strong>Dock UGV: </strong>
157-
Will dock the UGV to begin charging the UGV's
158-
battery. See [Autonomous Docking](#autonomous-docking)
159-
for more information on the autonomous docking feature.
160-
161-
- <img src="/img/outdoornav_images/cameraTask_40px.png" width="30px"/> <strong>Move PTZ: </strong>
162-
Will move the PTZ camera to the position selected
163-
in the task settings.
164-
165-
Settings: Select the camera position. See
166-
[Pan-Tilt-Zoom (PTZ) View](ui_overview.mdx#ptz-view) for details on how to
167-
save camera positions.
168-
169-
- <img src="/img/outdoornav_images/cameraTask_40px.png" width="30px"/> <strong>Save Image: </strong>
170-
Will save an image using one of the UGV camera(s)
171-
to the **/opt/onav/saved_files/media/...** directory and can be retrieved using a tool
172-
such as Filezilla.
173-
174-
Settings: Select which camera the image will be saved from.
175-
176-
- <img src="/img/outdoornav_images/recordTask_40px.png" width="30px"/> <strong>Start/Stop Video Recording: </strong>
177-
Will start/stop recording video using one of the
178-
UGV camera(s) to the **/opt/onav/saved_files/media/...** folder and can be retrieved
179-
using a tool such as Filezilla.
180-
181-
Settings: Select which camera the recording will come from.
182-
183-
- <img src="/img/outdoornav_images/undockTask_40px.png" width="30px"/> <strong>Undock UGV: </strong>
184-
Will undock the UGV from the autocharge dock. Once
185-
completed, the UGV can be sent on autonomous missions. It is
186-
often recommended to place the undock task first in the list of Waypoints or as a start Mission Task;
187-
that way, the UGV will automatically continue towards its next
188-
Waypoint once undocked.
189-
190-
:::note
191-
192-
If the users places the Undock Task in the start Mission event the first Waypoint should be
193-
approximately 2-3 meters behind the UGVs docked position.
194-
195-
:::
196-
197-
- <img src="/img/outdoornav_images/waitTask_40px.png" width="30px"/> <strong>Wait: </strong>
198-
Will pause and wait for the specified number of
199-
seconds at the end of the Waypoint.
200-
201-
Settings: Enter the amount of time to wait, in seconds.
202-
203-
- <img src="/img/outdoornav_images/customTask_40px.png" width="30px"/> <strong>New Custom Task: </strong>
204-
Creates a new custom task that is defined by the user.
205-
<center>
206-
<figure>
207-
<img src="/img/outdoornav_images/custom_task_settings.png"/>
208-
<figcaption>Custom Task Settings Dialog</figcaption>
209-
</figure>
210-
</center>
211-
212-
- Task Name: Task name that will show up in the list of available tasks on the UI.
213-
- Action Server Name: The namespace of the custom task action server.
214-
- Float CSV: A list of comma seperated float values that consist of the numerical inputs to the custom task.
215-
- String CSV: A list of comma seperated string values that consist of the semantic inputs to the custom task.
216-
217-
See the [Custom Tasks](../features/custom_tasks.mdx) section
218-
for details on how to develop custom tasks for your application.
219136
4. The check box next to the Task name controls mission behaviour in the event that the Task fails. If the checkbox is
220137
checked the Mission will proceed to the next step in it's process, such as the next task or navigating to the next Waypoint.
221138
If its not checked, the Mission will become cancelled upon the Task's failure.
@@ -320,7 +237,7 @@ UGV is returned within the navigable area defined by the path contraint.
320237
### Start Mission
321238

322239
There are multiple ways to start a Mission. At the bottom of the UI, the user has the ability to start the currently
323-
selected Mission by clicking the "Play" button <img src="/img/outdoornav_images/ui_start_button.png" width="16px"/>.
240+
selected Mission by clicking the "Play" button <img src="/img/outdoornav_images/ui_start_button_simple.png" width="16px"/>.
324241
Starting the Mission this will start the Mission from the first Waypoint. The user may also select the drop down next to the button
325242
to start the Mission from the current UGV position. This is a useful way to start a Mission in the event that the UGV was blocked by
326243
obstacles that were later moved. Another way that a user can start a Mission is by selecting a waypoint in edit mode and then clicking on

docs_outdoornav_user_manual/web_user_interface/ui_map_mode.mdx

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Web UI Autonomous Map Mode
2+
title: Web UI Map Mode
33
sidebar_label: Web UI Map Mode
44
sidebar_position: 3
55
toc_min_heading_level: 2
@@ -12,7 +12,7 @@ Ensure that the [Safety](../safety.mdx) document has been
1212
read and the User is aware of possible hazards when using this product as well as the safety
1313
methods that can be used to stop the moving UGV.
1414

15-
The Autonomous Map Mode of OutdoorNav Software is a set of robotic
15+
The Map Mode of OutdoorNav Software uses a set of robotic
1616
navigation modules that allows users to define drivable paths and
1717
then execute missions using these maps. The UGV leverages these paths
1818
along with specified goal points to calculate a route. Users can
@@ -280,13 +280,6 @@ To add a Task to a Goalpoint:
280280
5. Click the Gear icon next to the selected Task to add the required
281281
Settings.
282282

283-
:::note
284-
285-
If a Goalpoint has more than one task assigned to it, the icon will
286-
be replaced with <img src="/img/outdoornav_images/multiTask_40px.png" width="30px"/>
287-
288-
:::
289-
290283
### Advanced Settings
291284

292285
<iframe width="696" height="358" src="https://youtube.com/embed/V6K2VXM5EaU" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

0 commit comments

Comments
 (0)