Skip to content

Updated AMP/Observer to include networking setup and OutdoorNav links #403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jun 13, 2025
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
24 changes: 24 additions & 0 deletions components/husky_a300/husky_a300_amp_check_sensors.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
### Check That Sensors Are Functional

Husky AMP includes several sensors that are used for robot navigation. After connecting
to Husky AMP's network, confirm that each sensor is functional by using the steps below.

1. Connect to your laptop to the robot using SSH. To do so, execute the following in a terminal window:
```
ssh [email protected]
```
You will be prompted to enter a password. The default password is `clearpath`.
1. Use the `ping` command to check that each of the [sensors](#ip-addresses) is functional.
For example, to confirm that the front teleop camera (`192.168.131.15`) is working:
```
$ ping 192.168.131.15
PING 192.168.131.15 (192.168.131.2) 56(84) bytes of data.
64 bytes from 192.168.131.15: icmp_seq=1 ttl=255 time=0.265 ms
64 bytes from 192.168.131.15: icmp_seq=2 ttl=255 time=0.213 ms
64 bytes from 192.168.131.15: icmp_seq=3 ttl=255 time=0.282 ms
64 bytes from 192.168.131.15: icmp_seq=4 ttl=255 time=0.216 ms
^C
--- 192.168.131.15 ping statistics ---
4 packets transmitted, 4 received, 0% packet loss, time 3100ms
rtt min/avg/max/mdev = 0.213/0.244/0.282/0.030 ms
```
19 changes: 19 additions & 0 deletions components/husky_a300/husky_a300_amp_networking_basic.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import Admonition from "@theme/Admonition";

### Connecting To Husky AMP's Network {#basic-network-connection}

To access additional Husky AMP functionality, a network connection to the robot is required.
The easiest way to accomplish this is to connect your laptop to Husky AMP's Wi-Fi
access point using the steps below.

1. Use your laptop to find and to connect to Husky AMP's Wi-Fi network. The Wi-Fi network name (SSID) will be
`cpr_a300_amp_XXXXX`, where `XXXXX` matches the serial number of the Husky AMP. When
prompted, use the password `clearpath`.

1. Confirm that your laptop's Wi-Fi network interface is configured to use DHCP and that it
has been assigned an IP address in the `192.168.131.XXX` range.

<Admonition type="danger" title="Additional Networking Options">
Refer to <a href="#network-connection">Robot Network Connection</a> for alternative networking connections.
</Admonition>

16 changes: 16 additions & 0 deletions components/husky_a300/husky_a300_amp_outdoornav_checks.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
### Confirming That OutdoorNav Software Is Functioning

Husky AMP includes OutdoorNav Software, which allows the robot to be operated autonomously.
Follow the steps below to confirm that OutdoorNav Software is functioning.

1. [Connect to Web UI](/docs_outdoornav_user_manual/quick_start#connecting_to_web_ui)
1. [Check camera views](/docs_outdoornav_user_manual/quick_start#checking-camera-feeds)
1. [Check system status](/docs_outdoornav_user_manual/quick_start#checking-system-status)
1. [Check GPS RTK fix](/docs_outdoornav_user_manual/quick_start#checking-gpt-rtk-fix)
1. Complete system configuration:
1. [Load map tiles](/docs_outdoornav_user_manual/quick_start#loading_map_tiles)
1. [Set dock location](/docs_outdoornav_user_manual/quick_start#set-dock-location), if a dock is included with your system
1. [Create your first map](/docs_outdoornav_user_manual/quick_start#create-your-first-map)
1. [Create your first mission](/docs_outdoornav_user_manual/quick_start#create-your-first-mission)
1. [Execute your first mission](/docs_outdoornav_user_manual/quick_start#execute-your-first-mission)

2 changes: 1 addition & 1 deletion components/husky_a300/husky_a300_charging_the_robot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Refer to the [Lighting page](/docs/ros/api/lighting) for details of all the robo
{(props.robotModel == "Observer") && <>The included <em>Wireless Charger</em> can also be used in a wet environment, aligning with Husky's IP54 ingress protection rating.</>}
</Admonition>

#### Wireless Charging
#### Wireless Charging {#wireless-charging}

<center>
<figure>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The Husky's status lights show these light patterns for different Emergency Stop
After clearing the Emergency Stop, the Husky's status lights should change to the _Needs Reset_ state's pattern.
This state is common for machinery safety; as it waits for the machine operator to confirm that the machine should continue normal operations.

#### To Clear The Needs Reset State:
#### To Clear The Needs Reset State: {#clear-needs-reset}

1. Press the _Emergency Stop Restart Button_ on at the back of the Husky.
2. Or, if included, connect your Wireless Emergency Stop remote.
15 changes: 15 additions & 0 deletions components/husky_a300/husky_a300_network_connection.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import ComponentEthernetConnection from "/components/husky_a300/networking/husky_a300_ethernet_connection.mdx";
import ComponentPeplinkWifiApCconnection from "/components/husky_a300/networking/husky_a300_peplink_wifi_ap_connection.mdx";
import ComponentNetplanWifiClient from "/components/husky_a300/networking/husky_a300_netplan_wifi_client.mdx";
import ComponentPeplinkWifiClient from "/components/husky_a300/networking/husky_a300_peplink_wifi_client.mdx";
import ComponentPeplinkCellular from "/components/husky_a300/networking/husky_a300_peplink_cellular.mdx";

### Robot Network Connection {#network-connection}

Husky provides several network connection options, the details of which are outlined below.

<ComponentEthernetConnection />
{(props.robotModel == "A300") && <ComponentNetplanWifiClient />}
{((props.robotModel == "AMP") || (props.robotModel == "Observer")) && <ComponentPeplinkWifiApCconnection />}
{((props.robotModel == "AMP") || (props.robotModel == "Observer")) && <ComponentPeplinkWifiClient />}
{((props.robotModel == "AMP") || (props.robotModel == "Observer")) && <ComponentPeplinkCellular />}
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Performing a circle check can reduce safety risks, increase the operating lifespan of the robot, and improve the efficiency of your work.
These are our suggested daily checks before sending the Husky on missions:

1. Check that the weather forcast has acceptable conditions for the robot.
1. Check that the weather forecast has acceptable conditions for the robot.
2. Check that the intended worksite's terrain is acceptable, without deep trenches, overhanging obstacles, children, of other hazards that were not acceptable per your Risk Assessment.
3. Check the tire pressures.
4. Inspect the tire treads for excessive wear of punctures.
Expand Down
2 changes: 1 addition & 1 deletion components/husky_a300/husky_a300_safety.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import Admonition from "@theme/Admonition";

### Safety
### Safety {#a300-safety}

Clearpath Robotics's top priority is the safety of people interacting with our products.
Clearpath Robotics produces high power and fast-moving pieces of machinery that could cause serious injury—including death—if the machinery is used or maintained improperly.
Expand Down
2 changes: 1 addition & 1 deletion components/husky_a300/husky_a300_safety_alternate.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import Admonition from "@theme/Admonition";
import AdmonitionTypes from "/src/theme/Admonition/Types";

### Safety
### Safety {#a300-safety}

Clearpath Robotics's top priority is the safety of people interacting with our products.
Clearpath Robotics produces high power and fast-moving pieces of machinery that could cause serious injury—including death—if the machinery is used or maintained improperly.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
#### Connecting to Husky over an Ethernet Connection {#ethernet-connection}

Husky can always be accessed over an Ethernet connection, following the steps below.

1. Open the Rear Charge Port Door on Husky to expose the debug Ethernet port.
1. Connect an Ethernet cable from Husky's debug Ethernet port to your laptop.
1. Set your laptop's IP address and netmask as shown below.
- **IP Address**: 192.168.131.100
- **Netmask**: 255.255.255.0
1. Confirm that you can ping Husky from your laptop's terminal window in Linux or the
command prompt in Windows by entering the following command:
```ping 192.168.131.1```
The output should be similar to the following.
```
Pinging 192.168.131.1 with 32 bytes of data:
Reply from 192.168.131.1: bytes=32 time<1ms TTL=128
Reply from 192.168.131.1: bytes=32 time<1ms TTL=128
Reply from 192.168.131.1: bytes=32 time<1ms TTL=128
Reply from 192.168.131.1: bytes=32 time<1ms TTL=128

Ping statistics for 192.168.131.1:
Packets: Sent = 4, Received = 4, Lost = 0 (0% loss),
Approximate round trip times in milli-seconds:
Minimum = 0ms, Maximum = 0ms, Average = 0ms
```
1. Connect to your laptop to the robot using SSH. To do so, execute the following in a terminal window:
```
ssh [email protected]
```
You will be prompted to enter a password. The default password is `clearpath`.
:::note
All Clearpath robots ship from the factory with their login password set to `clearpath`.
Upon receipt of your robot we recommend changing the password. To change the password,
run the following command on the robot:
```
passwd
```
This will prompt you to enter the current password, followed by the new password twice.
While typing the passwords in the `passwd` prompt there will be no visual feedback
(e.g. `*` characters).
:::

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#### Connecting Husky to a Wi-Fi Network {#wifi-client-setup}

To get Husky connected to your local Wi-Fi network, follow the setup below.

1. Follow the steps for [Connecting to Husky over an Ethernet Connection](#ethernet-connection).
1. Follow the [Wi-Fi connection](/docs/ros/networking/computer_setup#netplan-wifi)
instructions for setting up the Wi-Fi network.

Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
#### Connecting Husky to a Cellular Network {#cellular-setup}

To get Husky AMP or Husky Observer connected to a cellular network, follow the steps below.

1. Install your SIM card into Husky's router by removing the Husky's
right side panel, removing the cover on the `Cellular SIM` port on the router
inserting the SIM card into slot `A`, and reinstalling the covers.
1. [Connect your laptop to Husky's AMP network](#basic-network-connection).
1. In a web browser, open the configuration page for Husky's router: https://192.168.131.51
- Username: `admin`
- Default password: `Clearpath1`
1. Click on the `Cellular` link.
<center>
<figure>
<img
src="/img/robot_images/husky_a300_images/peplink_select_cellular.png"
width="700"
/>
<figcaption>Select Cellular</figcaption>
</figure>
</center>
1. On the new configuration page, complete the configuration as specified by your
cellular network provider. Ensure that the `Enabled` checkbox is clicked.
<center>
<figure>
<img
src="/img/robot_images/husky_a300_images/peplink_cellular_details.png"
width="700"
/>
<figcaption>Cellular settings</figcaption>
</figure>
</center>
1. Click `Save and Apply` and wait for a message confirming that the configuration has been applied.
1. Click on the `Dashboard` tab and confirm that the `Cellular` connection reports as `Connected`.
<center>
<figure>
<img
src="/img/robot_images/husky_a300_images/peplink_cellular_connected.png"
width="400"
/>
<figcaption>Cellular Connection Status</figcaption>
</figure>
</center>

:::info

For more advanced configurations, refer to the `Cellular WAN` section of the
[router's user manual](https://manual.peplink.com/peplink-max-user-manual/).

:::

Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
#### Connecting to Husky AMP's Wi-Fi Access Point {#wifi-ap-connection}

As an alternative to connecting over Ethernet, it is always possible to connect to Husky AMP's
Wi-Fi access point, following the steps below.

1. Use your laptop to connect to Husky AMP's Wi-Fi network. The Wi-Fi network name (SSID) will be
`cpr_a300_amp_XXXXX`, where `XXXXX` matches the serial number of the Husky AMP. When
prompted, use the password `clearpath`.
1. Confirm that your laptop's Wi-Fi network interface is configured to use DHCP and that it
has been assigned an IP address in the `192.168.131.XXX` range.
1. Confirm that you can ping Husky AMP from your laptop's terminal window in Linux or the
command prompt in Windows by entering the following command:
```ping 192.168.131.1```
The output should be similar to the following.
```
Pinging 192.168.131.1 with 32 bytes of data:
Reply from 192.168.131.1: bytes=32 time<1ms TTL=128
Reply from 192.168.131.1: bytes=32 time<1ms TTL=128
Reply from 192.168.131.1: bytes=32 time<1ms TTL=128
Reply from 192.168.131.1: bytes=32 time<1ms TTL=128

Ping statistics for 192.168.131.1:
Packets: Sent = 4, Received = 4, Lost = 0 (0% loss),
Approximate round trip times in milli-seconds:
Minimum = 0ms, Maximum = 0ms, Average = 0ms
```
1. Connect to your robot via SSH. To do so, execute the following in a terminal window:
```
ssh [email protected]
```

Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
#### Connecting Husky to a Wi-Fi Network {#wifi-client-setup}

To get Husky AMP or Husky Observer connected to your local Wi-Fi network, follow the steps below.

1. [Connect your laptop to Husky's AMP network](#basic-network-connection).
1. In a web browser, open the configuration page for Husky's router: https://192.168.131.51
- Username: `admin`
- Default password: `Clearpath1`
1. Click on either the `Wi-Fi WAN on 2.4 GHz` or `Wi-Fi WAN on 5GHz` link, depending on
whether you are setting up a 2.4 GHz or 5 GHz connection.
<center>
<figure>
<img
src="/img/robot_images/husky_a300_images/peplink_select_24g.png"
width="700"
/>
<figcaption>Select 2.4 GHz for configuration</figcaption>
</figure>
</center>
1. On the new configuration page, scroll to the bottom; under `Wi-Fi Connection Profiles`
click `Create Profile`.
<center>
<figure>
<img
src="/img/robot_images/husky_a300_images/peplink_create_connection_profile.png"
width="700"
/>
<figcaption>Create network profile</figcaption>
</figure>
</center>
1. Enter the SSID and password for the network, then click OK.
<center>
<figure>
<img
src="/img/robot_images/husky_a300_images/peplink_connection_profile_details.png"
width="700"
/>
<figcaption>Configure network profile</figcaption>
</figure>
</center>
1. Click `Save and Apply` and wait for a message confirming that the configuration has been applied.
1. Click on the `Dashboard` tab and confirm that the configured WAN connection reports as `Connected`.
<center>
<figure>
<img
src="/img/robot_images/husky_a300_images/peplink_wan_connected.png"
width="550"
/>
<figcaption>WAN Connection Status</figcaption>
</figure>
</center>

:::info

For more advanced configurations, refer to the `Wi-Fi WAN` section of the
[router's user manual](https://manual.peplink.com/peplink-max-user-manual/).

:::

Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,13 @@ roll speed in this state depends on both the slope and payload.

### Not getting Wi-Fi internet connection

See [above](#wifi-fault).
1. Confirm that Husky Wi-Fi has been [configured correctly](user_manual_husky#wifi-client-setup),
including correct SSID and password. Confirm that the settings are correct in the
corresponding `/etc/netplan/` file.
1. From Husky's computer, run `ip a` to review the status of the wireless interface and
determine if the connection has been established.
1. Power cycle the robot and see if the issue persists.
1. If the issues persists, contact [Support](#support).

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

Expand Down
Loading