From 110d28292aea66c18aafb4fb661cb68657b1ff23 Mon Sep 17 00:00:00 2001 From: tempate Date: Mon, 9 Oct 2023 09:55:52 +0200 Subject: [PATCH] Manual topics documentation Signed-off-by: tempate --- docs/rst/notes/forthcoming_version.rst | 1 + docs/rst/user_manual/configuration.rst | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+) diff --git a/docs/rst/notes/forthcoming_version.rst b/docs/rst/notes/forthcoming_version.rst index 5b0fdd73f..f3ae4c7cd 100644 --- a/docs/rst/notes/forthcoming_version.rst +++ b/docs/rst/notes/forthcoming_version.rst @@ -9,6 +9,7 @@ Forthcoming Version The next release will include the following **Features**: * :ref:`Forwarding Routes `. +* :ref:`Manual Topics `. * :ref:`Max Transmission Rate `. * :ref:`Max Reception Rate `. * :ref:`Downsampling `. diff --git a/docs/rst/user_manual/configuration.rst b/docs/rst/user_manual/configuration.rst index f2a0a5c51..c83fba418 100644 --- a/docs/rst/user_manual/configuration.rst +++ b/docs/rst/user_manual/configuration.rst @@ -300,6 +300,25 @@ See the :term:`Topic` section for further information about the topic. keyed: false # Topic without keys +.. _user_manual_configuration_manual_topics: + +Manual Topics +============= + +At times it can be useful to manually predefine a subset of Topic QoS for a set of Participants. + +.. code-block:: yaml + + topics: + - name: temperature/* + type: temp* + qos: + max-tx-rate: 15 + downsampling: 2 + participants: + - Participant0 + - Participant1 + Topic Filtering ===============