aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorThomasintAnker <thomasintanker1@gmail.com>2024-06-15 12:27:13 +0200
committerThomasintAnker <thomasintanker1@gmail.com>2024-06-15 12:27:13 +0200
commit50d5c4efb082a1ca5fc41f8aff493d5387fa796b (patch)
tree5f6e3c142a8f94f4e9fda970797b6fbaaa4e7280 /docs
parent3a8fcd3a27cc39a360e367a0492878e2e9aa8f28 (diff)
Handover doc
Diffstat (limited to 'docs')
-rw-r--r--docs/handover.adoc35
-rw-r--r--docs/makefile1
-rw-r--r--docs/share/glossary.adoc4
3 files changed, 38 insertions, 2 deletions
diff --git a/docs/handover.adoc b/docs/handover.adoc
new file mode 100644
index 0000000..94896e3
--- /dev/null
+++ b/docs/handover.adoc
@@ -0,0 +1,35 @@
+:document: Handover
+include::share/meta.adoc[]
+
+=== A Note Before Reading
+The team of year 2023-2024 consisted of only software students, meaning no
+hardware was developed in this year. We were tasked with simplifying the
+software to the point where it would only have to be ported into the new hardware,
+which was designed in the year 2022-2023. The goal of this year would be to create
+a software framework which can be used to implement new puzzles and to make the
+development process of these puzzles easier.
+
+== Project State
+The current project state is as follows: No new hardware has been designed
+or developed this year. The software was completely revised, now consisting of a
+main controller, and multiple puzzle modules. The main controller (a RPI Pico W)
+can interact with the different puzzle modules using an I^2^C bus.
+
+== What Went Wrong
+
+== Recommendations
+kijk naar de documentatie maar verifieer alles op het laagste niveau
+
+Voor de volgende jaren: maak zo snel mogelijk prototypes, laat zien dat *iets* werkt
+
+ER MOET ONDERZOCHT WORDEN NAAR MULTIMASTER CONTROLLERS DIE OOK ALS SLAVE KUNNEN WORDEN GEADDRESSEERD (INTENS MOEILIJK TE VINDEN)
+
+i2c MOET, arbitration moet, Atmega328p zou geschikt zijn voor losse puzzelmodules
+
+--
+Maak een duidelijke waarschuwing"
+- ga er niet van uit dat je het al weet, doe ff wat low level research over de onderwerpen
+
+rpi heeft programmable io modules, mogelijk via deze omweg rp2040 wel als MULTIMASTER met slave adresseerbaar
+- rp2040 kan alleen 7-bit adressen hebben
+include::share/footer.adoc[]
diff --git a/docs/makefile b/docs/makefile
index f175830..eb54a80 100644
--- a/docs/makefile
+++ b/docs/makefile
@@ -2,6 +2,7 @@ all: plan.pdf
all: reqs.pdf
all: research.pdf
all: design.pdf
+all: handover.pdf
# include font.mk
diff --git a/docs/share/glossary.adoc b/docs/share/glossary.adoc
index 871a8e9..14c0374 100644
--- a/docs/share/glossary.adoc
+++ b/docs/share/glossary.adoc
@@ -5,6 +5,6 @@
RPI:: Raspberry Pi
Main board:: The main board is the PCB on the bottom of the puzzle box, this communicates with the puzzles and the bomb
Puzzle box hub:: The puzzle box hub communicates with the puzzle box and the bomb, as well as helps with configuring them
-SID:: security identifiers
-game operator:: person who organizes a puzzle box play session
+SID:: Security identifiers
+game operator:: Person who organizes a puzzle box play session