Skip to content

Commit

Permalink
Merge pull request #290 from clearpathrobotics/development
Browse files Browse the repository at this point in the history
Production sync
  • Loading branch information
tonybaltovski authored Jan 9, 2025
2 parents 2246ebb + d12f6f7 commit af5a132
Show file tree
Hide file tree
Showing 27 changed files with 885 additions and 93 deletions.
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
ROS 2 networking uses an abstracted middleware referred to as the "RMW Implementation". The Clearpath robot packages support
eProsima Fast DDS as the middleware implementation. This middleware has two supported options for ROS 2 node discovery, Simple
Discovery and Discovery Server. Each of these discovery mechanisms has their own use case:
The Clearpath robot packages currently support eProsima Fast DDS as the ROS Middleware (RMW) Implementation. This middleware has two supported options for ROS 2 node discovery, Simple Discovery and Discovery Server. Each of these discovery mechanisms has their own use case:

**Simple Discovery**
- Default, does not require manual setup
- Generally operates on the basis that any ROS 2 devices on the network should be discoverable and connect automatically
- Requires multicasting on the network (may be restricted on school or corporate networks)
- Good for simple systems (small number of robots on a dedicated local network)
- Good for simple systems (small number of nodes on a dedicated local network)

**Discovery Server**
- Requires manual configuration in the robot.yaml
- Generally operates on the basis that ROS 2 networks should be controlled and can only discover other devices as directed
- Requires manual configuration in the `robot.yaml`
- Generally operates on the basis that ROS 2 networks should be controlled and should only discover other nodes as needed
- Does not require multicasting (more likely to work on school or corporate networks)
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
The default networking configuration for a robot's computer is to bridge all Ethernet interfaces and assign the computer
the IP address `192.168.131.1`. See [Network IP Addresses](../../ros/networking/network_ip_addresses.mdx) for a detailed list of IP ranges.
the IP address `192.168.131.1`. See [Standard IP Addresses](../../ros/networking/standard_ip_addresses.mdx) for a detailed list of IP ranges.

To configure the default bridge:
1. Run `sudo clearpath-computer-setup`
1. Run `sudo clearpath-computer-setup`
2. Navigate to **Netplan Setup** -> **Pre-set Configurations**.
3. Select **Standard Clearpath Bridge** and generate the configuration by following the instructions.
4. Return to the **Netplan Setup** menu and select **Apply Configuration Changes**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,6 @@ Clearpath uses this RTK correction in its OutdoorNav autonomy software, but we d

:::note

Refer to the [Network IP Addresses page](../../../ros/networking/network_ip_addresses.mdx) for the commonly used device IP addresses.
Refer to the [Standard IP Addresses page](../../../ros/networking/standard_ip_addresses.mdx) for the commonly used device IP addresses.

:::
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ this cannot be changed since the MCU is statically set to 192.168.131.2 and expe
| 192.168.131.20 | Front-facing LIDAR |
| 192.168.131.21 | Rear-facing LIDAR (if present) |

See [Network IP Addresses](../../../ros/networking/network_ip_addresses.mdx) for a full list of common IP addresses.
See [Standard IP Addresses](../../../ros/networking/standard_ip_addresses.mdx) for a full list of common IP addresses.

#### Payload Integration Plate

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,9 @@ import Support from "/components/support.mdx";

Clearpath Robotics Warthog is a rugged, all-terrain unmanned ground vehicle.

The Warthog is currently only supported in [ROS 1](/docs_versioned_docs/version-ros1noetic/robots/outdoor_robots/warthog/tutorials_warthog.mdx).

For more information or to receive a quote, please [visit us online](http://clearpathrobotics.com/warthog).

<!-- <ComponentTutorialLinks /> -->
<ComponentTutorialLinks />

---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ toc_min_heading_level: 2
toc_max_heading_level: 4
---

Using the [`image_transport`](https://github.com/ros-perception/image_common), [`image_transport_plugins`](https://github.com/ros-perception/image_transport_plugins) and [`ffmpeg_image_transport`](https://github.com/ros-misc-utilities/ffmpeg_image_transport) packages, it is possible to compress and stream images/video using ROS messages. This is important in order to enable the transmission of large images or video streams over wireless networks with limited bandwidth. For a walkthrough of a case study see [Video over WiFi](../tutorials/video_over_wifi.mdx). The supported compression methods are outlined below:
Using the [`image_transport`](https://github.com/ros-perception/image_common), [`image_transport_plugins`](https://github.com/ros-perception/image_transport_plugins) and [`ffmpeg_image_transport`](https://github.com/ros-misc-utilities/ffmpeg_image_transport) packages, it is possible to compress and stream images/video using ROS messages. This is important in order to enable the transmission of large images or video streams over wireless networks with limited bandwidth. For a walkthrough of a case study see [Video over Wi-Fi](../tutorials/video_over_wifi.mdx). The supported compression methods are outlined below:

| Image Transport Name | Topic Name | Compression Method | Purpose | Comments |
| :------------------- | :---------------- | :--------------------- |:------------------ |:--------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ sidebar_position: 2
toc_min_heading_level: 2
toc_max_heading_level: 5
---
import AxisCamera from "/docs_versioned_docs/version-ros2humble/components/yaml/sensors/axis_camera.mdx";
import FlirBlackfly from "/docs_versioned_docs/version-ros2humble/components/yaml/sensors/flir_blackfly.mdx";
import IntelRealsense from "/docs_versioned_docs/version-ros2humble/components/yaml/sensors/intel_realsense.mdx";
import StereolabsZed from "/docs_versioned_docs/version-ros2humble/components/yaml/sensors/stereolabs_zed.mdx";
Expand All @@ -19,6 +20,9 @@ For further details on how to work with large camera data, see [Camera Data Comp

## Supported Cameras

### Axis Camera
<AxisCamera/>

### Intel Realsense
<IntelRealsense/>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ services must be reinstalled as directed in the [software installation instructi

The **hosts** section serves as a way to match hostnames to IP addresses. By default, Clearpath robots use the serial number as
the hostname and have a default IP of `192.168.131.1`. This section must define ip addresses for all hostnames that appear in
the remainder of the `robot.yaml` file.
the remainder of the `robot.yaml` file.

For example:

Expand Down Expand Up @@ -55,7 +55,7 @@ ros2:
### Middleware

The **middleware** section defines the which RMW Implementation to use and any related settings. To choose
which implementation and discovery method is right for your project see [networking](../../networking/ros2-networking.mdx).
which implementation and discovery method is right for your project see [ROS 2 Discovery Configuration](../../networking/ros2_discovery_config.mdx).

| Key | Value / Datatype | Description |
|:---:| :--------------: | ----------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ Add the following line to your `~/.bashrc` file to automatically source the gene
source ~/clearpath/setup.bash
```

4. If you are using Fast DDS Discovery Server, follow the instructions on the [ROS 2 networking page](../networking/ros2-networking.mdx#offboard-pc).
4. If you are using Fast DDS Discovery Server, follow the instructions on [ROS 2 Discovery Configuration](../networking/ros2_discovery_config.mdx#offboard-pc).
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Network Troubleshooting",
"position": 9
}
Loading

0 comments on commit af5a132

Please sign in to comment.