final documentation check

4 files changed, 67 insertions, 60 deletions

diff --git a/docs/design.adoc b/docs/design.adoc
index 9e48fd4..6df83b6 100644
--- a/docs/design.adoc
+++ b/docs/design.adoc
@@ -13,7 +13,7 @@ structure, and has three levels of design 'depth':
 
 Only design details deemed relevant by the document authors are documented
 here. Low-level implementation details such as API interfaces, code paths and
-workarounds are documented inside the source code repository.
+workarounds are documented with Doxygen cite:[pbdox].
 
 [[sec:lv1]]
 == Top-Level
@@ -34,8 +34,9 @@ main controller and multiple puzzle modules. Other notable details include:
   time of writing (2024-03-11), and this project only describes the interface
   between the puzzle box and the bomb.
 * The puzzle box is capable of bidirectional communication over Wi-Fi. This
-  connection is used to configure the puzzle box before gameplay or modify its
-  state during gameplay.
+	connection is used to configure the puzzle box before gameplay or modify its
+	state during gameplay (<<reqs.adoc#req:edge-manual-reset>>,
+	<<reqs.adoc#req:edge-skip-puzzle>>).
 
 [[fig:system-top]]
 .Context block diagram
@@ -92,8 +93,11 @@ The criteria for a puzzle module controller are:
 The research document cite:[research] compares various microcontrollers
 matching these criteria. As a result of this research, the Microchip
 PIC16F15276 was selected as the recommended microcontroller for future puzzle
-modules. The current development hardware utilizes an ESP32-PICO-D4 module, so
-the puzzle module software is written with portability in mind.
+modules.
+
+NOTE: The current development hardware still utilizes an ESP32-PICO-D4 module,
+but due to a misunderstanding cite:[handover], Arduino boards were used to
+implement the puzzle modules.
 
 [[fig:puzzle-module-top]]
 .Generic puzzle module top-level block diagram
@@ -149,10 +153,9 @@ Pi Pico W as main controller during development.
 
 NOTE: This was written while we did not know the puzzle bus specifically
 requires slave-addressible I^2^C multi-master controllers to function properly.
-While the research concludes the RP2040 is a suitable microcontroller for the
-main controller, it is not. The RP2040 was still used, but has required
-implementing workarounds. Please see the handover report for more details on
-how this impacted the project cite:[handover].
+The RP2040 was still used, but has required implementing workarounds. Please
+see the handover report for more details on how this impacted the project
+cite:[handover].
 
 [[fig:main-controller-top]]
 .Main controller top-level block diagram
@@ -187,8 +190,10 @@ multi-master I^2^C bus, and all puzzle modules are specified to be I^2^C
 multi-master controllers that are slave-addressible. The multi-master part is
 required to prevent I^2^C transmissions from being corrupted in the event of a
 bus collision, and the slave-addressible part is required to both send and
-receive messages on the same controller. This is the only hardware-level
-specification made this year.
+receive messages on the same controller. This can also be achieved by using 2
+I^2^C peripherals on the same bus simultaniously, which is what the RP2040
+currently uses. This has required changes to the wiring, and is the only
+hardware-level specification made this year.
 
 More details on the messages sent over the puzzle bus are described in
 <<sec:lv3-pb-messages>>.
@@ -253,7 +258,7 @@ development of future puzzle modules (<<reqs.adoc#req:main-static>>).
 === Puzzle module framework
 
 This subsection defines aspects of the 'puzzle framework': the interface that
-allows puzzle modules to integrate with the puzzle bus main controller. All
+allows puzzle modules to integrate with the puzzle bus and main controller. All
 communication described within this subsection refers to 'internal'
 communication between the main controller and puzzle modules on the puzzle bus.
 
@@ -295,7 +300,7 @@ is shown in <<tab:pb-msg-fmt>>. The messages are (de)serialized using mpack.
 This choice was made after considering various alternative options for sending
 structured messages cite:[research]. Note that all messages are sent as I^2^C
 writes. Due to this, the I^2^C address of a message sender is included in the
-header.
+header to facilitate network-like features over I^2^C.
 
 [[tab:pb-msg-fmt]]
 .Puzzle bus message format
@@ -332,7 +337,8 @@ is solved.
 | ``PROP``
 | The PROP command type is used for exchanging arbitrary data between puzzle
 modules and/or the puzzle box client (pbc) over the <<sec:main-bridge,TCP
-bridge>>. These properties are not used by the puzzle framework.
+bridge>>. These properties are not used by the puzzle framework, and serve as
+an extensible interface for puzzle module developers to use.
 |===
 
 <<tab:pb-msg-actions>> lists the different command actions.
@@ -362,7 +368,7 @@ main controller firmware (<<reqs.adoc#req:main-static>>).
 
 The specific format of the 'cmd' field from <<tab:pb-msg-fmt>> is different for
 each command type, and is for this reason only documented in-code using
-Doxygen.
+Doxygen cite:[pbdox].
 
 [[sec:framework-state]]
 ==== State
@@ -401,16 +407,15 @@ expansion without modification of the main controller software
 
 The RPI Pico SDK prohibits the use of I^2^C addresses reserved by the I^2^C
 specification. This means different addresses from previous years are used.
-These addresses are indexed in the code under a shared header (see
-``lib/pbdrv/pb.h``).
-
-The same I^2^C address may be used by two different puzzle modules, but this
-will make it impossible for them to be used simultaniously.
+These addresses are indexed in the code in a header exposed by the puzzle bus
+driver cite:[pbdox].
 
 The I^2^C addresses are also used to determine the puzzle sequence (i.e. the
 order in which puzzle modules are set to the 'playing' state). The sequence is
 determined by the main controller on startup, and consists of the connected
 puzzle modules' addresses in descending order (i.e. highest address first).
+Note that the same I^2^C address may be used by two different puzzle modules,
+but this will make it impossible for them to be used simultaniously.
 
 === Main Controller
 
@@ -423,14 +428,15 @@ startup. Puzzle modules start in the 'uninitialized' state (see
 <<fig:puzzle-module-common-state>>), during which they do nothing. Puzzle
 modules in this state are still able to reply to requests, including MAGIC REQ
 commands. When the main controller receives a MAGIC RES command, the I^2^C
-address of the sender is added to an internal list for puzzle modules.
+address of the sender is added to an internal list of I^2^C devices that are
+considered puzzle modules.
 
 After the initial handshake request 'wave' (bus scan), all puzzle modules are
 repeatedly asked for their global state using a STATE REQ command. This request
 also includes the global state of the requesting puzzle module, which is always
 the main controller (under normal circumstances). Upon receiving the first
 STATE REQ command, a puzzle module knows it has been registered successfully by
-the main controller, and may transition into the 'idle' state.
+the main controller, and transitions into the 'idle' state.
 
 [[fig:sequence-puzzle-module-init]]
 .Puzzle module initialization sequence diagram
@@ -479,10 +485,7 @@ Due to the separation of the puzzle bus driver code into a standalone library
 for reading/writing puzzle bus commands, and a puzzle module-specific code, the
 puzzle box client is able to read/write raw I^2^C commands directly. A separate
 library was made for serializing I^2^C messages so they can be sent over the
-TCP connection.
-
-Detailed specifications on the TCP socket server are in
-<<sec:lv3-remote-control>>.
+TCP connection. This library is documented in detail using Doxygen cite:[pbdox].
 
 ==== Operating system
 
@@ -494,13 +497,6 @@ choice was between FreeRTOS and Zephyr. FreeRTOS was chosen because it is the
 simplest solution, and because the features Zephyr offers over FreeRTOS are
 already present in the Raspberry Pi Pico SDK.
 
-NOTE: Due to the issues with the RP2040 that were later discovered
-cite:[handover], delays are used within the puzzle bus driver's message
-handling logic. This means that due to the use of the RP2040, *all puzzle
-modules* are required to use a task scheduler or similar mechanism for
-deferring calls to the puzzle bus driver from the I^2^C interrupt service
-routine (ISR).
-
 === NeoTrellis puzzle
 
 This subsection defines aspects of the 'NeoTrellis puzzle' module and gives a
@@ -515,8 +511,8 @@ button. The way to solve this puzzle is by dimming every Neopixel in the 8x8
 matrix. This is done by clicking on a button, which switches the state of the
 Neopixel underneath the pixel and the Neopixels in each cardinal direction from
 the pressed button. This means that if a Neopixel was on and the button was
-pressed it will turn off and vice-versa. A visual example can be found in
-Appendix B.
+pressed it will turn off and vice-versa.
+// A visual example can be found in Appendix B.
 
 ==== Puzzle inputs & outputs
 
@@ -544,7 +540,8 @@ have their own logical circuit engraved in the box, and the 6 input ports on
 the right side of the puzzle have a letter (A through F) engraved in the box.
 The way to solve the puzzle is by connecting the banana plug cable from an
 input port on the left side of the puzzle to the corresponding input port on
-the right side of the puzzle. An example of this can be found in Appendix C.
+the right side of the puzzle.
+// An example of this can be found in Appendix C.
 
 When the puzzle starts, the participants of the game will have 6 code-fragments
 written on paper, corresponding to the logical circuits on the puzzle box. The
@@ -605,14 +602,4 @@ clicked the vault resets and they need to start over from the beginning.
 .Vault puzzle in-out
 image::img/vault-io.png[]
 
-== Components
-[[sec:lv3-remote-control]]
-=== Remote control
-
-[appendix]
-== NeoTrellis puzzle example
-
-[appendix]
-== Software puzzle example
-
 include::share/footer.adoc[]
diff --git a/docs/handover.adoc b/docs/handover.adoc
index 77d5da0..efeec00 100644
--- a/docs/handover.adoc
+++ b/docs/handover.adoc
@@ -84,6 +84,8 @@ The current project state is as follows:
 ** two puzzle modules ('Vault' and 'NeoTrellis') integrated using the puzzle
 	 bus driver
 
+Functionality:
+
 * The main controller (a RPI Pico W) can interact with the different puzzle
 	modules using a central shared I^2^C bus (referred to as the 'puzzle bus')
 * The main controller is able to find new puzzle modules on startup, and does
@@ -92,6 +94,11 @@ The current project state is as follows:
 	main controller through a TCP connection and allows control over various
 	aspects of the puzzle box using simple commands.
 
+Documentation:
+
+* These project documents
+* Detailed usage and API documentation for all software modules cite:[pbdox]
+
 == Incidents
 
 During this year's run of the project, we encountered several difficuties we
@@ -142,10 +149,11 @@ Please note the following differences between I^2^C devices:
 	regular I^2^C slave devices.
 - I^2^C multi-master controllers that are slave-addressable in master mode are
 	the only kind of I^2^C controller suitable for use in puzzle modules.
+	Microcontrollers with 2 I^2^C peripherals on the same bus (one in master
+	mode, one in slave mode) can also be used to achieve the same effect.
 
 The RP2040 supports multi-master, but is not addressable as a slave in master
-mode. Due to time constraints, this was mitigated using a workaround (see
-<<fixme:rp2040-i2c>>).
+mode. This was mitigated using a workaround (see <<fixme:rp2040-i2c>>).
 
 === Development hardware availability
 
@@ -161,6 +169,12 @@ multiple people to develop using the same setup. Note that the RPI Pico is a
 special case, as it requires another Pico for debugging, effectively requiring
 double the amount of hardware to support developers.
 
+Due to a misunderstanding, we also thought our development boards went missing
+somewhere during week 13. Double-checking if project materials were actually
+stolen, or making clear where the materials are stored by sending an image of
+its location could have easily avoided this from happening; make sure to do
+either.
+
 === Auxiliary workarounds and technical limitations
 
 This section details workarounds that were implemented instead of being fixed
@@ -170,10 +184,9 @@ mentioned in this section.
 
 [[fixme:rp2040-i2c,RP2040 I^2^C limitations]]
 <<fixme:rp2040-i2c>>::
-- 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.
+- The RP2040 is not slave-addressable while in master mode. A workaround that
+	uses both I^2^C peripherals simultaniously was written to work around this
+	issue.
 
 Memory management on Arduino::
 The Arduino's built-in memory management functions do not seem to work
@@ -208,7 +221,7 @@ are critical for project success:
 - The RPI Pico (and Pico W)'s I^2^C peripheral supports multi-master, but does
 	not support being addressed as a slave while in master mode. This is required
 	for puzzle bus integration, and was mitigated using a workaround (see
-	<<fixme:rp2040-i2c>>). A replacement controller should be used instead.
+	<<fixme:rp2040-i2c>>).
 
 === Other suggestions
 
@@ -216,13 +229,13 @@ These points are suggestions for future project groups. While we do not think
 these are critical to project success, we still think they are important to
 mention.
 
-- Implement the hardware design from the year 22-23.
+- The hardware design from the year 22-23 should be implemented.
 - The original game rules are described in a separate document from the year
 	20-21.
 - The RPI Pico W has programmable I/O modules. Due to time constraints, we did
 	not research if these modules can be used to create a custom I^2^C peripheral
 	(and driver) that allows multi-master communication while still being
-	addressable as a slave. If this is possible, the RPI Pico W can still be used
-	as main controller without the use of workarounds.
+	addressable as a slave. If this is possible, the RPI Pico W could be used
+	without the use of workarounds.
 
 include::share/footer.adoc[]
diff --git a/docs/research.adoc b/docs/research.adoc
index 7a9d56c..6f9b494 100644
--- a/docs/research.adoc
+++ b/docs/research.adoc
@@ -145,10 +145,9 @@ The Raspberry Pi Pico W board is utilized during development.
 
 NOTE: This was written while we did not know the puzzle bus specifically
 requires slave-addressible I^2^C multi-master controllers to function properly.
-While the research concludes the RP2040 is a suitable microcontroller for the
-main controller, it is not. The RP2040 was still used, but has required
-implementing workarounds. Please see the handover report for more details on
-how this impacted the project cite:[handover].
+The RP2040 was still used, but has required implementing workarounds. Please
+see the handover report for more details on how this impacted the project
+cite:[handover].
 
 [[tab:main-mcu]]
 .Main controller MCU candidates
diff --git a/docs/share/refs.bib b/docs/share/refs.bib
index 481d4d1..299d621 100644
--- a/docs/share/refs.bib
+++ b/docs/share/refs.bib
@@ -219,3 +219,11 @@
 	year = {2023},
 	msbib-accessed = {2024-05-11},
 }
+
+@techreport{pbdox,
+	title = {puzzlebox Doxygen documentation},
+	author = {Blansch, Loek Le and Hammer, Elwin and Faase, Lars and in 't Anker, Thomas},
+	url = {https://media.pipeframe.xyz/puzzlebox/23-24/doxygen},
+	year = {2024},
+}
+