Ridgeback User Manual and Integration Guide

components/installing_remote_computer_software.mdx

@@ -29,6 +29,12 @@ Remote Computer must be configured correctly.
      >
        <code>sudo apt-get install ros-noetic-dingo-desktop</code>
      </TabItem>
+     <TabItem
+       value="ridgeback"
+       label="Ridgeback"
+     >
+       <code>sudo apt-get install ros-noetic-ridgeback-desktop</code>
+     </TabItem>
    </Tabs>
 
 3. Configure Remote ROS Connectivity.
@@ -62,5 +68,11 @@ Remote Computer must be configured correctly.
      >
        <code>roslaunch dingo_viz view_robot.launch</code>
      </TabItem>
+     <TabItem
+       value="ridgeback"
+       label="Ridgeback"
+     >
+       <code>roslaunch ridgeback_viz view_robot.launch</code>
+     </TabItem>
    </Tabs>
    From within RViz, you can use interactive markers to drive your robot, you can visualize its published localization estimate and you can visualize any attached sensors which have been added to its robot description XML _URDF_.

components/installing_robot_software.mdx

@@ -1,11 +1,15 @@
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
-There are three ways to install software on the physical robot.
+There are three methods to install software on the physical robot.
 
-The preferred way is using the Clearpath Robotics ISO image, which is covered in this section.
-The other two ways are using Debian (.deb) packages and installing from source by directly cloning Clearpath Robotics Github repositories and building them in your ROS (catkin) workspace;
-however, these ways are not covered in this section.
+The preferred method is using the Clearpath Robotics ISO image, which is covered in this section.
+
+The second method is using Debian (.deb) packages, which is also covered in this section.
+
+The final approach is installing from source by directly cloning Clearpath Robotics Github
+repositories and building them in your ROS (catkin) workspace; however, this method is not
+covered in this section.
 
 ##### Install from ISO Image
 
@@ -93,6 +97,16 @@ To install the software on a physical robot through the Clearpath Robotics ISO i
           sudo systemctl daemon-reload
         </code>
       </TabItem>
+      <TabItem
+        value="ridgeback"
+        label="Ridgeback"
+      >
+        <code>
+          rosrun ridgeback_bringup install
+          <br />
+          sudo systemctl daemon-reload
+        </code>
+      </TabItem>
     </Tabs>
 
 9.  Finally, start ROS for the first time. In terminal, run:
