Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion components/introduction_husky.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<center>
<img
src="/img/robot_images/husky_images/robot_husky_0.png"
src="/img/robot_images/husky_images/husky_banner.png"
width="400"
/>
</center>
Expand Down
2 changes: 1 addition & 1 deletion components/introduction_jackal.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<center>
<img
src="/img/robot_images/jackal_images/robot_jackal_0.png"
src="/img/robot_images/jackal_images/jackal_banner.png"
width="400"
/>
</center>
2 changes: 1 addition & 1 deletion components/introduction_warthog.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<center>
<img
src="/img/robot_images/warthog_images/robot_warthog_0.png"
src="/img/robot_images/warthog_images/warthog_banner.png"
width="400"
/>
</center>
32 changes: 25 additions & 7 deletions docs/computers/mini_itx.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,29 @@ sidebar_label: Mini ITX
sidebar_position: 2
---

Mini ITX computers are the default computer option for many Clearpath robots.

:::note

To install and configure software on your Mini ITX computer, refer to the tutorials
on the individual robot pages, such as [this Husky tutorial](/docs/robots/husky/tutorials_husky#installing-and-configuring-robot-software).

:::

:::note

If you want Clearpath Robotics to integrate sensors on your robot, contact our Sales team
at sales@clearpathrobotics.com, whether you want to use a new Clearpath Robotics platform,
or reuse your existing vehicle.

:::

:::note

Contact our Support team at support@clearpathrobotics.com if you have any questions.

:::

## Troubleshooting

#### Computer will not turn on automatically
Expand Down Expand Up @@ -51,15 +74,10 @@ To replace it:
Contact our Support team if you cannot find a replacement.
7. Turn on the computer, and reenter your BIOS settings.

:::danger TODO—under construction
<!-- Future work

1. describe computer components
2. explain how computers are powered in robots
3. upgrading computer hardware
4. adding the Clearpath OS to the computer
5. Setting up ROS (to be covered on a different page)
6. troubleshooting
7. Contact sales
8. further reading

:::
-->
15 changes: 13 additions & 2 deletions docs/manipulators/manipulators.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,17 @@ sidebar_position: 1
</figure>
</center>

:::warning todo—under construction
---

These pages outline the hardware and software steps required to get manipulators installed on your Clearpath robot.
This documentation should be considered a quick reference, rather than a complete technical data package from the manipulator's Original Equipment Manufacturer.

Also note that we have only listed the documentation of our most commonly used manipulators.

We suggest you:

:::
1. Review our documentation of the manipulators related to your robot integration.
2. Review the related Further Reading section.
3. If you are planning to purchase a manipulator, consider visiting our [Component Store](https://store.clearpathrobotics.com/).
4. If you want Clearpath Robotics to integrate sensors on your robot, contact our Sales team at sales@clearpathrobotics.com, whether you want to use a new Clearpath Robotics platform, or reuse your existing vehicle.
5. Contact our Support team at support@clearpathrobotics.com if you have any questions.
3 changes: 2 additions & 1 deletion docs/robots/boxer/integration_boxer.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Integration
title: Boxer Integration
sidebar_label: Integration
sidebar_position: 2
---

Expand Down
3 changes: 2 additions & 1 deletion docs/robots/boxer/maintenance_boxer.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Maintenance
title: Boxer Maintenance
sidebar_label: Maintenance
sidebar_position: 4
---

Expand Down
48 changes: 45 additions & 3 deletions docs/robots/boxer/troubleshooting_boxer.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,54 @@
---
title: Troubleshooting
title: Boxer Troubleshooting
sidebar_label: Troubleshooting
sidebar_position: 5
---

import ComponentIntroductionBoxer from "/components/introduction_boxer.mdx";
import ComponentSupportIntroduction from "/components/support_introduction.mdx";
import Support from "/components/support.mdx";

<ComponentIntroductionBoxer />

:::warning todo—under construction
<ComponentSupportIntroduction />

:::
---

## Networking

### Not getting Wi-Fi internet connection

Refer to the [Networking page](/docs/software/networking).

### Cannot connect to the robot's computer over a network cable

Reter to the [Networking page](/docs/software/networking).

---

## Computer

### The computer does not automatically start

Refer to the [Mini ITX troubleshooting page](/docs/computers/mini_itx).

### The computer keeps reverting to old BIOS settings

Refer to the [Mini ITX troubleshooting page](/docs/computers/mini_itx).

---

## ROS

### ROS package is not starting

Verify the upstart logs, `/var/log/upstart/husky_core.log`, to see if there are any error during upstart.

### Sensors are not turning on

1. Check that the sensor's User Power connector has the correct voltage.
2. If the voltage is correct, then review the [Troubleshooting section for the related sensor](/docs/sensors).

## If the Issue Persists

<Support />
3 changes: 2 additions & 1 deletion docs/robots/boxer/tutorials_boxer.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Tutorials
title: Boxer Tutorials
sidebar_label: Tutorials
sidebar_position: 3
---

Expand Down
3 changes: 2 additions & 1 deletion docs/robots/boxer/user_manual_boxer.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: User Manual
title: Boxer User Manual
sidebar_label: User Manual
sidebar_position: 1
---

Expand Down
3 changes: 2 additions & 1 deletion docs/robots/dingo/maintenance_dingo.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Maintenance
title: Dingo Maintenance
sidebar_label: Maintenance
sidebar_position: 5
---

Expand Down
48 changes: 45 additions & 3 deletions docs/robots/dingo/troubleshooting_dingo.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,54 @@
---
title: Troubleshooting
title: Dingo Troubleshooting
sidebar_label: Troubleshooting
sidebar_position: 6
---

import ComponentIntroductionDingo from "/components/introduction_dingo.mdx";
import ComponentSupportIntroduction from "/components/support_introduction.mdx";
import Support from "/components/support.mdx";

<ComponentIntroductionDingo />

:::warning todo—under construction
<ComponentSupportIntroduction />

:::
---

## Networking

### Not getting Wi-Fi internet connection

Refer to the [Networking page](/docs/software/networking).

### Cannot connect to the robot's computer over a network cable

Reter to the [Networking page](/docs/software/networking).

---

## Computer

### The computer does not automatically start

Refer to the [Mini ITX troubleshooting page](/docs/computers/mini_itx).

### The computer keeps reverting to old BIOS settings

Refer to the [Mini ITX troubleshooting page](/docs/computers/mini_itx).

---

## ROS

### ROS package is not starting

Verify the upstart logs, `/var/log/upstart/husky_core.log`, to see if there are any error during upstart.

### Sensors are not turning on

1. Check that the sensor's User Power connector has the correct voltage.
2. If the voltage is correct, then review the [Troubleshooting section for the related sensor](/docs/sensors).

## If the Issue Persists

<Support />
3 changes: 2 additions & 1 deletion docs/robots/dingo/tutorials_dingo.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Tutorials
title: Dingo Tutorials
sidebar_label: Tutorials
sidebar_position: 4
---

Expand Down
10 changes: 3 additions & 7 deletions docs/robots/dingo/user_manual_dingo.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: User Manual
title: Dingo User Manual
sidebar_label: User Manual
sidebar_position: 1
toc_min_heading_level: 2
toc_max_heading_level: 4
Expand Down Expand Up @@ -166,15 +167,10 @@ To connect the shore power, remove the top trough cover (to access the MCU) and

The reference frame used by all Clearpath Robotics ground robots is based on ISO 8855.

<!--- TODO:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you want to change HTML comments with TODO in them? It may be difficult to find these comments in the future. Should these comments be removed?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For anything I though we might actually fix in the future, I changed "TODO" to "Future". For anything where I thought we were unlikely to spend the time making changes, I simply removed. The example you have noted is a case where I expect we are unlikely to return in the future to add an image of the Dingo with the reference frame.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thoughts?

, and is shown in the figure below.
Husky's front is shown.
--->

When commanded with a positive translational velocity (forward), wheels travel in the positive X-direction.
The direction of the axes differs from those used for roll, pitch, and yaw in aircraft, and care should be taken to ensure that data is interpreted correctly.

<!-- TODO: need image -->
<!-- Future: need image -->

### System Specifications

Expand Down
5 changes: 3 additions & 2 deletions docs/robots/husky/integration_husky/integration_husky.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,18 @@ toc_min_heading_level: 2
toc_max_heading_level: 4
---

import ComponentIntroductionHusky from "/components/introduction_husky.mdx";
import ComponentPacsFasteners from "/components/pacs_fasteners.mdx";
import ComponentPacsMechanical from "/components/pacs_mechanical.mdx";
import ComponentCommonSoftwareIntegration from "/components/common_software_integration.mdx";
import ComponentTableHuskyOne from "/components/table_husky_1.mdx";
import Support from "/components/support.mdx";

<ComponentIntroductionHusky />

To attach custom hardware to Husky, you will have to take care of mechanical mounting, electrical
supply, and software integration. This guide aims to equip you with respect to these challenges.

---

## Mechanical Mounting

When determining mechanical mounting, you have two options, both of which are described below.
Expand Down
21 changes: 5 additions & 16 deletions docs/robots/husky/maintenance_husky.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Maintenance
title: Husky Maintenance
sidebar_label: Maintenance
sidebar_position: 5
---

Expand Down Expand Up @@ -246,24 +247,12 @@ Husky firmware updates are needed.

---

:::danger TODO—under construction
## Future Work

#### Components to replace
### Components that may require replacement

- Battery, and charging
- ~~Fuses~~
- Battery
- MCU
- PUMA
- Gearmotor
- ~~Tires~~
- ~~Tire inner tubes~~
- ~~Computer CMOS Battery~~
- ~~Computer~~
- Drive Belt

#### Components to maintain

- Tire pressure
- Battery charging

:::
18 changes: 8 additions & 10 deletions docs/robots/husky/troubleshooting_husky.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -178,11 +178,11 @@ Your Husky will roll if:

### Not getting Wi-Fi internet connection

Refer to the [Troubleshooting section of the Networking page](/docs/software/networking).
Refer to the [Networking page](/docs/software/networking).

### Cannot connect to the robot's computer over a network cable

Reter to the [Troubleshooting section of the Networking page](/docs/software/networking).
Reter to the [Networking page](/docs/software/networking).

---

Expand All @@ -209,33 +209,31 @@ Verify the upstart logs, `/var/log/upstart/husky_core.log`, to see if there are
1. Check that the sensor's User Power connector has the correct voltage.
2. If the voltage is correct, then review the [Troubleshooting section for the related sensor](/docs/sensors).

TODO: Check if these are incorporated:

**The blue light around the power button does not display when pressing the power button.**
### The blue light around the power button does not display when pressing the power button.

1. Ensure that the battery is charged and correctly connected.
2. Use a multimeter to verify the voltage on the battery terminals.

**`COMM` status light stays red or flickers.**
### `COMM` status light stays red or flickers.

1. Your program may not be sending motion commands faster than 10 Hz.
2. If there is a poor quality connection, some commands may be lost, so it may be necessary to increase the frequency of commands sent.
3. The maximum frequency commands can be sent is 50 Hz.

**`STOP` status light illuminated**
### `STOP` status light illuminated

1. Twist the red stop button to release it.
2. Confirm that the robot is not locked out.

**_Battery Status_ indicator flashing**
### _Battery Status_ indicator flashing

1. Battery voltage is too low for Husky to drive the motors.
2. Charge the battery and try again.

**A ROS package isn't starting**
### A ROS package isn't starting

1. Verify the upstart logs, `/var/log/upstart/husky_core.log` to see if there are any error during upstart.

### If the Issue Persists
## If the Issue Persists

<Support />
3 changes: 2 additions & 1 deletion docs/robots/husky/tutorials_husky.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Tutorials
title: Husky Tutorials
sidebar_label: Tutorials
sidebar_position: 4
---

Expand Down
Loading