Skip to content

Commit

Permalink
update the docs of the chainable controllers output
Browse files Browse the repository at this point in the history
  • Loading branch information
saikishor committed Dec 4, 2023
1 parent 0ea3d41 commit 7aec698
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion controller_manager/doc/controller_chaining.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,9 @@ One can also think of it as an actual chain, you can not add a chain link or bre
Debugging outputs
----------------------------

Flag ``unavailable`` on reference interface does not provide much information about anything at the moment. So don't get confused by it. The reason we have it are internal implementation reasons irelevant for the usage.
- The reference interfaces are ``unavailable`` and ``unclaimed``, when the controller exporting them is in inactive state
- The reference interfaces are ``available`` and ``unclaimed``, when the controller exporting them is in an active state but is not in chained mode with any other controller (The controllers get their references from the subscribers)
- The reference interfaces are ``available`` and ``claimed``, when the controller exporting them is in active state and also in chained mode with other controllers (The controller gets its references from the controllers it is chained with)


Closing remarks
Expand Down

0 comments on commit 7aec698

Please sign in to comment.