Skip to content

Commit e1abe57

Browse files
committed
[occ] Add state machine documentation
1 parent f5fe307 commit e1abe57

2 files changed

Lines changed: 7 additions & 0 deletions

File tree

18.5 KB
Loading

occ/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ $ OCC_CONTROL_PORT=<some port> occlib/examples/dummy-process/occexample-dummy-pr
2727

2828
The dummy process now waits for control commands.
2929

30+
## The OCC state machine
31+
32+
The figure below describes the OCC state machine, as implemented in the OCC library and exposed
33+
by the OCC API for non-FairMQ devices (`controlmode.DIRECT`).
34+
35+
![The OCC state machine](OCCStateMachine-controlmode.DIRECT.png)
36+
3037
## Single process control with `peanut`
3138

3239
`peanut` is the Process Execution And coNtrol UTility for OCClib-based O² processes. Its purpose

0 commit comments

Comments
 (0)