Skip to content

Commit

Permalink
Add Quick Solution Overview and fix some errors
Browse files Browse the repository at this point in the history
Signed-off-by: Lucia Echevarria <luciaechevarria@eprosima.com>
  • Loading branch information
LuciaEchevarria99 committed Nov 4, 2024
1 parent e933f79 commit e1bbb85
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 3 deletions.
2 changes: 2 additions & 0 deletions docs/rst/spelling_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,8 @@ vulcanexus
Vulcanexus
wbt
webpage
Wi-fi
Wifi
Wireshark
ws
XRCE
20 changes: 17 additions & 3 deletions docs/rst/tutorials/core/deployment/large_data/large_data.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. include:: ../../../exports/alias.include
.. include:: ../../../../exports/alias.include

.. _tutorials_large_data_video_streaming:

Expand All @@ -10,6 +10,20 @@ How to handle large data video streaming in ROS 2
:local:
:backlinks: none

Have you faced problems streaming video in ROS2?
------------------------------------------------

If you've experienced issues streaming video in ROS2, such as video freezing, packet loss, or jitter, especially over WiFi, you can enable Fast DDS’s **Large Data Mode** with a simple environment variable configuration.
This allows you to bypass some of the limitations of UDP transport by using TCP or Shared Memory (SHM) for large data transmission, enhancing the reliability and quality of your video stream.

**Quick Solution Overview**

To apply this solution, set the ``FASTDDS_BUILTIN_TRANSPORTS`` environment variable to ``LARGE_DATA`` in every ROS2 node involved in transmitting large data messages:

.. code:: bash
export FASTDDS_BUILTIN_TRANSPORTS=LARGE_DATA
Overview
--------

Expand Down Expand Up @@ -157,7 +171,7 @@ This is done by exporting the environment variable in the terminal on both compu

.. code:: bash
export FASTDDS_BUILTIN_TRANSPORTS=LARGE_DATA&non_blocking=true
export FASTDDS_BUILTIN_TRANSPORTS="LARGE_DATA?non_blocking=true"
With this setting, run the same publisher and subscriber commands again.
This time, you should experience smooth and uninterrupted video streaming with no freezing or image loss.
This time, you should experience smooth and uninterrupted video streaming with no freezing or image loss.

0 comments on commit e1bbb85

Please sign in to comment.