diff options
| -rw-r--r-- | docs/handover.adoc | 69 |
1 files changed, 32 insertions, 37 deletions
diff --git a/docs/handover.adoc b/docs/handover.adoc index 016dfa0..ffeef94 100644 --- a/docs/handover.adoc +++ b/docs/handover.adoc @@ -1,6 +1,24 @@ :document: Handover Report 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. + +Previous years' groups have put their predecessor's documents inside their own +project folder, which has resulted in what we called the 'Russian doll folder +structure'. <<pn:blansch>> has separated out each year's project folder +('master file'), and is hosting these on +<https://media.pipeframe.xyz/puzzlebox>. This directory is also mountable as a +read-only WebDAV share on Windows, MacOS and Linux (using davfs2), and does not +require credentials to log in. Please note that this is very much unofficial, +and is not managed or endorsed by Avans. <<pn:blansch>> is the contact for +removal or transfer of these files. + == Introduction This is an informal document that summarizes how the 23-24 run of this project @@ -8,22 +26,6 @@ went. We found the previous handover documents to be unhelpful when determining the 'actual' state of the project in the first few weeks, and felt they did not address the pitfalls of this project. -== Project History - -=== Garbage workarounds - -This section details unelegant workarounds that should be removed from the -code. All workarounds are marked with ``FIXME:`` comments referring to one of -the workarounds mentioned in this section. - -RP2040 I^2^C limitations:: -- All puzzle module drivers have a hard-coded 2 second delay between receiving - the MAGIC handshake request and the MAGIC handshake response handler. This - was done to ensure responses are not ignored by the RP2040 (main controller) - while it is still in I^2^C master mode. - -=== Incidents - == Group History === 19-20 @@ -94,30 +96,11 @@ puzzle box chassis.] | Elwin Hammer | Software | [[pn:faase,Lars Faase]]Lars Faase{empty}footnote:[<<pn:faase>> was removed from the project group on 2024-06-03 following complaints about the lack of -communication.] | Software +communication, and lack of motivation] | Software | [[pn:blansch,Loek Le Blansch]]Loek Le Blansch | Software | Thomas in 't Anker | Software |=== - -== 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. - -Previous years' groups have put their predecessor's documents inside their own -project folder, which has resulted in what we called the 'Russian doll folder -structure'. <<pn:blansch>> has separated out each year's project folder -('master file'), and is hosting these on -<https://media.pipeframe.xyz/puzzlebox>. This directory is also mountable as a -read-only WebDAV share on Windows, MacOS and Linux (using davfs2), and does not -require credentials to log in. Please note that this is very much unofficial, -and is not managed or endorsed by Avans. <<pn:blansch>> is the contact for -removal or transfer of these files. - == 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 @@ -139,7 +122,7 @@ software for the puzzle modules 'Vault' and 'Neotrellis' is in the product state The hardware design can be derived from the year 2022-2023, and you can derive the game rules from the year 2020-2021. -== Challenges +== Incidents There were a multitude of different challenges we had to face before getting to a working product. Most of these have been documented here, and it is highly recommended to have a look at this before development. @@ -183,6 +166,18 @@ in the same environment (if there are 2 software students). Allocating memory using 'realloc' on arduino is not possible, which also denies usage of the 'mpack_writer_init_growable' +=== Garbage workarounds + +This section details unelegant workarounds that should be removed from the +code. All workarounds are marked with ``FIXME:`` comments referring to one of +the workarounds mentioned in this section. + +RP2040 I^2^C limitations:: +- All puzzle module drivers have a hard-coded 2 second delay between receiving + the MAGIC handshake request and the MAGIC handshake response handler. This + was done to ensure responses are not ignored by the RP2040 (main controller) + while it is still in I^2^C master mode. + == Imperatives * Start creating prototypes as fast as possible, this benefits the project in the long run, as you have already shown that certain parts of the project are already working and only |