nasa/fprime
1
0
Fork 0
mirror of https://github.com/nasa/fprime.git synced 2025-12-10 00:44:37 -06:00
Code Issues Packages Projects Releases 34 Wiki Activity

Enhance Fpy docs with state machine diagram (#4315)

Browse Source 
* Enhance documentation with state machine diagram

* sp
This commit is contained in:
M Starch 2025-10-16 15:34:37 -07:00 committed by GitHub
parent 4afac326ba
commit a8328b95cf
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 93 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

94
Svc/FpySequencer/docs/sdd.md
View File

@ -8,6 +8,98 @@ The FpySequencer is primarily composed of a state machine and a runtime environm
The FpySequencer runs files compiled by `fprime-fpyc` (in the `fprime-gds` package). See the compiler documentation for the details of the Fpy language.
## Requirements
TBD
## States
The following diagram represents the states of the `FpySequencer`.
```mermaid
stateDiagram-v2
direction LR
state "IDLE
entry / clearBreakpoint, clearSequenceFile
------------------------------------------------------
cmd_SET_BREAKPOINT / setBreakpoint
cmd_CLEAR_BREAKPOINT / clearBreakpoint
" as IDLE
state "VALIDATING
enter / report_seqStarted, validate
------------------------------------------------------
cmd_SET_BREAKPOINT / setBreakpoint
cmd_CLEAR_BREAKPOINT / clearBreakpoint
" as VALIDATING
state VALID <<choice>>
state "AWAITING_CMD_RUN_VALIDATED
enter / resp_OK
------------------------------------------------------
cmd_SET_BREAKPOINT / setBreakpoint
cmd_CLEAR_BREAKPOINT / clearBreakpoint
" as AWAITING_CMD_RUN_VALIDATED
state "RUNNING entry / resetRuntime
" as RUNNING {
state BREAK_CHECK <<choice>>
state "DISPATCH_STATEMENT
enter / dispatch
" as DISPATCH_STATEMENT
state "PAUSED
entry / clearBreakBeforeNextLine, if breakOnce: clearBreakpoint
-------------------------------------------------------------
" as PAUSED
[*] --> BREAK_CHECK
BREAK_CHECK --> PAUSED: if break
BREAK_CHECK --> DISPATCH_STATEMENT: if not break
PAUSED --> DISPATCH_STATEMENT: cmd_CONTINUE
PAUSED --> DISPATCH_STATEMENT: cmdSTEP/setBreakBeforeNextLine
DISPATCH_STATEMENT --> [*]: noMoreStatements/resp_OK
DISPATCH_STATEMENT --> [*]: failure/resp_EXECUTION_ERROR
DISPATCH_STATEMENT --> AWAITING_STATEMENT_RESPONSE: success
AWAITING_STATEMENT_RESPONSE --> [*]: failure/resp_EXECUTION_ERROR
AWAITING_STATEMENT_RESPONSE --> [*]: timeout
AWAITING_STATEMENT_RESPONSE --> SLEEPING: beginSleep
AWAITING_STATEMENT_RESPONSE --> BREAK_CHECK: success
SLEEPING --> [*]: timeout/resp_EXECUTION_ERROR
SLEEPING --> [*]: error/resp_EXECUTION_ERROR
SLEEPING --> BREAK_CHECK: shouldWake
}
IDLE --> VALIDATING: cmd_VALIDATE/setSequenceFilePath
IDLE --> VALIDATING: cmd_RUN/setSequenceFilePath
VALID --> RUNNING: if cmd_RUN
VALID --> AWAITING_CMD_RUN_VALIDATED: if cmd_VALIDATE
VALIDATING --> IDLE: failure/seqFailed,resp_EXECUTION_ERROR
VALIDATING --> VALID: success
VALIDATING --> IDLE: cmd_CANCEL/seqCancelled,resp_EXECUTION_ERROR
AWAITING_CMD_RUN_VALIDATED --> IDLE: cmd_CANCEL/seqCancelled
AWAITING_CMD_RUN_VALIDATED --> RUNNING: cmd_RUN_VALIDATED
RUNNING --> IDLE: failure
RUNNING --> IDLE: noMoreStatements
```
## Flags
The FpySequencer supports certain boolean flags which control the behavior of the sequencer while running a sequence. The flags can be accessed and modified by the sequence itself, or by command while a sequence is running. When a sequence starts running, the flags are initialized to a value configured by the FLAG_DEFAULT_XYZ parameters.
@ -106,4 +198,4 @@ The FpySequencer has a set of debugging commands which can be used to pause and
| 67 | PUSH_TLM_VAL_AND_TIME | Gets a telemetry channel and pushes its value, and then its time, onto the stack |
| 68 | PUSH_TIME | Pushes the current time, from the `timeCaller` port, to the stack |
| 69 | SET_FLAG | Pops a bool off the stack, sets a flag with a specific index to that bool |
| 70 | GET_FLAG | Gets a flag and pushes its value as a U8 to the stack |
| 70 | GET_FLAG | Gets a flag and pushes its value as a U8 to the stack |