Merge pull request #469 from clearpathrobotics/ONAV-2811

jmastrangelo-cpr · web-flow · commit e2181f72c1db · 2025-09-22T14:20:59.000-04:00
OutdoorNav - Installing Updates
diff --git a/docs_outdoornav_user_manual/api/api_overview.mdx b/docs_outdoornav_user_manual/api/api_overview.mdx
@@ -10,7 +10,7 @@ While the Web User Interface provides a great way to get started quickly
 with OutdoorNav Software, some users will want programmatic control or
 may wish to develop their own graphical user interfaces \-- for those
 users, the Application Programming Interface (API) provides the
-flexibility to do so. This is illustrated in the figure below.
+flexibility to do so.
 
 The API is, at present, a [ROS 2 Jazzy](https://docs.ros.org/en/jazzy/index.html) API.
 The API is divided into two sections, whose details are provided below:
diff --git a/docs_outdoornav_user_manual/installation/_category_.json b/docs_outdoornav_user_manual/installation/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "Installation",
+  "position": 10
+}
diff --git a/docs_outdoornav_user_manual/installation/overview.mdx b/docs_outdoornav_user_manual/installation/overview.mdx
@@ -0,0 +1,21 @@
+---
+title: Installation
+sidebar_label: Installation
+sidebar_position: 1
+toc_min_heading_level: 2
+toc_max_heading_level: 4
+---
+
+As of version 2.0.0, the OutdoorNav software uses ROS 2 Jazzy as its base. It is incompatible
+with any other previous version of ROS. If you have a base platform running an older version
+of ROS 2, consult [the following page](../../docs/ros/installation/upgrading) to upgrade your
+base to ROS 2 Jazzy. If you have a base platform running ROS 1, please reach out to
+\<support@clearpathrobotics.com\> in order to receive instructions to install the correct
+version.
+
+## Installing OutdoorNav Updates
+
+All AMP/Observer UGVs ship with the latest version of the OutdoorNav software.
+If you receive an email regarding an available OutdoorNav software update, follow
+the [update instructions](updates) to update the OutdoorNav software.
+
diff --git a/docs_outdoornav_user_manual/installation/updates.mdx b/docs_outdoornav_user_manual/installation/updates.mdx
@@ -0,0 +1,102 @@
+---
+title: Installing Updates
+sidebar_label: Installing Updates
+sidebar_position: 1
+toc_min_heading_level: 4
+toc_max_heading_level: 4
+---
+
+The following page details the steps to update the OutdoorNav software that is already
+installed on your platform.
+
+
+:::note
+
+Please ensure that you have received an email advising you that an update is available
+since only those who receive the update emails will be have access to the update files.
+
+:::
+
+## Download
+
+1. Click the link that was sent to you in the update email. You will be sent to a cloud storage
+drive with the following file structure (/Documents/General/Releases/...)
+
+2. Navigate to the version folder you wish to update to and download the following files:
+
+    - **cpr-onav-ui.tar**
+
+    - **cpr-onav-base.tar**
+
+    - **cpr-onav-autonomy.tar**
+
+    - **cpr-onav-app.zip**
+
+3. Connect to the robot 
+
+    Option 1: via ethernet (port located inside of the rear charge port door)
+
+    Option 2: via wifi (Husky SSID: cpr_a300_amp_xxx)
+
+4. Transfer all files to the robots **/opt/onav/** folder
+
+    **Linux**:
+
+    ```code
+    scp cpr-onav-app.zip cpr-onav-ui.tar cpr-onav-base.tar cpr-onav-autonomy.tar robot@192.168.131.1:/opt/onav/
+    ```
+
+    **Windows**: Use [FileZilla Client](https://filezilla-project.org/download.php?platform=win64) to transfer all files to the robot.
+    
+    SFTP Connection:
+
+        * Host: sftp://192.168.131.1
+
+        * Username: robot
+
+        * Password: clearpath
+
+
+## Update
+
+1. Run the below command to update the version of OutdoorNav, where
+***\<latest_version\>*** is the folder of the last version of OutdoorNav that
+has been installed on the robot and ***\<new_version\>*** is the version you want
+to update to.
+
+    ```code
+    python3 /opt/onav/<latest_version>/app/update/update.py -v <new_version>
+    ```
+
+    Eg. To update from version 2.1.0 to version 2.2.0 run the following
+
+    ```code
+    python3 /opt/onav/2.1.0/app/update/update.py -v 2.2.0
+    ```
+
+    * this will create a new version folder in /opt/onav/
+
+    * copy all persistent data from the last version
+
+    * installs the app folder
+
+    * stops the currently running version of OutdoorNav
+
+    * starts the new version of OutdoorNav
+
+
+## Cleanup
+
+1. Remove all extraneous files
+
+    ```code
+    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
+    ```
+
+:::note
+
+If you have made any customization changes to the app/ directory of your 
+previous version, you will need to make these same modifications manually 
+yourself to the new versions app/ directory files.
+
+:::
diff --git a/outdoornav_user_manual_versioned_docs/version-2.0.0/installation/_category_.json b/outdoornav_user_manual_versioned_docs/version-2.0.0/installation/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "Installation",
+  "position": 10
+}
diff --git a/outdoornav_user_manual_versioned_docs/version-2.0.0/installation/overview.mdx b/outdoornav_user_manual_versioned_docs/version-2.0.0/installation/overview.mdx
@@ -0,0 +1,21 @@
+---
+title: Installation
+sidebar_label: Installation
+sidebar_position: 1
+toc_min_heading_level: 2
+toc_max_heading_level: 4
+---
+
+As of version 2.0.0, the OutdoorNav software uses ROS 2 Jazzy as its base. It is incompatible
+with any other previous version of ROS. If you have a base platform running an older version
+of ROS 2, consult [the following page](../../docs/ros/installation/upgrading) to upgrade your
+base to ROS 2 Jazzy. If you have a base platform running ROS 1, please reach out to
+\<support@clearpathrobotics.com\> in order to receive instructions to install the correct
+version.
+
+## Installing OutdoorNav Updates
+
+All AMP/Observer UGVs ship with the latest version of the OutdoorNav software.
+If you receive an email regarding an available OutdoorNav software update, follow
+the [update instructions](updates) to update the OutdoorNav software.
+
diff --git a/outdoornav_user_manual_versioned_docs/version-2.0.0/installation/updates.mdx b/outdoornav_user_manual_versioned_docs/version-2.0.0/installation/updates.mdx
@@ -0,0 +1,136 @@
+---
+title: Installing Updates
+sidebar_label: Installing Updates
+sidebar_position: 1
+toc_min_heading_level: 4
+toc_max_heading_level: 4
+---
+
+The following page details the steps to update the OutdoorNav software that is already
+installed on your platform.
+
+
+:::note
+
+Please ensure that you have received an email advising you that an update is available
+since only those who receive the update emails will be have access to the update files.
+
+:::
+
+## Download
+
+1. Click the link that was sent to you in the update email. You will be sent to a cloud storage
+drive with the following file structure (/Documents/General/Releases/...)
+
+2. Navigate to the version folder you wish to update to and download the following files:
+
+    - **cpr-onav-ui.tar**
+
+    - **cpr-onav-base.tar**
+
+    - **cpr-onav-autonomy.tar**
+
+    - **cpr-onav-app.zip**
+
+3. Connect to the robot 
+
+    Option 1: via ethernet (port located inside of the rear charge port door)
+
+    Option 2: via wifi (Husky SSID: cpr_a300_amp_xxx)
+
+4. Transfer all files to the robots **/opt/onav/** folder
+
+    **Linux**:
+
+    ```code
+    scp cpr-onav-app.zip cpr-onav-ui.tar cpr-onav-base.tar cpr-onav-autonomy.tar robot@192.168.131.1:/opt/onav/
+    ```
+
+    **Windows**: Use [FileZilla Client](https://filezilla-project.org/download.php?platform=win64) to transfer all files to the robot.
+    
+    SFTP Connection:
+
+        * Host: sftp://192.168.131.1
+
+        * Username: robot
+
+        * Password: clearpath
+
+:::note
+
+If you are upgrading to version 2.1.0 from 2.0.x please also navigate to
+Documents/General/Releases/\<version\> (on the Sharepoint), download one
+of the following files and transfer it to the robot:
+
+* **outdoornav.yaml.amp** for standard AMP robots,
+
+```code
+scp outdoornav.yaml robot@192.168.131.1:/opt/onav/
+```
+
+* **outdoornav.yaml.observer** for Observer robots.
+
+```code
+scp outdoornav.yaml.observer robot@192.168.131.1:/opt/onav/
+```
+
+Finally, navigate to the Documents/General/Releases/\<version\> (on the Sharepoint),
+download the update script and transfer it to the robot:
+
+```code
+scp update.py robot@192.168.131.1:/opt/onav/2.0.0/app/upgrade/
+```
+:::
+
+## Update
+
+1. Run the below command to update the version of OutdoorNav, where
+***\<latest_version\>*** is the folder of the last version of OutdoorNav that
+has been installed on the robot and ***\<new_version\>*** is the version you want
+to update to.
+
+    ```code
+    python3 /opt/onav/<latest_version>/app/upgrade/update.py -v <new_version>
+    ```
+
+    Eg. To update from version 2.0.0 to version 2.1.0 run the following
+
+    ```code
+    python3 /opt/onav/2.0.0/app/upgrade/update.py -v 2.1.0
+    ```
+
+    * this will create a new version folder in /opt/onav/
+
+    * copy all persistent data from the last version
+
+    * installs the app folder
+
+    * stops the currently running version of OutdoorNav
+
+    * starts the new version of OutdoorNav
+
+:::note
+
+If you have an Observer model robot please use the following command to update
+
+```code
+python3 /opt/onav/<latest_version>/app/upgrade/update.py -v <new_version> -c observer
+```
+
+:::
+
+## Cleanup
+
+1. Remove all extraneous files
+
+    ```code
+    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
+    ```
+
+:::note
+
+If you have made any customisation changes to the app/ directory of your 
+previous version, you will need to make these same modifications manually 
+yourself to the new versions app/ directory files.
+
+:::

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "label": "Installation",
 +  "position": 10
 +}