Skip to content

Commit

Permalink
Refs #22627: ROS2_EASY_MODE
Browse files Browse the repository at this point in the history
Signed-off-by: cferreiragonz <[email protected]>
  • Loading branch information
cferreiragonz committed Jan 22, 2025
1 parent ac9671f commit a72b80e
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/fastdds/discovery/discovery_server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ ease Discovery Server setup and testing.
.. note::

:ref:`DDS Domain <dds_layer_domain>` concept does not apply when enabling the default Discovery Server mechanism,
but it applies when using :ref:`EASY_MODE<env_vars_easy_mode>`.
but it applies when using :ref:`ROS2_EASY_MODE<env_vars_easy_mode>`.

.. contents::
:local:
Expand Down
12 changes: 6 additions & 6 deletions docs/fastdds/env_vars/env_vars.rst
Original file line number Diff line number Diff line change
Expand Up @@ -254,14 +254,14 @@ The following example shows how to set the address of two remote discovery serve

.. _env_vars_easy_mode:

``EASY_MODE``
-------------
``ROS2_EASY_MODE``
------------------

Setting ``EASY_MODE`` to an IP value allows a participant to automatically enter the
Setting ``ROS2_EASY_MODE`` to an IP value allows a participant to automatically enter the
`Discovery Server Easy Mode <https://docs.vulcanexus.org/en/latest/rst/enhancements/easy_mode/easy_mode.html>`__.
This mode completely disables **multicast communication**, and relies on Discovery Servers for discovery purposes.

With ``EASY_MODE`` a new Discovery Server will be automatically spawned locally in the given
With ``ROS2_EASY_MODE`` a new Discovery Server will be automatically spawned locally in the given
:ref:`domain<dds_layer_domain>`, pointing to another Discovery Server located in the specified IP.
If the specified IP belongs to the same host, it will only work in localhost, until another host connects to it.
If there exists a Discovery Server for that domain, the spawn process will be skipped, relying on the existing server
Expand All @@ -278,7 +278,7 @@ which will try to connect to another Discovery Server located in the host ``10.0

.. code-block:: bash
export EASY_MODE=10.0.0.1
export ROS2_EASY_MODE=10.0.0.1
The port of the Discovery Server is calculated using the rules explained in the :ref:`listening_locators_defaultPorts`.
The transports configured in this new mode include :ref:`UDP<transport_udp_udp>` unicast for discovery and
Expand All @@ -288,7 +288,7 @@ A detailed tutorial can be found in the
`Discovery Server Easy Mode <https://docs.vulcanexus.org/en/latest/rst/enhancements/easy_mode/easy_mode.html>`__ documentation.

.. warning::
Discovery Server ``EASY_MODE`` is not yet available for Windows platforms.
Discovery Server ``ROS2_EASY_MODE`` is not yet available for Windows platforms.

.. _env_vars_ros_super_client:

Expand Down
12 changes: 6 additions & 6 deletions docs/fastddscli/cli/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ It encompasses two main functionalities:
only parameter that the user must specify.
If no Domain ID is provided, the default value is 0.

It is intended to be used along with the ``EASY_MODE`` environment variable, which will manage clients connections
automatically.
It is intended to be used along with the ``ROS2_EASY_MODE`` environment variable, which will manage clients
connections automatically.
This CLI feature allows the user to dynamically manage servers from the network: launching, stopping, restarting
and even modifying their remote servers connections.
For further information about this mode refer to `Discovery Server Easy Mode <https://docs.vulcanexus.org/en/latest/rst/enhancements/easy_mode/easy_mode.html>`__.
Expand All @@ -78,9 +78,9 @@ Discovery Server CLI Easy Mode

This mode aims to simplify the deployment and configuration of *Fast DDS* Discovery Servers by automatically handling
the server's connections.
This mode of the CLI is meant to be used along with the ``EASY_MODE`` environment variable, which can be used to
This mode of the CLI is meant to be used along with the ``ROS2_EASY_MODE`` environment variable, which can be used to
remove to **multicast announcements** from DDS entities and interconnect different hosts by just using the environment
variable ``EASY_MODE=<ip>``.
variable ``ROS2_EASY_MODE=<ip>``.
(Check `Discovery Server Easy Mode <https://docs.vulcanexus.org/en/latest/rst/enhancements/easy_mode/easy_mode.html>`__
to see a detailed explanation of this feature).

Expand All @@ -89,7 +89,7 @@ It can be used to manage running servers, modifying their remote connections, re
*Fast DDS* Discovery servers are handled and monitored from a background daemon which is automatically spawned when
required.

Configuration of servers launched with ``EASY_MODE`` is available by using the following command:
Configuration of servers launched with ``ROS2_EASY_MODE`` is available by using the following command:

.. code-block:: bash
Expand Down Expand Up @@ -122,7 +122,7 @@ The following table lists the available commands for the *Fast DDS* Discovery Se
This will replace |br| existing remote servers with the new connections. |br|
Example to replace remote servers with a new one: set -d 5 "10.0.0.3:42".
* - list
- List local active Discovery Servers created with the CLI Tool or the ``EASY_MODE=<ip>``.
- List local active Discovery Servers created with the CLI Tool or the ``ROS2_EASY_MODE=<ip>``.

.. list-table::
:header-rows: 1
Expand Down

0 comments on commit a72b80e

Please sign in to comment.