Skip to content

Commit e8621a7

Browse files
author
Javier Moreno
committed
Refs #3486 - Create Readme.md for uROS agent
1 parent a77c0f7 commit e8621a7

1 file changed

Lines changed: 34 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,35 @@
1-
# micro-ros-agent
1+
# Overview
22

3+
This repo contains the Micro-Ros Agent package.
4+
Micro-Ros Agent is a ROS2 node that wrapps the Micro XRCE-DDS Agent.
5+
For farther information about Micro XRCE-DDA Agent click [here](https://github.com/eProsima/Micro-XRCE-DDS-Agent)
6+
7+
The node acts as a server between DDS Network and Micro-ROS nodes.
8+
It will receive messages containing operations from Micro-ROS nodes, keep track of the Micro-ROS nodes.
9+
The node will interact with DDS Global Data Space on behalf of the Micro-ROS nodes.
10+
11+
While the node is running, it attends any received request from the Micro-ROS nodes and will answers back with the result of a request each time a request is attended.
12+
13+
14+
# Package features
15+
16+
## XML generation
17+
18+
During the build proces, the package will look for all ROS2 / Micro-ROS messages in order to generare XML profiles.
19+
This XML file can be referenced in the Agent-Client comunication in order to avoid sending the full XML content.
20+
21+
22+
## Agent-Client comunication mechanims
23+
24+
Communication between the Micro-ROS Agent and the Micro-ROS nodes supports two kind transports:
25+
- UDP
26+
- SerialPort.
27+
28+
29+
# Node configuration
30+
31+
## Transport type
32+
33+
### udp
34+
35+
### Serial port

0 commit comments

Comments
 (0)