Skip to content

Commit 67e8a4e

Browse files
finalized update pages for 2.0.0 and 2.1.0
1 parent 4c52ef3 commit 67e8a4e

File tree

5 files changed

+156
-13
lines changed

5 files changed

+156
-13
lines changed

docs_outdoornav_user_manual/api/api_overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ While the Web User Interface provides a great way to get started quickly
1010
with OutdoorNav Software, some users will want programmatic control or
1111
may wish to develop their own graphical user interfaces \-- for those
1212
users, the Application Programming Interface (API) provides the
13-
flexibility to do so. This is illustrated in the figure below.
13+
flexibility to do so.
1414

1515
The API is, at present, a [ROS 2 Jazzy](https://docs.ros.org/en/jazzy/index.html) API.
1616
The API is divided into two sections, whose details are provided below:
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Installation",
3+
"position": 10
4+
}
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: Installation
3+
sidebar_label: Installation
4+
sidebar_position: 1
5+
toc_min_heading_level: 2
6+
toc_max_heading_level: 4
7+
---
8+
9+
As of version 2.0.0, the OutdoorNav software uses ROS 2 Jazzy as its base. It is incompatible
10+
with any other previous version of ROS. If you have a base platform running an older version
11+
of ROS2, consult [the following page](../../docs/ros/installation/upgrading) to upgrade your base to ROS2 Jazzy.
12+
If you have a base platform running ROS1, please reach out to
13+
\<[email protected]\> in order to receive instructions to install the correct
14+
version.
15+
16+
## Installing OutdoorNav Updates
17+
18+
All AMP/Observer UGVs ship with the latest version of the OutdoorNav software.
19+
If you receive an email regarding an available OutdoorNav software update, follow
20+
the [update instructions](updates) to update the OutdoorNav software.
21+
Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
---
2+
title: Installing Updates
3+
sidebar_label: Installing Updates
4+
sidebar_position: 1
5+
toc_min_heading_level: 4
6+
toc_max_heading_level: 4
7+
---
8+
9+
The following page details the steps to update the OutdoorNav software that is already
10+
installed on your platform.
11+
12+
13+
:::note
14+
15+
Please ensure that you have received an email advising you that an update is available
16+
since only those who receive the update emails will be have access to the update files.
17+
18+
:::
19+
20+
## Download
21+
22+
1. Click the link that was sent to you in the update email. You will be sent to a Sharepoint
23+
drive with the following file structure (/Documents/General/Releases/...)
24+
25+
2. Navigate to the version folder you wish to update to and download the following files:
26+
27+
- **cpr-onav-ui.tar**
28+
29+
- **cpr-onav-base.tar**
30+
31+
- **cpr-onav-autonomy.tar**
32+
33+
- **cpr-onav-app.zip**
34+
35+
3. Connect to the robot
36+
37+
Option 1: via ethernet (port located inside of the rear charge port door)
38+
39+
Option 2: via wifi (Husky SSID: cpr_a300_amp_xxx)
40+
41+
4. Transfer all files to the robots **/opt/onav/** folder
42+
43+
**Linux**:
44+
45+
```code
46+
scp cpr-onav-app.zip cpr-onav-ui.tar cpr-onav-base.tar cpr-onav-autonomy.tar [email protected]:/opt/onav/
47+
```
48+
49+
**Windows**: Use [FileZilla Client](https://filezilla-project.org/download.php?platform=win64) to transfer all files to the robot.
50+
51+
SFTP Connection:
52+
53+
* Host: sftp://192.168.131.1
54+
55+
* Username: robot
56+
57+
* Password: clearpath
58+
59+
60+
## Update
61+
62+
1. Run the below command to update the version of OutdoorNav, where
63+
***\<latest_version\>*** is the folder of the last version of OutdoorNav that
64+
has been installed on the robot and ***\<new_version\>*** is the version you want
65+
to update to.
66+
67+
```code
68+
python3 /opt/onav/<latest_version>/app/update/update.py -v <new_version>
69+
```
70+
71+
Eg. To update from version 2.1.0 to version 2.2.0 run the following
72+
73+
```code
74+
python3 /opt/onav/2.1.0/app/update/update.py -v 2.2.0
75+
```
76+
77+
* this will create a new version folder in /opt/onav/
78+
79+
* copy all persistent data from the last version
80+
81+
* installs the app folder
82+
83+
* stop the currently running version of OutdoorNav
84+
85+
* start the new version of OutdoorNav
86+
87+
88+
## Cleanup
89+
90+
1. Remove all extraneous file
91+
92+
```code
93+
rm /opt/onav/cpr-onav-ui.tar /opt/onav/cpr-onav-base.tar /opt/onav/cpr-onav-autonomy.tar /opt/onav/cpr-onav-app.zip
94+
```
95+
96+
:::note
97+
98+
If you have made any customization changes to the app/ directory of your
99+
previous version, you will need to make these same modifications manually
100+
yourself to the new versions app/ directory files.
101+
102+
:::

outdoornav_user_manual_versioned_docs/version-2.0.0/installation/updates.mdx

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,25 @@ since only those who receive the update emails will be have access to the update
2020
## Download
2121

2222
1. Click the link that was sent to you in the update email. You will be sent to a Sharepoint
23-
drive with the following file structure (/Documents/General/Releases/)
23+
drive with the following file structure (/Documents/General/Releases/...)
2424

25-
2. Navigate to the version folder you wish to use and download the following files:
25+
2. Navigate to the version folder you wish to update to and download the following files:
2626

27-
a) **cpr-onav-ui.tar**
27+
- **cpr-onav-ui.tar**
2828

29-
b) **cpr-onav-base.tar**
29+
- **cpr-onav-base.tar**
3030

31-
c) **cpr-onav-autonomy.tar**
31+
- **cpr-onav-autonomy.tar**
3232

33-
d) **cpr-onav-app.zip**
33+
- **cpr-onav-app.zip**
3434

3535
3. Connect to the robot
3636

3737
Option 1: via ethernet (port located inside of the rear charge port door)
3838

3939
Option 2: via wifi (Husky SSID: cpr_a300_amp_xxx)
4040

41-
4. Transfer all files to the robots /opt/onav/ folder
41+
4. Transfer all files to the robots **/opt/onav/** folder
4242

4343
**Linux**:
4444

@@ -74,23 +74,29 @@ scp outdoornav.yaml [email protected]:/opt/onav/
7474
scp outdoornav.yaml.observer [email protected]:/opt/onav/
7575
```
7676

77+
Finally, navigate to the Documents/General/Releases/\<version\> (on the Sharepoint),
78+
download the update script and transfer it to the robot:
79+
80+
```code
81+
scp update.py [email protected]:/opt/onav/2.0.0/app/upgrade/
82+
```
7783
:::
7884

7985
## Update
8086

81-
1. Run the below command to upgrade the version of OutdoorNav, where
87+
1. Run the below command to update the version of OutdoorNav, where
8288
***\<latest_version\>*** is the folder of the last version of OutdoorNav that
8389
has been installed on the robot and ***\<new_version\>*** is the version you want
8490
to update to.
8591

8692
```code
87-
python3 /opt/onav/<latest_version>/app/update/update.py -v <new_version>
93+
python3 /opt/onav/<latest_version>/app/upgrade/update.py -v <new_version>
8894
```
8995

90-
Eg. To update from version 2.0.1 to version 2.1.0 run the following
96+
Eg. To update from version 2.0.0 to version 2.1.0 run the following
9197

9298
```code
93-
python3 /opt/onav/2.0.1/app/update/update.py -v 2.1.0
99+
python3 /opt/onav/2.0.0/app/upgrade/update.py -v 2.1.0
94100
```
95101

96102
* this will create a new version folder in /opt/onav/
@@ -103,6 +109,16 @@ to update to.
103109

104110
* start the new version of OutdoorNav
105111

112+
:::note
113+
114+
If you have an observer model robot please use the followinf command to update
115+
116+
```code
117+
python3 /opt/onav/<latest_version>/app/upgrade/update.py -v <new_version> -c observer
118+
```
119+
120+
:::
121+
106122
## Cleanup
107123

108124
1. Remove all extraneous file
@@ -115,6 +131,6 @@ to update to.
115131

116132
If you have made any customisation changes to the app/ directory of your
117133
previous version, you will need to make these same modifications manually
118-
yourself.
134+
yourself to the new versions app/ directory files.
119135

120136
:::

0 commit comments

Comments
 (0)