First approach documenting state machines

pull/145/head
3d-gussner 2021-11-30 08:19:13 +01:00
parent fd6c0bcc23
commit 758503ffa8
1 changed files with 36 additions and 0 deletions

View File

@ -1,4 +1,40 @@
/// @file unload_filament.cpp
///@dot
///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;
///}
///@enddot
#include "unload_filament.h"
#include "../modules/finda.h"
#include "../modules/fsensor.h"