Merge pull request #267 from RobertGawron/feature/use_docker

add more uml diagrams
RobertGawron · Dec 11, 2024 · 3639b72 · 3639b72
2 parents e23a3cf + 1d135ab
commit 3639b72
Show file tree

Hide file tree

Showing 9 changed files with 48 additions and 195 deletions.
diff --git a/Documentation/Diagrams/FirmwareSequenceDiagram.plantuml b/Documentation/Diagrams/FirmwareSequenceDiagram.plantuml
@@ -0,0 +1,40 @@
+@startuml
+actor User
+
+participant "Main" as Main
+participant "Application Builder" as AppBuilder
+participant "Clock Configurator" as Clock
+participant "Timer Configurator" as Timer
+participant "Logger" as Logger
+participant "Measurement Collector" as MeasurementCollector
+participant "Measurement Frame" as Frame
+participant "Voltage Sensor" as Voltage
+
+User -> Main : Power on the device
+Main -> AppBuilder : ApplicationBuilder_Init()
+AppBuilder -> Clock : ClockConfigurator_Init()
+AppBuilder -> Timer : TimerConfigurator_Init()
+AppBuilder -> Logger : Logger_Init()
+AppBuilder -> UI : UserInterface_Init()
+AppBuilder -> Voltage : VoltageSensorActualValue_Init()
+AppBuilder -> MeasurementCollector : MeasurementCollector_Init()
+
+AppBuilder -> UI : UserInterface_ShowMessage(USER_INTERFAE_STATE_OK_MSG)
+
+== Main Loop ==
+Main -> AppBuilder : ApplicationBuilder_Run()
+loop Wait for interrupt and process
+    Main -> AppBuilder : ApplicationBuilder_Tick()
+    AppBuilder -> MeasurementCollector : MeasurementCollector_Tick()
+    MeasurementCollector -> Voltage : VoltageSensorActualValue_GetConfiguration()
+    MeasurementCollector -> Voltage : VoltageSensorActualValue_MeasureValue()
+    Voltage -> MeasurementCollector : Measurement Data
+    MeasurementCollector -> Frame : MeasurementFrame_Create(configuration, data)
+    MeasurementCollector -> Frame : MeasurementFrame_Send(callback)
+
+    Frame -> Logger : Logger_Print(data)
+    Logger --> Frame : Acknowledge
+
+    AppBuilder -> UI : UserInterface_Tick()
+end
+@enduml
diff --git a/Documentation/Diagrams/FirmwareSequenceDiagram.svg b/Documentation/Diagrams/FirmwareSequenceDiagram.svg
diff --git a/Documentation/Diagrams/HostArchitecture-1.png b/Documentation/Diagrams/HostArchitecture-1.png
diff --git a/Documentation/Diagrams/HostArchitecture.svg b/Documentation/Diagrams/HostArchitecture.svg
diff --git a/Documentation/Diagrams/HostArchitecture.tex b/Documentation/Diagrams/HostArchitecture.tex
diff --git a/Documentation/Diagrams/MeasurementDataFlowDiagram.plantuml b/Documentation/Diagrams/MeasurementDataFlowDiagram.plantuml
diff --git a/Documentation/Diagrams/MeasurementDataFlowDiagram.svg b/Documentation/Diagrams/MeasurementDataFlowDiagram.svg
diff --git a/README.md b/README.md
@@ -44,6 +44,10 @@ PCB was done in KiCAD.
 
 ## Software
 
+Measurements are collected from the COM port (tunneled over USB) by a Python script and stored in a .csv file. This file can later be parsed using R scripts to generate various diagrams, such as radioactivity changes over time, radioactivity histograms, and box plots for different samples.
+
+![measurement data flow diagram](./Documentation/Diagrams/MeasurementDataFlowDiagram.svg)
+
 * [Details about the firmware are available here.](./Software/Firmware/README.md)
 * [Details about the acquisition software are available here.](./Software/MeasurementAcquisition/README.md)
 * [Details about the measurement processing software are available here.](./Software/MeasurementAnalysis/README.md)

diff --git a/Software/Firmware/README.md b/Software/Firmware/README.md
@@ -1,8 +1,8 @@
 # Architecture
 
-Measurements are collected from the COM port (tunneled over USB) by a Python script and stored in a .csv file. This file can later be parsed using R scripts to generate various diagrams, such as radioactivity changes over time, radioactivity histograms, and box plots for different samples.
+Below is the sequence diagram for the firmware.
 
-<img src="../Documentation/Diagrams/HostArchitecture.svg" width="100%">
+![firmware sequence diagram](../../Documentation/Diagrams/FirmwareSequenceDiagram.svg)
 
 # Building Firmware