Skip to content

Commit

Permalink
Add Fast DDS Spy description
Browse files Browse the repository at this point in the history
Signed-off-by: Raul Sanchez-Mateos <[email protected]>
  • Loading branch information
rsanchez15 committed Jul 25, 2023
1 parent 074db52 commit 564ae1b
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 28 additions & 0 deletions docs/rst/introduction/tools/fastddsspy.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
.. _vulcanexus_fastddsspy:

Fast DDS Spy
============

*Fast DDS Spy* is CLI interactive tool that allows to introspect a ROS 2 network in human readable format.
It is possible to query the network about the Participants connected, their endpoints (Publishers and Subscriptions) and the topics they communicate in.
It is also possible to see the user data sent through network topics in a schematic format in run time.

Overview
--------

*Fast DDS Spy* is a tool that introspect or "sniffing" DDS packages in the network and maintain a local database that is accessible from a interactive CLI.
*Fast DDS Spy* responds to user commands introduced by text and print in ``stdin`` the information requested.
This tool has several commands to interact with, that allows to get information regarding the status of the network.
It supports to list topics existing, list Participants, Publishers, Subscriptions and even read user data in real time in a human readable format.

.. figure:: /rst/figures/intro/fastddsspy/fastddsspy.png
:align: center

*Fast DDS Spy* is easily configurable and installed with a default setup, so that DDS topics, data types and entities are automatically discovered without the need to specify the types of data.
This is because this tool exploits the DynamicTypes functionality of `eProsima Fast DDS <https://fast-dds.docs.eprosima.com>`_, the C++ implementation of the `DDS (Data Distribution Service) Specification <https://www.omg.org/spec/DDS/About-DDS/>`_ defined by the `Object Management Group (OMG) <https://www.omg.org/>`_.

Next Steps
----------

Visit `eProsima Fast DDS Spy Documentation <https://fast-dds-spy.readthedocs.io/en/latest>`_ for more information on how to configure and use *Fast DDS Spy*.
Also feel free to review :ref:`Vulcanexus Tools Tutorials <tutorials_tools_tools_tutorials>` to discover the possibilities that this tool has to offer in different scenarios.

0 comments on commit 564ae1b

Please sign in to comment.