Skip to content

Commit 5ee7cfd

Browse files
author
naahm003
committed
Add state machine and flow diagrams for RX and TX processes
- Added RX System State Machine diagram in SVG format to `_static/diagrams/rx_state_machine/`. - Added TX Board Send Flow diagram in SVG format to `_static/diagrams/tx_sequence_send/`. - Updated README.md in `docs/diagrams/` to include instructions for copying generated diagrams to the Sphinx `_static` directory and rebuilding documentation.
1 parent cbe5dbc commit 5ee7cfd

File tree

7 files changed

+26
-6
lines changed

7 files changed

+26
-6
lines changed

ARCHITECTURE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ This document reflects the current modular architecture with a central MessageRo
44

55
## RX: Top-Level Layout
66

7-
![RX Architecture — Components](docs/diagrams/out/docs/diagrams/architecture_component/Architecture%20Component%20Overview.svg)
7+
![RX Architecture — Components](_static/diagrams/architecture_component/Architecture%20Component%20Overview.svg)
88

99
## RX: State Machine Flow
1010

11-
![RX System State Machine](docs/diagrams/out/docs/diagrams/rx_state_machine/RX%20System%20State%20Machine.svg)
11+
![RX System State Machine](_static/diagrams/rx_state_machine/RX%20System%20State%20Machine.svg)
1212

1313
Triggers:
1414
- First Cluster frame → WaitingForData → Active
@@ -17,7 +17,7 @@ Triggers:
1717

1818
## RX: Event/Data Flow
1919

20-
![CAN RX Frame Flow](docs/diagrams/out/docs/diagrams/can_sequence_rx/CAN%20RX%20Frame%20Flow.svg)
20+
![CAN RX Frame Flow](_static/diagrams/can_sequence_rx/CAN%20RX%20Frame%20Flow.svg)
2121

2222
Details:
2323
1) ISR (CanInterface::CanMsgHandler)
@@ -101,13 +101,13 @@ TX board is a small producer of `Cluster` frames (ID 0x65), without LVGL or UI.
101101

102102
### TX Send Sequence
103103

104-
![TX Board Send Flow](docs/diagrams/out/docs/diagrams/tx_sequence_send/TX%20Board%20Send%20Flow.svg)
104+
![TX Board Send Flow](_static/diagrams/tx_sequence_send/TX%20Board%20Send%20Flow.svg)
105105

106106
---
107107

108108
### RX Class Diagram
109109

110-
![RX Class Diagram](docs/diagrams/out/docs/diagrams/rx_class_diagram/RX%20Class%20Diagram.svg)
110+
![RX Class Diagram](_static/diagrams/rx_class_diagram/RX%20Class%20Diagram.svg)
111111

112112
## Build/Env Notes
113113

Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)