diff --git a/docs/rst/user_manual/commands/commands.rst b/docs/rst/user_manual/commands/commands.rst index 5532131b..19471dd4 100644 --- a/docs/rst/user_manual/commands/commands.rst +++ b/docs/rst/user_manual/commands/commands.rst @@ -100,11 +100,12 @@ Summary - Show Topic info - ``_`` |br| ``verbose`` |br| + ``vv`` |br| ```` - ``topic`` ``topics`` |br| ``t`` ``T`` - * - :ref:`user_manual_command_show` + * - :ref:`user_manual_command_echo` - Show real-time receiving user data. - ```` |br| `` verbose`` |br| diff --git a/docs/rst/user_manual/commands/data.rst b/docs/rst/user_manual/commands/data.rst index 6b62323e..c4905540 100644 --- a/docs/rst/user_manual/commands/data.rst +++ b/docs/rst/user_manual/commands/data.rst @@ -1,10 +1,10 @@ .. include:: ../../exports/alias.include .. include:: ../../exports/roles.include -.. _user_manual_command_show: +.. _user_manual_command_echo: #### -Show +Echo #### This command prints every User Data received in a human readable way. @@ -19,7 +19,7 @@ Key-words ========= These are the key-words recognize as this command: -``show`` ``print`` ``s`` ``S``. +``echo`` ``show`` ``print`` ``s`` ``S``. Data Type discovered ==================== @@ -30,18 +30,17 @@ The information whether the topic data type is already discovered be the applica Arguments ========= -**Show** command support different combination of arguments: +**Echo** command support different combination of arguments: Topic name ---------- When a topic name is given, the information shown is the data received in real-time in the topic specified. -The output format is as follows: :ref:`user_manual_command_show_output_simple`. +The output format is as follows: :ref:`user_manual_command_echo_output_simple`. -Topic name prefix + * ---------------------- -When a topic name is provided followed by an asterisk (*), the command will display real-time information for all topics whose names begin with the given value. -The asterisk acts as a wildcard, allowing the display of data received from multiple topics that share the same prefix. +Topic name with wildcards +------------------------- +When a topic name is provided with wildcards (*), the command will display real-time information for all topics whose names match the given filter. For example, if you enter ``sensor_*``, the command will print data from all topics starting with ``sensor_``, such as ``sensor_temperature``, ``sensor_humidity``, etc. @@ -49,18 +48,18 @@ Topic name + Verbose -------------------- Giving a topic name and the the :ref:`verbose argument ` the output is the data received in real-time with additional meta-information as the topic name, the source timestamp, and the source :term:`DataWriter` :term:`Guid`. -Data is printing using :ref:`user_manual_command_show_output_verbose`. +Data is printing using :ref:`user_manual_command_echo_output_verbose`. Topic name prefix + * + Verbose ------------------------------- -When a topic name is provided with a prefix followed by an asterisk (*) and the :ref:`verbose argument `, the command displays detailed real-time information and meta-information for all topics that share the specified prefix. +When a topic name is provided with wildcards (*) and the :ref:`verbose argument `, the command displays detailed real-time information and meta-information for all topics that match the given filter. All --- This argument prints all topics which Data Type has been discovered. -Data is printing using :ref:`user_manual_command_show_output_verbose`. +Data is printing using :ref:`user_manual_command_echo_output_verbose`. Output Format ============= @@ -72,7 +71,7 @@ Output Format The data information is retrieved in 2 formats depending on the verbose option. -.. _user_manual_command_show_output_simple: +.. _user_manual_command_echo_output_simple: Simple Data format ------------------ @@ -86,7 +85,7 @@ Only shows the data, by ... --- -.. _user_manual_command_show_output_verbose: +.. _user_manual_command_echo_output_verbose: Verbose Data format ------------------- diff --git a/docs/rst/user_manual/commands/topic.rst b/docs/rst/user_manual/commands/topic.rst index 63f4aae3..3e886fda 100644 --- a/docs/rst/user_manual/commands/topic.rst +++ b/docs/rst/user_manual/commands/topic.rst @@ -18,7 +18,7 @@ These are the key-words recognize as this command: Arguments ========= -**Topic** command support 0 or 1 argument: +**Topic** command support from 0 to 2 arguments: *No argument* ------------- @@ -27,9 +27,6 @@ When no arguments are given to this command, the information shown is a **list** The information shown is the topic name, data type name, number of writers and readers and the subscription rate measured in samples per second. The output format is as follows: :ref:`user_manual_command_topic_output_simple`. -Compact -------- - When the compact argument is used with the Topic command, the information is displayed in a more concise format, with each topic's details condensed into a single line. This allows for easier reading and quick scanning, especially when there are many active topics in the network. @@ -62,12 +59,19 @@ This allows users to query multiple topics in a single command, making it easier Output Format ============= -The topic information is retrieved in 2 formats depending on the verbose option. +The topic information is retrieved in multiple formats depending on the verbosity option. .. _user_manual_command_topic_output_simple: -Simple Writer info ------------------------ +Topics info +----------- + +- topic: () (|) [ Hz] + +.. _user_manual_command_topic_output_verbose: + +Topics info in verbose mode +--------------------------- .. code-block:: yaml @@ -77,10 +81,8 @@ Simple Writer info datareaders: rate: Hz -.. _user_manual_command_topic_output_verbose: - -Verbose Writer info ------------------------- +Topics info in high verbosity mode +---------------------------------- .. code-block:: yaml diff --git a/docs/rst/user_manual/tool.rst b/docs/rst/user_manual/tool.rst index cc767c2b..22313115 100644 --- a/docs/rst/user_manual/tool.rst +++ b/docs/rst/user_manual/tool.rst @@ -247,7 +247,7 @@ Using the :ref:`user_manual_user_interface_interactive_app`, this will be the pr .. code-block:: console - $ fastddsspy + $ fastddsspy ____| | __ \ __ \ ___| ___| | _` | __| __| | | | | \___ \ \___ \ __ \ | | @@ -263,13 +263,13 @@ Using the :ref:`user_manual_user_interface_interactive_app`, this will be the pr Insert a command for Fast DDS Spy: >> quit - $ + $ However, using :ref:`user_manual_user_interface_one_shot` this will be expected result: .. code-block:: console - $ fastddsspy participants + $ fastddsspy participants - name: Fast DDS ShapesDemo Participant guid: 01.0f.44.59.21.58.14.d2.00.00.00.00|0.0.1.c1 - $ + $ diff --git a/docs/rst/user_manual/usage_example.rst b/docs/rst/user_manual/usage_example.rst index e6844d9f..f187feb5 100644 --- a/docs/rst/user_manual/usage_example.rst +++ b/docs/rst/user_manual/usage_example.rst @@ -85,29 +85,25 @@ Try out all the commands DDS Spy has to offer: .. code-block:: output - - name: Circle - type: ShapeType - datawriters: 2 - datareaders: 2 - rate: 13.0298 Hz - - name: Square - type: ShapeType - datawriters: 3 - datareaders: 2 - rate: 26.6975 Hz + - topic: Circle (ShapeType) (1|2) [9.000000Hz] + - topic: Square (ShapeType) (1|0) [12.412500Hz] + - topic: Triangle (ShapeType) (0|1) [0.000000Hz] + - ... -* ``topics Square`` +* ``topics Circle vv`` .. code-block:: output - name: Circle - type: ShapeType - datawriters: - - 01.0f.44.59.da.57.de.ec.00.00.00.00|0.0.6.2 - datareaders: - - 01.0f.44.59.c9.65.78.e5.00.00.00.00|0.0.2.7 - rate: 13.0418 Hz - dynamic_type_discovered: true + - name: Circle + type: ShapeType + datawriters: + - 01.0f.93.86.fb.9a.7f.92.00.00.02.00|0.0.3.2 + datareaders: + - 01.0f.93.86.fb.9a.7f.92.00.00.02.00|0.0.1.7 + - 01.0f.93.86.fb.9a.7f.92.00.00.02.00|0.0.2.7 + rate: 11.2986 Hz + dynamic_type_discovered: false + * ``help`` @@ -130,16 +126,15 @@ Try out all the commands DDS Spy has to offer: reader : DataReaders discovered in the network. reader verbose : verbose information about DataReaders discovered in the network. reader : verbose information related with a specific DataReader. - topics : Topics discovered in the network. - topics compact : Topics discovered in the network in compact format. - topics verbose : verbose information about Topics discovered in the network. - topics : verbose information related with a specific Topic. - topics + * : verbose information related with Topics with prefix . - show : data of a specific Topic (Data Type must be discovered). - show + * : data of a Topics with prefix (Data Type must be discovered). - show verbose : data with additional source info of a specific Topic. - show + * verbose : data with additional source info of Topics with prefix . - show all : verbose data of all topics (only those whose Data Type is discovered). + topics : Topics discovered in the network in compact format. + topics v : Topics discovered in the network. + topics vv : verbose information about Topics discovered in the network. + topics : Topics discovered in the network filtered by name (wildcard allowed (*)). + print : data of a specific Topic (Data Type must be discovered). + print : data of a Topics matching the wildcard name (Data Type must be discovered). + print verbose : data with additional source info of a specific Topic. + print verbose : data with additional source info of Topics with prefix . + print all : verbose data of all topics (only those whose Data Type is discovered). Notes and comments: To exit from data printing, press enter.