FSM state diagram #306
FSM state diagram #306
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #306 +/- ##
==========================================
+ Coverage 85.93% 86.31% +0.37%
==========================================
Files 38 38
Lines 583 599 +16
==========================================
+ Hits 501 517 +16
Misses 82 82 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
I have a couple of comments/question, and a request.
Having a proper diagram is nice, but currently, the look and feel and the position at the bottom of the page is not that great. I get this:
The diagram is tiny, hard to read and, for some reason, makes the column with the FSM stuff wider than it should, with extra blank space at the right for no reason because the diagram does not extend that far. A few suggestions would be:
- Try to make the diagram bigger, and maybe horizontal, and at the top, rather than the bottom.
- Whatever the orientation, make sure the table is as wide as the FSM block.
- Use dark blue font of the active state.
- For the transitions, use transparent/white background, dark blue fonts for the active ones and grey for the not active ones.
I am not sure if any of these suggestions would make it any better, but as it is now, it is not that readable.
Yeah, the diagram is supposed to be in a column to the right of the FSM table, but it doesn't look great for small screens. However, I'm a bit hesitant to mess around with the layout, given @cvzbynek will be working on the controller page layout in #301. Perhaps we can review layout, and TD or LR in that PR once done? |
|
I would not waste too much time with the layout, but I would definitely give it another pass. As it sits now, it's really neither nice nor useful. My screen is not small, but 4 columns side by side might be way too much for any sensible screen. |
|
There is a sneak peak of my version of layout. Don't sweat it. We will discuss it as my changes go to PR. @dalonsoa you can have a look yourself in branch Controller_UI_rework |
|
|
Description
Add a flowchart representing the FSM state to the controller main page.
We use Mermaid JS to generate the flowchart on the state_machine page in controller. This graph is generated and updated dynamically based on what is returned by
get_fsm_architecture()andget_fsm_state.The current state and legal transitions are labelled green. All else grey.
Some basic styling is added to match the theme better.
Fixes #300
Type of change
Key checklist
python -m pytest)python -m sphinx -b html docs docs/build)pre-commit run --all-files)Further checks