Skip to content

Commit

Permalink
[ROOT] Add some documentation on the architecture
Browse files Browse the repository at this point in the history
  • Loading branch information
MrVyM committed Nov 27, 2023
1 parent 1b4e036 commit 96fb59b
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 0 deletions.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,45 @@
```sh
cargo run
```
# Wanted Architecture
```mermaid
flowchart RL
STM
subgraph ide1 [UsbManager]
UsbDecoder
UsbEncoder
end
STM --> UsbDecoder
UsbEncoder --> STM
subgraph ide2 [Capteur]
LidarProcessor
IMUProccesor
OdometerProcessor
CameraProcessor
end
LidarProcessor --> PositionManager
IMUProccesor --> PositionManager
OdometerProcessor --> PositionManager
CameraProcessor --> PositionManager
CameraProcessor --> ObjectManager
LidarProcessor --> ObjectManager
subgraph ide3 [State]
Mapper
PositionMedium
end
MQTTClient <--> PositionMedium
MQTTClient <--> UsbDecoder
TrajectoryPlanner --> TrajectoryGenerator
TrajectoryGenerator --> UsbEncoder
PositionMedium --> TrajectoryPlanner
TrajectoryPlanner --> PositionManager
PositionManager --> PositionMedium
MQTTClient --> MQTT
```
14 changes: 14 additions & 0 deletions src/strategy/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Strategy

```mermaid
flowchart RL
Wait ==> FindFlower
FindFlower ==> GotoFlower --> Wait
GotoFlower ==> GrabFlower
GrabFlower ==> FindPot --> Wait
FindPot ==> GotoPot --> Wait
GotoPot ==> Planting --> Wait
Planting ==> GotoSerre --> Wait
GotoSerre ==> FindFlower --> Wait
```

0 comments on commit 96fb59b

Please sign in to comment.