aboutsummaryrefslogtreecommitdiff
path: root/report.qmd
diff options
context:
space:
mode:
authorJonas Smedegaard <dr@jones.dk>2025-04-01 22:18:26 +0200
committerJonas Smedegaard <dr@jones.dk>2025-04-01 22:18:26 +0200
commit223894c7305a084130edfba75108c87b2c453691 (patch)
tree24c6110430cabc81c27584425e5fcca51c4e387b /report.qmd
parentaaf35ec4d317224b6fa9a226479f0d56fc266eb0 (diff)
add library as appendix; add diagrams to library; drop individual mussel sketches
Diffstat (limited to 'report.qmd')
-rw-r--r--report.qmd55
1 files changed, 25 insertions, 30 deletions
diff --git a/report.qmd b/report.qmd
index 42df97a..c9bb64a 100644
--- a/report.qmd
+++ b/report.qmd
@@ -86,8 +86,26 @@ TODO
# Description of the Program
+Use of the library in a sketch...
+
+```{.plantuml}
+!include Mussel/examples/seconds/seconds.puml
+```
+
TODO
+## Library function `begin()`
+
+```{.plantuml}
+!include Mussel/Mussel_begin.puml
+```
+
+## Library function `read()`
+
+```{.plantuml}
+!include Mussel/Mussel_read.puml
+```
+
# User Guide
TODO
@@ -114,42 +132,19 @@ TODO
\appendix
-# Arduino project code {.appendix}
-
-## mussel 1
-
-```{.plantuml}
-!include mussel1/mussel1.puml
-```
-
-```{.c include="mussel1/mussel1.ino" code-line-numbers="true"}
-```
-
-## mussel 2
-
-```{.plantuml}
-!include mussel2/mussel2.puml
-```
-
-```{.c include="mussel2/mussel2.ino" code-line-numbers="true"}
-```
-
-## mussel 3
-
-```{.c include="mussel3/mussel3.ino" code-line-numbers="true"}
-```
+# Mussel library {.appendix}
-## mussel 4
+## Headers
-```{.c include="mussel4/mussel4.ino" code-line-numbers="true"}
+```{.c include="Mussel/Mussel.h" code-line-numbers="true"}
```
-## mussel 5
+## Source code
-```{.c include="mussel5/mussel5.ino" code-line-numbers="true"}
+```{.c include="Mussel/Mussel.cpp" code-line-numbers="true"}
```
-## mussel 6
+## Example sketch
-```{.c include="mussel6/mussel6.ino" code-line-numbers="true"}
+```{.c include="Mussel/examples/seconds/seconds.ino" code-line-numbers="true"}
```