@@ -101,76 +115,113 @@ To install the software on a physical robot through the Clearpath Robotics ISO i
     sudo systemctl start ros
     ```
 
-<!-- The ros-noetic-*-robot packages don't seem to exist, so commenting out this section for now.
-
 ##### Installing from Debian Packages
 
 If you are installing software on a physical robot through Debian packages, you will first
 need to ensure that the robot's computer is running Ubuntu 20.04 (Focal) and ROS Noetic.
 
-1. Before you can install the Dingo packages, you need to configure Ubuntu's APT package
-    manager to add Clearpath's package server.
-
-    1. Install the authentication key for the packages.clearpathrobotics.com repository. In terminal, run:
-
-        ```
-        wget https://packages.clearpathrobotics.com/public.key -O - | sudo apt-key add -
-        ```
-
-    2. Add the debian sources for the repository. In terminal, run:
-
-       ```
-       sudo sh -c 'echo "deb https://packages.clearpathrobotics.com/stable/ubuntu $(lsb_release -cs) main" > /etc/apt/sources.list.d/clearpath-latest.list'
-       ```
-
-    3. Update your computer's package cache. In terminal, run:
-
-        ```
-        sudo apt-get update
-        ```
-
-  2. After the robot's computer is configured to use Clearpath's debian package repository,
-     you can install the robot-specific packages.
-
-      1. On a physical robot, you should only need the robot packages. In terminal, run:
-
-          <Tabs groupId="ros_versions">
-            <TabItem
-              value="husky"
-              label="Husky"
-              default
-            >
-              <code>sudo apt-get install ros-noetic-husky-robot</code>
-            </TabItem>
-            <TabItem
-              value="dingo"
-              label="Dingo"
-            >
-              <code>sudo apt-get install ros-noetic-dingo-robot</code>
-            </TabItem>
-          </Tabs>
-
-      2. Install the `robot_upstart` job and configure the bringup service so that ROS will launch each time the robot starts. In terminal, run:
-
-          <Tabs groupId="ros_versions">
-            <TabItem
-              value="husky"
-              label="Husky"
-              default
-            >
-              <code>rosrun husky_bringup install<br />sudo systemctl daemon-reload</code>
-            </TabItem>
-            <TabItem
-              value="dingo"
-              label="Dingo"
-            >
-              <code>rosrun dingo_bringup install<br />sudo systemctl daemon-reload</code>
-            </TabItem>
-          </Tabs>
-
-      3. Finally, start ROS for the first time. In terminal, run:
-
-            ```
-            sudo systemctl start ros
-            ```
--->
+1. Before you can install the robot packages, you need to configure Ubuntu's APT package
+   manager to add Clearpath's package server.
+
+   1. Install the authentication key for the packages.clearpathrobotics.com repository. In terminal, run:
+
+      ```
+      wget https://packages.clearpathrobotics.com/public.key -O - | sudo apt-key add -
+      ```
+
+   2. Add the debian sources for the repository. In terminal, run:
+
+      ```
+      sudo sh -c 'echo "deb https://packages.clearpathrobotics.com/stable/ubuntu $(lsb_release -cs) main" > /etc/apt/sources.list.d/clearpath-latest.list'
+      ```
+
+   3. Update your computer's package cache. In terminal, run:
+
+      ```
+      sudo apt-get update
+      ```
+
+2. After the robot's computer is configured to use Clearpath's debian package repository,
+   you can install the robot-specific packages.
+
+   1. On a physical robot, you should only need the robot packages. In terminal, run:
+
+      <Tabs groupId="ros_versions">
+        <TabItem
+          value="husky"
+          label="Husky"
+          default
+        >
+          <code>sudo apt-get install ros-noetic-husky-robot</code>
+        </TabItem>
+        <TabItem
+          value="jackal"
+          label="Jackal"
+        >
+          <code>sudo apt-get install ros-noetic-jackal-robot</code>
+        </TabItem>
+        <TabItem
+          value="dingo"
+          label="Dingo"
+        >
+          <code>sudo apt-get install ros-noetic-dingo-robot</code>
+        </TabItem>
+        <TabItem
+          value="ridgeback"
+          label="Ridgeback"
+        >
+          <code>sudo apt-get install ros-noetic-ridgeback-robot</code>
+        </TabItem>
+      </Tabs>
+
+   2. Install the `robot_upstart` job and configure the bringup service so that ROS will launch each time the robot starts. In terminal, run:
+
+      <Tabs groupId="ros_versions">
+        <TabItem
+          value="husky"
+          label="Husky"
+          default
+        >
+          <code>
+            rosrun husky_bringup install
+            <br />
+            sudo systemctl daemon-reload
+          </code>
+        </TabItem>
+        <TabItem
+          value="jackal"
+          label="Jackal"
+        >
+          <code>
+            rosrun jackal_bringup install
+            <br />
+            sudo systemctl daemon-reload
+          </code>
+        </TabItem>
+        <TabItem
+          value="dingo"
+          label="Dingo"
+        >
+          <code>
+            rosrun dingo_bringup install
+            <br />
+            sudo systemctl daemon-reload
+          </code>
+        </TabItem>
+        <TabItem
+          value="ridgeback"
+          label="Ridgeback"
+        >
+          <code>
+            rosrun ridgeback_bringup install
+            <br />
+            sudo systemctl daemon-reload
+          </code>
+        </TabItem>
+      </Tabs>
+
+   3. Finally, start ROS for the first time. In terminal, run:
+
+      ```
+      sudo systemctl start ros
+      ```

components/introduction_ridgeback.mdx

@@ -1,9 +1,6 @@
-:::warning under construction
-
-:::
-
----
-
-## Introduction
-
-Clearpath Robotics Ridgeback is a rugged, indoor omnidirectional platform designed to move manipulators and other heavy payloads with ease and precision.
+<center>
+  <img
+    src="/img/robot_images/ridgeback_images/ridgeback-1.png"
+    width="400"
+  />
+</center>

components/maintenance/getting_new_packages.mdx

@@ -0,0 +1,18 @@
+:::note
+
+If you are upgrading your robot from an older version of ROS, please refer to our upgrade instructions [here](https://clearpathrobotics.com/assets/guides/kinetic/kinetic-to-melodic/index.html) and [here](https://clearpathrobotics.com/assets/guides/melodic/melodic-to-noetic/index.html).
+
+:::
+
+### Getting New Packages
+
+Clearpath Robotics robots are always being improved, both its own software and the many community ROS packages upon which it depends!
+You can use the `apt` package management system to receive new versions all software running on the platform.
+
+Each robot leaves the factory already configured to pull packages from http://packages.ros.org as well as http://packages.clearpathrobotics.com.
+To update your package and download new package versions, simply run:
+
+```
+sudo apt-get update
+sudo apt-get dist-upgrade
+```

components/remote_ros_connectivity.mdx

@@ -25,7 +25,7 @@ corresponding line to the Remote Computer's `/etc/hosts` file:
 :::note
 
 You can verify the hostname and IP address of your robot using the following commands during an SSH session
-with the Onboard PC.
+with the Onboard Computer.
 
 :::
 

components/software_sensor_iso_supported.mdx

@@ -38,6 +38,16 @@ This allows you to add or remove the sensor from your robot's software descripti
       </li>
     </ul>
   </TabItem>
+  <TabItem
+    value="ridgeback"
+    label="Ridgeback"
+  >
+    <ul>
+      <li>
+        <a href="https://github.com/ridgeback/ridgeback/tree/melodic-devel/ridgeback_description">Ridgeback Description</a>
+      </li>
+    </ul>
+  </TabItem>
 </Tabs>
 
 <br />
@@ -62,7 +72,7 @@ This allows you to add or remove the sensor from your robot's software descripti
   >
     <ul>
       <li>
-        <p>TODO</p>
+        <a href="/docs/robots/jackal/tutorials_jackal/#jackal-software-setup">Installing Jackal Software</a>
       </li>
     </ul>
   </TabItem>
@@ -76,4 +86,14 @@ This allows you to add or remove the sensor from your robot's software descripti
       </li>
     </ul>
   </TabItem>
+  <TabItem
+    value="ridgeback"
+    label="Ridgeback"
+  >
+    <ul>
+      <li>
+        <a href="/docs/robots/ridgeback/tutorials_ridgeback/#ridgeback-software-setup">Installing Ridgeback Software</a>
+      </li>
+    </ul>
+  </TabItem>
 </Tabs>

docs/robots/dingo/integration_dingo/integration_dingo.mdx

@@ -10,8 +10,10 @@ import ComponentPacsMechanical from "/components/pacs_mechanical.mdx";
 import ComponentCommonSoftwareIntegration from "/components/common_software_integration.mdx";
 import Support from "/components/support.mdx";
 
+<ComponentIntroductionDingo />
+
 To attach custom hardware to Dingo, you will have to take care of mechanical mounting, electrical
-supply, and software integration. This section aims to equip you with respect to these challenges.
+supply, and software integration. This guide aims to equip you with respect to these challenges.
 
 ---
 

docs/robots/dingo/maintenance_dingo.mdx

@@ -5,6 +5,7 @@ sidebar_position: 5
 
 import ComponentIntroductionDingo from "/components/introduction_dingo.mdx";
 import ComponentLeadAcidBatteryCare from "/components/maintenance/lead_acid_battery_care.mdx";
+import GettingNewPackages from "/components/maintenance/getting_new_packages.mdx";
 import Support from "/components/support.mdx";
 
 <ComponentIntroductionDingo />
@@ -19,26 +20,9 @@ With proper maintenance, the battery should maintain the majority of its capacit
 
 ---
 
-## Software Maintenance  {#software_maintenance}
+## Software Maintenance {#software_maintenance}
 
-:::note
-
-If you are upgrading your Dingo from an older version of ROS, please refer to our upgrade instructions [here](https://clearpathrobotics.com/assets/guides/kinetic/kinetic-to-melodic/index.html) and [here](https://clearpathrobotics.com/assets/guides/melodic/melodic-to-noetic/index.html).
-
-:::
-
-### Getting New Packages
-
-Dingo is always being improved, both its own software and the many community ROS packages upon which it depends!
-You can use the `apt` package management system to receive new versions all software running on the platform.
-
-Each Dingo leaves the factory already configured to pull packages from http://packages.ros.org as well as http://packages.clearpathrobotics.com.
-To update your package and download new package versions, simply run:
-
-```
-sudo apt-get update
-sudo apt-get dist-upgrade
-```
+<GettingNewPackages />
 
 ### MCU Firmware Update