-
Notifications
You must be signed in to change notification settings - Fork 12
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
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
d7a2acc
First draft of AMP quickstart
jhiggins-cpr aa1493f
Added network connection details
jhiggins-cpr 154c93d
Fix broken link
jhiggins-cpr cb0e492
Moved new content to components
jhiggins-cpr 50c2023
Reworked layout based on discussion with Rhys
jhiggins-cpr 342da81
Updates from review feedback
jhiggins-cpr 937923a
Merge branch 'development' into amp_quickstart
jhiggins-cpr 443af6b
Add missing blank line
jhiggins-cpr 8964b8a
Merge branch 'amp_quickstart' of https://github.com/clearpathrobotics…
jhiggins-cpr File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
16
components/husky_a300/husky_a300_amp_outdoornav_checks.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) | ||
jhiggins-cpr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 />} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
42 changes: 42 additions & 0 deletions
42
components/husky_a300/networking/husky_a300_ethernet_connection.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). | ||
::: | ||
jhiggins-cpr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
8 changes: 8 additions & 0 deletions
8
components/husky_a300/networking/husky_a300_netplan_wifi_client.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode 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). | ||
jhiggins-cpr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
1. Follow the [Wi-Fi connection](/docs/ros/networking/computer_setup#netplan-wifi) | ||
instructions for setting up the Wi-Fi network. | ||
|
51 changes: 51 additions & 0 deletions
51
components/husky_a300/networking/husky_a300_peplink_cellular.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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` | ||
jhiggins-cpr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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/). | ||
|
||
::: | ||
|
31 changes: 31 additions & 0 deletions
31
components/husky_a300/networking/husky_a300_peplink_wifi_ap_connection.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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] | ||
``` | ||
|
59 changes: 59 additions & 0 deletions
59
components/husky_a300/networking/husky_a300_peplink_wifi_client.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> | ||
|
||
jhiggins-cpr marked this conversation as resolved.
Show resolved
Hide resolved
|
||
:::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/). | ||
|
||
::: | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.