Skip to content

Commit 54b4e64

Browse files
Update CLI commands for Easy Mode (#1052)
* Refs #23008: Update docs Signed-off-by: cferreiragonz <carlosferreira@eprosima.com> * Refs #23008: Fix enum Signed-off-by: cferreiragonz <carlosferreira@eprosima.com> * Refs #23008: Review Signed-off-by: cferreiragonz <carlosferreira@eprosima.com> --------- Signed-off-by: cferreiragonz <carlosferreira@eprosima.com>
1 parent b0177c3 commit 54b4e64

1 file changed

Lines changed: 20 additions & 33 deletions

File tree

docs/fastddscli/cli/cli.rst

Lines changed: 20 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -98,24 +98,19 @@ The following table lists the available commands for the *Fast DDS* Discovery Se
9898

9999
* - Command
100100
- Description
101-
* - auto
102-
- Handle the daemon start-up automatically and creates a Discovery Server in the specified
103-
|br| domain (0 by default).
104101
* - start
105102
- Start the Discovery Server daemon with the remote connections specified. |br|
106-
(Example: start -d 1 "127.0.0.1:2;10.0.0.3:42").
103+
(Example: start -d 1 10.0.0.1:1).
107104
* - stop
108105
- Stop the Discovery Server daemon if it is executed with no arguments.
109-
If a domain is |br| specified with the ``-d`` argument it will only stop the corresponding server and the
110-
daemon |br| will remain alive.
106+
If a domain is |br| specified with the ``-d`` argument it will only stop the corresponding server and |br|
107+
the daemon will remain alive.
111108
* - add
112109
- Add new remote Discovery Servers to the local server.
113-
This will connect both servers and |br| their sub-networks without modifying existing remote servers. |br|
114-
Example to add two new remote servers: add -d 7 "127.0.0.1:2;10.0.0.3:42".
110+
This will connect both servers |br| and their sub-networks without modifying existing remote servers.
115111
* - set
116112
- Rewrite the remote Discovery Servers connected to the local server.
117-
This will replace |br| existing remote servers with the new connections. |br|
118-
Example to replace remote servers with a new one: set -d 5 "10.0.0.3:42".
113+
This will replace |br| existing remote servers with the new connections.
119114
* - list
120115
- List local active Discovery Servers created with the CLI Tool or the ``ROS2_EASY_MODE=<ip>``.
121116

@@ -127,22 +122,26 @@ The following table lists the available commands for the *Fast DDS* Discovery Se
127122
- Description
128123
* - ``-d --domain``
129124
- Selects the domain of the server to target for this action.
130-
It defaults to 0 if |br| this argument is missing and no value is found in the ``ROS_DOMAIN_ID``
131-
environment variable.
132-
* - ``<remote_server_list>``
133-
- It is only accepted with the `start`, `add` and `set` commands.
134-
It is a list of |br| remote servers to connect to that follows this structure: "<IP:domain>;<IP:domain>;...".
125+
It is mandatory for |br| commands ``start``, ``add`` and ``set``.
126+
* - ``<remote_server>``
127+
- It is an IP-domain pair defining a remote server to connect to: |br|
128+
``<IP:domain>``.
129+
It is mandatory with the `start`, `add` and `set` commands. |br|
130+
Only valid IPv4 addresses are accepted.
131+
132+
.. note::
133+
The command ``add`` also accepts a remote server list using the structure ``"<IP:domain>;<IP:domain>;..."``.
135134

136135
.. _easy_mode_discovery_examples:
137136

138137
Examples
139138
""""""""
140139

141-
1. Start a DS in the default domain 0:
140+
1. Start a DS in the default domain 0 pointing to itself (no remote server):
142141

143142
.. code-block:: bash
144143
145-
fastdds discovery auto
144+
fastdds discovery start -d 0 127.0.0.1:0
146145
147146
2. Stop all running DS and shut down Fast DDS daemon:
148147

@@ -156,37 +155,25 @@ Examples
156155
157156
fastdds discovery stop -d 0
158157
159-
4. Start a DS in the domain 42:
160-
161-
.. code-block:: bash
162-
163-
fastdds discovery auto -d 42
164-
165-
OR
166-
167-
.. code-block:: bash
168-
169-
ROS_DOMAIN_ID=42 fastdds discovery auto
170-
171-
5. Start a DS in domain 4 pointing to remote DS in domain 4:
158+
4. Start a DS in domain 4 pointing to remote DS in domain 4 and IP 10.0.0.7:
172159

173160
.. code-block:: bash
174161
175162
fastdds discovery start -d 4 10.0.0.7:4
176163
177-
6. Add a new remote server to DS running in domain 4 :
164+
5. Add a new remote server to DS running in domain 4 :
178165

179166
.. code-block:: bash
180167
181168
fastdds discovery add -d 4 10.0.0.7:4
182169
183-
7. List all servers running locally:
170+
6. List all servers running locally:
184171

185172
.. code-block:: bash
186173
187174
fastdds discovery list
188175
189-
8. Starts a DS in domain 3 pointing to local DS in domain 6:
176+
7. Starts a DS in domain 3 pointing to local DS in domain 6:
190177

191178
.. code-block:: bash
192179

0 commit comments

Comments
 (0)