summaryrefslogtreecommitdiff
path: root/daemons/shaper/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'daemons/shaper/README.rst')
-rw-r--r--daemons/shaper/README.rst14
1 files changed, 13 insertions, 1 deletions
diff --git a/daemons/shaper/README.rst b/daemons/shaper/README.rst
index 71aebc42..6847c1d6 100644
--- a/daemons/shaper/README.rst
+++ b/daemons/shaper/README.rst
@@ -4,7 +4,8 @@ OpenAvnu Traffic Shaping Daemon
.. contents::
..
1 Introduction
- 2 Future Updates
+ 2 Support
+ 3 Future Updates
Introduction
------------
@@ -14,6 +15,17 @@ configure the kernel traffic shaping with the Hierarchy Token Bucket. While
tc could be called directly, using the daemon allows for a simpler interface
and keeps track of the current traffic shaping configurations in use.
+Support
+-------
+
+To enable the Shaper daemon support for AVTP Pipeline, edit the endpoint.ini
+file and uncomment the port=15365 line of the shaper section.
+
+The Shaper daemon does not work (i.e. no shaping occurs) if the Intel IGB
+support is loaded for the adapter being used. You may also need to compile
+the AVTP Pipeline with PLATFORM_TOOLCHAIN=generic to not include the IGB
+features.
+
Future Updates
--------------