5160fb06cd
Signed-off-by: Antón Casas <antoncasas@eprosima.com> |
||
|---|---|---|
| .github | ||
| ci | ||
| cmake | ||
| docs | ||
| examples | ||
| include/uxr/client | ||
| src/c | ||
| test | ||
| toolchains | ||
| utils | ||
| .dockerignore | ||
| .gitignore | ||
| CMakeLists.txt | ||
| CONTRIBUTING.md | ||
| CTestConfig.cmake | ||
| Dockerfile | ||
| LICENSE | ||
| PLATFORM_SUPPORT.md | ||
| QUALITY.md | ||
| README.md | ||
| VERSIONING.md | ||
| colcon.pkg | ||
| doxyfile.in | ||
| uncrustify.cfg | ||
README.md
Micro XRCE-DDS Client
eProsima Micro XRCE-DDS is a library implementing the DDS-XRCE protocol as defined and maintained by the OMG, whose aim is to allow resource constrained devices such as microcontrollers to communicate with the DDS world as any other DDS actor would do. It follows a client/server paradigm and is composed by two libraries, the Micro XRCE-DDS Client and the Micro XRCE-DDS Agent. The Micro XRCE-DDS Clients are lightweight entities meant to be compiled on eXtremely Resource Constrained Environments, while the Micro XRCE-DDS Agent is a broker which bridges the Clients with the DDS world.
The Micro XRCE-DDS Clients request operations to the Agent to publish and/or subscribe to topics in the DDS global dataspace. Remote procedure calls, as defined by the DDS-RPC standard, are also supported, allowing Clients to communicate in the DDS dataspace according to a request/reply paradigm.
The Agents process these requests and send back a response with the operation status result and with the requested data, in the case of subscribe/reply operations.
The communication in the DDS world is mediated by a dedicated ProxyClient in charge of creating the DDS Entities requested by the Clients, such as Participants, Topics, Publishers, and Subscribers, which can interact with the DDS Global dataspace.
eProsima Micro XRCE-DDS provides the user with a C API to create Micro XRCE-DDS Clients applications. The library can be configured at compile-time via a set of CMake flags allowing to enable or disable some profiles before compilation, and to manipulate several parameters controlling some of the library's functionalities, which in turn allow tuning the library size.
The communication between a Micro XRCE-DDS Client and a Micro XRCE-DDS Agent is achieved by means of several kinds of built-in transports: UDPv4, UDPv6, TCPv4, TCPv6 and Serial communication. In addition, there is the possibility for the user to generate its own Custom transport.
Commercial support
Looking for commercial support? Write us to info@eprosima.com
Find more about us at eProsima’s webpage.
Documentation
You can access the eProsima Micro XRCE-DDS user documentation online, which is hosted on Read the Docs.
Quality Declaration
eProsima Micro XRCE-DDS Client claims to be in the Quality Level 1 category based on the guidelines provided by ROS 2. See the Quality Declaration for more details.