Separate unload filament automaton desc into unload_filament.dox

and change Doxyfile accordingly
pull/145/head
D.R.racer 2021-12-02 11:17:52 +01:00 committed by 3d-gussner
parent 758503ffa8
commit c60b00fc5d
3 changed files with 37 additions and 1 deletions

View File

@ -2483,7 +2483,7 @@ DOT_PATH =
# command).
# This tag requires that the tag HAVE_DOT is set to YES.
DOTFILE_DIRS =
DOTFILE_DIRS = src/logic
# The MSCFILE_DIRS tag can be used to specify one or more directories that
# contain msc files that are included in the documentation (see the \mscfile

View File

@ -0,0 +1,33 @@
digraph architecture {
graph [fontname=Helvetica, fontsize=10];
node [shape=record, fontname=Helvetica, fontsize=10];
edge [fontname=Helvetica, fontsize=10];
compound=true;
subgraph cluster_unload_filament { label="unload_filament"
reset;
UnloadFilament [ URL="\ref logic::UnloadFilament"];
finda_FilLoadState [ shape=diamond, label="FINDA && FilLoadState"];
return [shape="oval"];
UnloadingToFinda [ URL="\ref logic::UnloadingToFinda", shape=diamond];
ErrorFSnotOFF [shape=oval];
ErrorFINDAnotOFF [shape=oval];
RetractingFromFinda [shape=diamond];
DisengagingIdler [shape=diamond];
ERRDisengagingIdler [shape=hexagon];
Finished [shape=oval];
{rank = same; finda_FilLoadState; return;}
{rank = same; ErrorFSnotOFF; UnloadingToFinda; ErrorFINDAnotOFF;}
{rank = same; DisengagingIdler; ERRDisengagingIdler;}
}
reset -> finda_FilLoadState
finda_FilLoadState -> return [label="NO && < 2"];
finda_FilLoadState -> UnloadFilament [label="YES && >=2"];
UnloadFilament -> UnloadingToFinda;
UnloadingToFinda -> ErrorFSnotOFF [label="err"];
UnloadingToFinda -> ErrorFINDAnotOFF [label="err"];
UnloadingToFinda -> RetractingFromFinda;
RetractingFromFinda -> ErrorFINDAnotOFF [label="err"];
RetractingFromFinda -> DisengagingIdler;
DisengagingIdler -> ERRDisengagingIdler [label="err"];
DisengagingIdler -> Finished;
}

View File

@ -8,6 +8,9 @@
namespace logic {
/// @brief A high-level command state machine - handles the complex logic of unloading filament
///
/// State machine overview:
/// @dotfile unload_filament.dot
class UnloadFilament : public CommandBase {
public:
inline UnloadFilament()