Skip to content
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

Added documentation on the Micro XRCE-DDS Agent #139

Merged
merged 1 commit into from
Aug 8, 2024
Merged
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
20 changes: 20 additions & 0 deletions doc/ROS2/setup/Agent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Micro XRCE-DDS Agent

Sources: [here](https://micro-xrce-dds.docs.eprosima.com/en/latest/index.html)

## Installation

Follow the instructions detailed [here](https://micro-xrce-dds.docs.eprosima.com/en/latest/installation.html). It has only been tested as standalone executable (without Docker neither using Snap).
`cmake` and `make` are required to build the Agent.

## Using the agent with the serial interface

Run the agent with the command:

```bash
MicroXRCEAgent serial --dev /dev/ttyUSB0
```

## Using the agent with the wifi interface

The `wifi` transport layer has not been tested yet.