diff --git a/docs/fastdds/discovery/discovery_server.rst b/docs/fastdds/discovery/discovery_server.rst index 70f42030f..0c487ca4d 100644 --- a/docs/fastdds/discovery/discovery_server.rst +++ b/docs/fastdds/discovery/discovery_server.rst @@ -17,7 +17,7 @@ ease Discovery Server setup and testing. .. note:: :ref:`DDS Domain ` concept does not apply when enabling the default Discovery Server mechanism, - but it applies when using :ref:`EASY_MODE`. + but it applies when using :ref:`ROS2_EASY_MODE`. .. contents:: :local: diff --git a/docs/fastdds/env_vars/env_vars.rst b/docs/fastdds/env_vars/env_vars.rst index 758568f0b..b462f2587 100644 --- a/docs/fastdds/env_vars/env_vars.rst +++ b/docs/fastdds/env_vars/env_vars.rst @@ -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 `__. 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`, 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 @@ -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` unicast for discovery and @@ -288,7 +288,7 @@ A detailed tutorial can be found in the `Discovery Server Easy Mode `__ 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: diff --git a/docs/fastddscli/cli/cli.rst b/docs/fastddscli/cli/cli.rst index ebed830c4..6f4c93654 100644 --- a/docs/fastddscli/cli/cli.rst +++ b/docs/fastddscli/cli/cli.rst @@ -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 `__. @@ -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=``. +variable ``ROS2_EASY_MODE=``. (Check `Discovery Server Easy Mode `__ to see a detailed explanation of this feature). @@ -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 @@ -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=``. + - List local active Discovery Servers created with the CLI Tool or the ``ROS2_EASY_MODE=``. .. list-table:: :header-rows: 1