Skip to content

Commit 696f1a3

Browse files
authored
doc: Added explanation of preceding/following controllers (backport #2192) (#2193)
1 parent 3cffec4 commit 696f1a3

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

controller_manager/doc/controller_chaining.rst

+8
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,14 @@ This means the following:
4040
3. After that, "position_tracking" can be activated and attached to "diff_drive_controller" that disables its external interfaces.
4141
4. If any of the controllers is deactivated, also all preceding controllers are deactivated.
4242

43+
.. note::
44+
45+
Controllers that expose the reference interfaces are switched to chained mode only when their reference interfaces are used by other controllers. When their reference interfaces are not used by other controllers, they are switched back to get references from the subscriber.
46+
However, the controllers that expose the state interfaces are not triggered to chained mode when their state interfaces are used by other controllers.
47+
48+
.. note::
49+
50+
This document uses terms *preceding* and *following* controller. These terms refer to such ordering of controllers that controller A *precedes* controller B if A claims (*connects its output to*) B's reference interfaces (*inputs*). In the example diagram at the beginning of this section, 'diff_drive_controller' *precedes* 'pid left wheel' and 'pid right wheel'. Consequently, 'pid left wheel' and 'pid right wheel' are controllers *following* after 'diff_drive_controller'.
4351

4452
Implementation
4553
--------------

0 commit comments

Comments
 (0)