From 3f70940bc48d2c193469063d581d515184d111c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Mastrangelo?= Date: Tue, 19 Aug 2025 14:12:53 -0400 Subject: [PATCH 1/5] added update instructions --- .../installation/_category_.json | 4 + .../version-2.0.0/installation/overview.mdx | 21 ++++ .../version-2.0.0/installation/updates.mdx | 100 ++++++++++++++++++ 3 files changed, 125 insertions(+) create mode 100644 outdoornav_user_manual_versioned_docs/version-2.0.0/installation/_category_.json create mode 100644 outdoornav_user_manual_versioned_docs/version-2.0.0/installation/overview.mdx create mode 100644 outdoornav_user_manual_versioned_docs/version-2.0.0/installation/updates.mdx 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 new file mode 100644 index 00000000..2ffaa157 --- /dev/null +++ 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 new file mode 100644 index 00000000..86fb65f2 --- /dev/null +++ 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 ROS2, consult [the following page](../../docs/ros/installation/upgrading) to upgrade your base to ROS2 Jazzy. +If you have a base platform running ROS1, please reach out to +\ 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 new file mode 100644 index 00000000..b2d350ec --- /dev/null +++ b/outdoornav_user_manual_versioned_docs/version-2.0.0/installation/updates.mdx @@ -0,0 +1,100 @@ +--- +title: Installing Updates +sidebar_label: Installing Updates +sidebar_position: 1 +toc_min_heading_level: 4 +toc_max_heading_level: 4 +--- + +## Download + +1. Click the link that was sent to you in the update email. You will be sent to a Sharepoint +drive with the following file structure (/Documents/General/Releases/) + +2. Navigate to the version folder you wish to use and download the following files: + + a) **cpr-onav-ui.tar** + + b) **cpr-onav-base.tar** + + c) **cpr-onav-autonomy.tar** + + d) **cpr-onav-app.zip** + +:::note + +If you are upgrading to version 2.1.0 from 2.0.x please also navigate to +Documents/General/Releases/\ and download one of the following files: + +* **outdoornav.yaml.amp** for standard AMP robots, + +* **outdoornav.yaml.observer** for Observer robots. + +::: + +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:/home/robot + ``` + + **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 upgrade the version of OutdoorNav, where +\ is the folder of the last version of OutdoorNav that +has been installed on the robot and \ is the version you want +to update to. + + ```code + python3 /opt/onav//app/update/update.py -v + ``` + + Eg. To update from version 2.0.1 to version 2.1.0 run the following + + ```code + python3 /opt/onav/2.0.1/app/update/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 + + * stop the currently running version of OutdoorNav + + * start the new version of OutdoorNav + +## Cleanup + +1. Remove all extraneous file + + ```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. + +::: \ No newline at end of file From 4c52ef395599040fc75d86781eee68b2c521bb8f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Mastrangelo?= Date: Thu, 21 Aug 2025 22:27:06 -0400 Subject: [PATCH 2/5] move note location and update scp command --- .../version-2.0.0/installation/updates.mdx | 50 +++++++++++++------ 1 file changed, 35 insertions(+), 15 deletions(-) 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 index b2d350ec..cf7f6b1e 100644 --- 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 @@ -6,6 +6,17 @@ 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 Sharepoint @@ -21,17 +32,6 @@ drive with the following file structure (/Documents/General/Releases/) d) **cpr-onav-app.zip** -:::note - -If you are upgrading to version 2.1.0 from 2.0.x please also navigate to -Documents/General/Releases/\ and download one of the following files: - -* **outdoornav.yaml.amp** for standard AMP robots, - -* **outdoornav.yaml.observer** for Observer robots. - -::: - 3. Connect to the robot Option 1: via ethernet (port located inside of the rear charge port door) @@ -43,7 +43,7 @@ Documents/General/Releases/\ and download one of the following files: **Linux**: ```code - scp cpr-onav-app.zip cpr-onav-ui.tar cpr-onav-base.tar cpr-onav-autonomy.tar robot@192.168.131.1:/home/robot + 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. @@ -56,11 +56,31 @@ Documents/General/Releases/\ and download one of the following files: * Password: clearpath +:::note + +If you are upgrading to version 2.1.0 from 2.0.x please also navigate to +Documents/General/Releases/\ (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/ +``` + +::: + ## Update -1. Run the below command to upgrade the version of OutdoorNav, where -\ is the folder of the last version of OutdoorNav that -has been installed on the robot and \ is the version you want +1. Run the below command to upgrade the version of OutdoorNav, where +***\*** is the folder of the last version of OutdoorNav that +has been installed on the robot and ***\*** is the version you want to update to. ```code From 67e8a4eb521aec8a3ad9dc476024d0f8fc81671c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Mastrangelo?= Date: Fri, 12 Sep 2025 16:48:23 -0400 Subject: [PATCH 3/5] finalized update pages for 2.0.0 and 2.1.0 --- .../api/api_overview.mdx | 2 +- .../installation/_category_.json | 4 + .../installation/overview.mdx | 21 ++++ .../installation/updates.mdx | 102 ++++++++++++++++++ .../version-2.0.0/installation/updates.mdx | 40 ++++--- 5 files changed, 156 insertions(+), 13 deletions(-) create mode 100644 docs_outdoornav_user_manual/installation/_category_.json create mode 100644 docs_outdoornav_user_manual/installation/overview.mdx create mode 100644 docs_outdoornav_user_manual/installation/updates.mdx diff --git a/docs_outdoornav_user_manual/api/api_overview.mdx b/docs_outdoornav_user_manual/api/api_overview.mdx index 8eb481ca..92e2c273 100644 --- 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 new file mode 100644 index 00000000..2ffaa157 --- /dev/null +++ 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 new file mode 100644 index 00000000..86fb65f2 --- /dev/null +++ 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 ROS2, consult [the following page](../../docs/ros/installation/upgrading) to upgrade your base to ROS2 Jazzy. +If you have a base platform running ROS1, please reach out to +\ 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 new file mode 100644 index 00000000..b88d457a --- /dev/null +++ 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 Sharepoint +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 +***\*** is the folder of the last version of OutdoorNav that +has been installed on the robot and ***\*** is the version you want +to update to. + + ```code + python3 /opt/onav//app/update/update.py -v + ``` + + 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 + + * stop the currently running version of OutdoorNav + + * start the new version of OutdoorNav + + +## Cleanup + +1. Remove all extraneous file + + ```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. + +::: \ No newline at end of file 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 index cf7f6b1e..494e8cad 100644 --- 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 @@ -20,17 +20,17 @@ since only those who receive the update emails will be have access to the update ## Download 1. Click the link that was sent to you in the update email. You will be sent to a Sharepoint -drive with the following file structure (/Documents/General/Releases/) +drive with the following file structure (/Documents/General/Releases/...) -2. Navigate to the version folder you wish to use and download the following files: +2. Navigate to the version folder you wish to update to and download the following files: - a) **cpr-onav-ui.tar** + - **cpr-onav-ui.tar** - b) **cpr-onav-base.tar** + - **cpr-onav-base.tar** - c) **cpr-onav-autonomy.tar** + - **cpr-onav-autonomy.tar** - d) **cpr-onav-app.zip** + - **cpr-onav-app.zip** 3. Connect to the robot @@ -38,7 +38,7 @@ drive with the following file structure (/Documents/General/Releases/) Option 2: via wifi (Husky SSID: cpr_a300_amp_xxx) -4. Transfer all files to the robots /opt/onav/ folder +4. Transfer all files to the robots **/opt/onav/** folder **Linux**: @@ -74,23 +74,29 @@ scp outdoornav.yaml robot@192.168.131.1:/opt/onav/ scp outdoornav.yaml.observer robot@192.168.131.1:/opt/onav/ ``` +Finally, navigate to the Documents/General/Releases/\ (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 upgrade the version of OutdoorNav, where +1. Run the below command to update the version of OutdoorNav, where ***\*** is the folder of the last version of OutdoorNav that has been installed on the robot and ***\*** is the version you want to update to. ```code - python3 /opt/onav//app/update/update.py -v + python3 /opt/onav//app/upgrade/update.py -v ``` - Eg. To update from version 2.0.1 to version 2.1.0 run the following + Eg. To update from version 2.0.0 to version 2.1.0 run the following ```code - python3 /opt/onav/2.0.1/app/update/update.py -v 2.1.0 + python3 /opt/onav/2.0.0/app/upgrade/update.py -v 2.1.0 ``` * this will create a new version folder in /opt/onav/ @@ -103,6 +109,16 @@ to update to. * start the new version of OutdoorNav +:::note + +If you have an observer model robot please use the followinf command to update + +```code +python3 /opt/onav//app/upgrade/update.py -v -c observer +``` + +::: + ## Cleanup 1. Remove all extraneous file @@ -115,6 +131,6 @@ to update to. 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. +yourself to the new versions app/ directory files. ::: \ No newline at end of file From 9e8be941e93555a877889e33064280d776fd9b33 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Mastrangelo?= Date: Mon, 22 Sep 2025 10:05:00 -0400 Subject: [PATCH 4/5] review changes --- docs_outdoornav_user_manual/installation/overview.mdx | 4 ++-- docs_outdoornav_user_manual/installation/updates.mdx | 8 ++++---- .../version-2.0.0/installation/overview.mdx | 4 ++-- .../version-2.0.0/installation/updates.mdx | 10 +++++----- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs_outdoornav_user_manual/installation/overview.mdx b/docs_outdoornav_user_manual/installation/overview.mdx index 86fb65f2..cdcf04cc 100644 --- a/docs_outdoornav_user_manual/installation/overview.mdx +++ b/docs_outdoornav_user_manual/installation/overview.mdx @@ -8,8 +8,8 @@ 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 ROS2, consult [the following page](../../docs/ros/installation/upgrading) to upgrade your base to ROS2 Jazzy. -If you have a base platform running ROS1, please reach out to +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 \ in order to receive instructions to install the correct version. diff --git a/docs_outdoornav_user_manual/installation/updates.mdx b/docs_outdoornav_user_manual/installation/updates.mdx index b88d457a..36ed78a0 100644 --- a/docs_outdoornav_user_manual/installation/updates.mdx +++ b/docs_outdoornav_user_manual/installation/updates.mdx @@ -19,7 +19,7 @@ since only those who receive the update emails will be have access to the update ## Download -1. Click the link that was sent to you in the update email. You will be sent to a Sharepoint +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: @@ -80,14 +80,14 @@ to update to. * installs the app folder - * stop the currently running version of OutdoorNav + * stops the currently running version of OutdoorNav - * start the new version of OutdoorNav + * starts the new version of OutdoorNav ## Cleanup -1. Remove all extraneous file +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 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 index 86fb65f2..cdcf04cc 100644 --- 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 @@ -8,8 +8,8 @@ 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 ROS2, consult [the following page](../../docs/ros/installation/upgrading) to upgrade your base to ROS2 Jazzy. -If you have a base platform running ROS1, please reach out to +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 \ in order to receive instructions to install the correct version. 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 index 494e8cad..871b7324 100644 --- 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 @@ -19,7 +19,7 @@ since only those who receive the update emails will be have access to the update ## Download -1. Click the link that was sent to you in the update email. You will be sent to a Sharepoint +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: @@ -105,13 +105,13 @@ to update to. * installs the app folder - * stop the currently running version of OutdoorNav + * stops the currently running version of OutdoorNav - * start the new version of OutdoorNav + * starts the new version of OutdoorNav :::note -If you have an observer model robot please use the followinf command to update +If you have an Observer model robot please use the follow command to update ```code python3 /opt/onav//app/upgrade/update.py -v -c observer @@ -121,7 +121,7 @@ python3 /opt/onav//app/upgrade/update.py -v -c obs ## Cleanup -1. Remove all extraneous file +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 From fe8ea3838ea0829ea29186ff58efbefe9b9fdaff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Mastrangelo?= Date: Mon, 22 Sep 2025 14:09:22 -0400 Subject: [PATCH 5/5] review fix --- .../version-2.0.0/installation/updates.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 index 871b7324..5f6d9984 100644 --- 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 @@ -111,7 +111,7 @@ to update to. :::note -If you have an Observer model robot please use the follow command to update +If you have an Observer model robot please use the following command to update ```code python3 /opt/onav//app/upgrade/update.py -v -c observer