From 50d5c4efb082a1ca5fc41f8aff493d5387fa796b Mon Sep 17 00:00:00 2001 From: ThomasintAnker Date: Sat, 15 Jun 2024 12:27:13 +0200 Subject: Handover doc --- docs/handover.adoc | 35 +++++++++++++++++++++++++++++++++++ docs/makefile | 1 + docs/share/glossary.adoc | 4 ++-- 3 files changed, 38 insertions(+), 2 deletions(-) create mode 100644 docs/handover.adoc (limited to 'docs') 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 -- cgit v1.2.3 From 13b5f07326adde72f4e72bbb3b61d75eb643cf52 Mon Sep 17 00:00:00 2001 From: ThomasintAnker Date: Sat, 15 Jun 2024 17:34:56 +0200 Subject: finished project state --- docs/handover.adoc | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/handover.adoc b/docs/handover.adoc index 94896e3..91fc03c 100644 --- a/docs/handover.adoc +++ b/docs/handover.adoc @@ -10,14 +10,26 @@ 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 +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. +a puzzle bus driver, a main controller, a simple CLI application, and two puzzle +modules. Namely the puzzle modules 'Vault' and 'Neotrellis', both using an arduino +as the controller. The main controller (a RPI Pico W) can interact with the +different puzzle modules using an I^2^C bus. The I^2^C bus has been configured to +be a multi-master I^2^C bus. allowing the puzzle modules and the main controller +to send and recieve messages on their own. The main controller is able to find +new puzzle modules on startup, and does not check for new modules afterwards. A +simple CLI application has been developed, which can communicate with the main +controller through a tcp connection and simple commands. == What Went Wrong +Vorige week hadden Elwin en Thomas wat moeite met het werkend krijgen van de multi-master I2C driver voor de Raspberry Pi Pico, en na wat rond puzzelen bleek dit een hardware limitatie van de RP2040 te zijn. De Atmega328P (van de Arduino) heeft de TWI-interface met ondersteuning voor I2C multi-master waarbij deze tegelijkertijd nog steeds adresseerbaar is als I2C slave. Dit kan de RP2040 niet, dus heb ik afgelopen maandag een workaround geïmplementeerd in de puzzel bus driver voor de RP2040. +Nu Lars uit onze groep is hebben we besloten zijn puzzel module te laten liggen. Door de slechte communicatie weten wij nu niet wat er mis is met deze puzzel module, en we zien het nu als een te groot risico om hier nu nog tijd in te steken. +Omdat ik nu beide Pico's thuis heb kunnen Elwin en Thomas momenteel weinig aan de software doen. Dit had heel makkelijk opgelost kunnen worden als ik meer dan 2 Pico's had laten bestellen, en dit zal ook zeker meegenomen worden in het overdrachtsdocument. + == Recommendations +Start creating prototypes as fast as possible, 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 @@ -32,4 +44,7 @@ Maak een duidelijke waarschuwing" rpi heeft programmable io modules, mogelijk via deze omweg rp2040 wel als MULTIMASTER met slave adresseerbaar - rp2040 kan alleen 7-bit adressen hebben + +Momenteel verwijs ik in het overdrachtsdocument naar https://media.pipeframe.xyz/puzzlebox; + include::share/footer.adoc[] -- cgit v1.2.3 From 9635fb2e56cdb319f5fd80ea5973412295e18cd8 Mon Sep 17 00:00:00 2001 From: ThomasintAnker Date: Sat, 15 Jun 2024 18:45:47 +0200 Subject: Finished challenges --- docs/handover.adoc | 69 ++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 52 insertions(+), 17 deletions(-) (limited to 'docs') diff --git a/docs/handover.adoc b/docs/handover.adoc index 91fc03c..905c826 100644 --- a/docs/handover.adoc +++ b/docs/handover.adoc @@ -1,7 +1,7 @@ :document: Handover include::share/meta.adoc[] -=== A Note Before Reading +== 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, @@ -9,6 +9,9 @@ which was designed in the year 2022-2023. The goal of this year would be to crea a software framework which can be used to implement new puzzles and to make the development process of these puzzles easier. +At the moment of writing, the documentation of previous years can be found at the +following link: 'https://media.pipeframe.xyz/puzzlebox'. + == 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 @@ -22,29 +25,61 @@ new puzzle modules on startup, and does not check for new modules afterwards. A simple CLI application has been developed, which can communicate with the main controller through a tcp connection and simple commands. -== What Went Wrong -Vorige week hadden Elwin en Thomas wat moeite met het werkend krijgen van de multi-master I2C driver voor de Raspberry Pi Pico, en na wat rond puzzelen bleek dit een hardware limitatie van de RP2040 te zijn. De Atmega328P (van de Arduino) heeft de TWI-interface met ondersteuning voor I2C multi-master waarbij deze tegelijkertijd nog steeds adresseerbaar is als I2C slave. Dit kan de RP2040 niet, dus heb ik afgelopen maandag een workaround geïmplementeerd in de puzzel bus driver voor de RP2040. -Nu Lars uit onze groep is hebben we besloten zijn puzzel module te laten liggen. Door de slechte communicatie weten wij nu niet wat er mis is met deze puzzel module, en we zien het nu als een te groot risico om hier nu nog tijd in te steken. -Omdat ik nu beide Pico's thuis heb kunnen Elwin en Thomas momenteel weinig aan de software doen. Dit had heel makkelijk opgelost kunnen worden als ik meer dan 2 Pico's had laten bestellen, en dit zal ook zeker meegenomen worden in het overdrachtsdocument. +In short: A puzzle bus driver has been implemented, to allow for communication +between the main controller and the puzzle modules. A CLI application was developed +which connects with the main controller to monitor/edit the gamestate. And the +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. -== Recommendations -Start creating prototypes as fast as possible, -kijk naar de documentatie maar verifieer alles op het laagste niveau +== Challenges +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. -Voor de volgende jaren: maak zo snel mogelijk prototypes, laat zien dat *iets* werkt +=== Misconceptions +Make sure to know what you are developing and do some research beforehand, to make +sure you have the complete picture about what you are using. Sounds stupid, but it +happened for multiple project attempts, and cause time-loss. This also includes +documentation of previous years: go through the documentation and verify it on the +lowest possible level for the same reason as previously mentioned. -ER MOET ONDERZOCHT WORDEN NAAR MULTIMASTER CONTROLLERS DIE OOK ALS SLAVE KUNNEN WORDEN GEADDRESSEERD (INTENS MOEILIJK TE VINDEN) +=== I^2^C +I^2^C is easy to implement but also easy to underestimate, this project requires a +multi-master structure as communication is otherwise too complicated compared to +other means of communication. -i2c MOET, arbitration moet, Atmega328p zou geschikt zijn voor losse puzzelmodules +For I^2^C on hardware level: make sure to use pull-up resistors, 2k2 if bus is on +100khz, as it is otherwise impossible to use I^2^C due to incorrect messages. This +is also recommended for controllers which are connected to the I^2^C bus. Make sure +to use I^2^C arbitration to check if the bus is not busy when writing to it, as +this will result in complictions in the communication. --- -Maak een duidelijke waarschuwing" -- ga er niet van uit dat je het al weet, doe ff wat low level research over de onderwerpen +The RPI Pico W (RP2040) does not support multi-master to the point of being able to +receive messages from other multi-masters as a slave while being configured as master. +Everything else about the I^2^C bus works, but due to this limitation a workaround has +been implemented to be able to continue using the RPI Pico W. Under ideal circumstances +a different controller could be found which does support this, but one was not found at +the time of writing. To simplify; a controller is needed which supports multi-master +while being able to be addressed as a slave-type controller. -rpi heeft programmable io modules, mogelijk via deze omweg rp2040 wel als MULTIMASTER met slave adresseerbaar -- rp2040 kan alleen 7-bit adressen hebben +=== Available Hardware/SDKs +When choosing or using specific chips/sdks make sure it is available for (at least) +a few years. This makes it easier for the next project team to use the same chips/sdks +instead of having to find new ones because the previous project team did not think about +this possibility. This also includes having enough sdks for multiple people to program +using the same setup, eg. the RPI Pico W requires another RPI Pico W to be debugged. +Effectively requiring the project team to have at least 4 RPI Pico Ws to be able to develop +in the same environment (if there are 2 software students). -Momenteel verwijs ik in het overdrachtsdocument naar https://media.pipeframe.xyz/puzzlebox; +== Recommendations +* 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 +need to be integrated. +* The Atmega328P-chip is sufficient for the puzzle modules as it has enough IO and I^2^C +connectivity possibilities. +* The RPI Pico W has programmable IO modules, making it possible to create an I^2^C driver +that allows multi-master communication while still being addressable as a slave. include::share/footer.adoc[] -- cgit v1.2.3 From d6dca7f40a51a40217ca9ec600e17527d9962a8b Mon Sep 17 00:00:00 2001 From: ThomasintAnker Date: Mon, 17 Jun 2024 13:07:02 +0200 Subject: Changed title of recommendations to proffesional english --- docs/handover.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/handover.adoc b/docs/handover.adoc index 905c826..280cb7e 100644 --- a/docs/handover.adoc +++ b/docs/handover.adoc @@ -73,7 +73,7 @@ using the same setup, eg. the RPI Pico W requires another RPI Pico W to be debug Effectively requiring the project team to have at least 4 RPI Pico Ws to be able to develop in the same environment (if there are 2 software students). -== Recommendations +== 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 need to be integrated. -- cgit v1.2.3 From b45b5d04daa29fcdd456233a931dcbb5b287769f Mon Sep 17 00:00:00 2001 From: ThomasintAnker Date: Tue, 18 Jun 2024 16:19:20 +0200 Subject: Finished handover --- docs/handover.adoc | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs') diff --git a/docs/handover.adoc b/docs/handover.adoc index 280cb7e..e25a864 100644 --- a/docs/handover.adoc +++ b/docs/handover.adoc @@ -73,6 +73,10 @@ using the same setup, eg. the RPI Pico W requires another RPI Pico W to be debug Effectively requiring the project team to have at least 4 RPI Pico Ws to be able to develop in the same environment (if there are 2 software students). +=== Arduino +Allocating memory using 'realloc' on arduino is not possible, which also denies usage of +the 'mpack_writer_init_growable' + == 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 -- cgit v1.2.3 From ae5dd8e93411e01b087a840d33b0c970cac4a523 Mon Sep 17 00:00:00 2001 From: ThomasintAnker Date: Tue, 18 Jun 2024 16:29:06 +0200 Subject: fixed multi doc handover --- docs/handover.adoc | 39 +++++++++++++-------------------------- 1 file changed, 13 insertions(+), 26 deletions(-) (limited to 'docs') diff --git a/docs/handover.adoc b/docs/handover.adoc index a3fd880..8c86e1b 100644 --- a/docs/handover.adoc +++ b/docs/handover.adoc @@ -85,7 +85,14 @@ communication.] | Software | Thomas in 't Anker | Software |=== -== Resources + +== 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 @@ -97,31 +104,6 @@ require credentials to log in. Please note that this is very much unofficial, and is not managed or endorsed by Avans. <> is the contact for removal or transfer of these files. -== Recommendations - -- The 22-23 design document already mentions that the application of the I^2^C - bus is in a multi-master configuration, but does not mention that this only - works when pull-up resistors are used on the SCL and SDA lines. The pull-up - resistors are required, as omitting them makes the bus arbitration process - very inconsistent which causes frames to be dropped entirely. - -include::share/footer.adoc[] - - -: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. - -At the moment of writing, the documentation of previous years can be found at the -following link: 'https://media.pipeframe.xyz/puzzlebox'. - == 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 @@ -195,5 +177,10 @@ need to be integrated. connectivity possibilities. * The RPI Pico W has programmable IO modules, making it possible to create an I^2^C driver that allows multi-master communication while still being addressable as a slave. +* The 22-23 design document already mentions that the application of the I^2^C +bus is in a multi-master configuration, but does not mention that this only +works when pull-up resistors are used on the SCL and SDA lines. The pull-up +resistors are required, as omitting them makes the bus arbitration process +very inconsistent which causes frames to be dropped entirely. include::share/footer.adoc[] -- cgit v1.2.3