Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- mexle:template_fuer_die_projektbeschreibung [2019/10/13 18:30]
tfischer [Pflichtenheft]
+++ mexle:template_fuer_die_projektbeschreibung [2021/09/14 13:14] (aktuell)
tfischer
@@ Zeile 14: / Zeile 14: @@
 ^letzte Änderung|Sommersemester 2019|
 ^Kurzbeschreibung|FIXME In der Kurzbeschreibung soll die wesentliche Funktion des Projekts in  einem Satz zusammengefasst werden|
+^ Verwendete MEXLE(-Module)  |                             |
-<WRAP center round important 60%>
+<WRAP left round important 60%>
 DELETEME
 **ACHTUNG!**
@@ Zeile 27: / Zeile 28: @@
   - Mit DELETEME ist Text gekennzeichnet, der in der finalen Doku nicht mehr vorhanden sein sollte
   - Mit FIXME ist Text gekennzeichnet, der für die finale Doku ergänzt werden muss
+  - Tipps zur Wikisyntax finden sich im [[:DokuWiki CheatSheet]]
 </WRAP>
+<WRAP left round important 60%>
+DELETEME
+Leider hat der "CKG Editor" (WYSIWYG-Editor) einen Bug, welcher beim Öffnen und Speichern die Überschriften verdoppelt.
+Es wird empfohlen den DW Edit (mit wiki-syntax) zu nutzen.
+Falls sie versehentlich den Button CKG Editor drücken, kommen sie folgendermaßen wieder zurück:
+  - Button "DW Edit" drücken (Seite wird dann mit doppelten Überschriften angezeigt)
+  - in der Menüleiste rechts auf "{{mdi>history}} ältere Versionen" klicken
+  - links zur vorletzte Version anklicken (Vorversion der aktuellen Version)
+  - in der Menüleiste rechts auf die "{{mdi>restore}} Wiederherstellen" klicken
+In ähnlicher Form kann auch vorgegangen werden, wenn versehentlich "Speichern" gedrückt wurde.
+Ebenso können Sie auch im CKG Editor eingefügten Text zunächst erst im DW Edit kopieren und dann erst die vorherige Version wiederherstellen.
+</WRAP>
+~~CLEARFIX~~
+ ----
+====== Projektübersicht ======
+===== Aufgabenstellung/Problemstellung =====
+FIXME
+Die Aufgabenstellung war eine kompakte Controllerplatine zu erstellen, welche als Basis für unterschiedlichste Projekte genutzt werden kann. Dabei sollte Wert auf Kompatibilität und größtmögliche Ausnutzung des verwendeten Microcontrollers werden.
+===== Lösungsansatz =====
+DELETEME
+  - Wie wurde das Problem angegangen?
+  - Wieso wurden die genutzten Bauteile und Platinen (z.B. MMC_328PB) verwendet?
+===== Erstellung der Hardware =====
+DELETEME
+  - hier **nicht** Schaltplan / Board darstellen, sondern in den Unterseiten.
+  - Auf was wurde bei der Systemauswahl Wert gelegt? \\ Welche Hürden wurden genommen?
+===== Erstellung der Software =====
+DELETEME
+  - Auf was wurde Wert gelegt? \\ Welche Hürden wurden genommen?
+  - hier sollte auch der Code beschrieben werden, welcher nicht explizit für die genutzte Hardware notwendig ist. Also zum Beispiel bei Spielen, die [[https://de.wikipedia.org/wiki/Spielmechanik|Spielmechanik]] oder bei einer Wetterstation die Aufteilung auf dem Display. In beiden Beispielen wäre die Beschreibung der Bibliothek der Anzeige nicht hier, sondern im Software-Kapitel der Anzeigehardware zu beschreiben.
+===== Überprüfung/Test =====
+DELETEME
+  - Gab es Zwischenschritte / Zwischenergebnisse?
+  - Wurden Testplatinen und/oder Testkonzepte erstellt?
+<wavedrom>
+{signal: [
+  {name: 'clk', wave: 'n.....|...'},
+  {name: 'dat', wave: 'x.x345|=x=', data: ['head', 'body', 'tail', 'data']},
+  {name: 'req', wave: '0.1..0|1.0'},
+  {},
+  {name: 'test', wave: 'HNNLPP|zdu'}
+]}
+</wavedrom>
+{{url>https://wavedrom.com/editor.html}}
+Kurzanleitung zu WaveDrom: [[https://observablehq.com/@drom/wavedrom-ark?collection=@drom/wavedrom]]
+===== Offene Punkte =====
+FIXME
+Bitte verfolgend sie die in Ihrem finalen Stand offenen Punkte (Bugs, fehlende Features, nicht vorgenommene Tests) in der [[https://wiki.mexle.org/doku.php?id=mexle:mexle-modul_template#bekannte_bugs_verbessungsvorschlaege|jeweiligen Seite der einzelnen Platine]]. Im Ausnahmefall (z.B. Architektur-Fehler wie fehlende Platinen) kann auch hier die Liste aus der Platine kopiert und gefüllt werden
+===== Resumee =====
+DELETEME
+  - Fazit für das gesamte System
+  - Verbesserungsvorschläge (Ausblick): Was könnte im Gesamtsystem noch umgesetzt werden?
 ----
@@ Zeile 50: / Zeile 123: @@
   | :     | :      :
   v |     v |      |
-.---+-------+------+-.
+.---+-------+------+--.
-|[BB]Basisboard 3×2  |
+|[BB] Modulträger 3×2 |
-'--------------------'
+'---------------------'
 [BB]: {"a2s:link":"[[:start|The start page]]", "fill":"#88d","a2s:delref":true} </a2s>
@@ Zeile 64: / Zeile 137: @@
 DELETEME Beschreiben Sie kurz, auf welchem Chip / Board die Software läuft. z.B.:
-In diesem Projekt wurde die Platine [[mexle:mmc_1x1_328pb]] verwendet und programmiert.
+In diesem Projekt wurde die Platine [[mexle2020:mmc_1x1_328pb]] verwendet und programmiert.
 ==== Blockbilder ====
@@ Zeile 144: / Zeile 217: @@
 </WRAP>
 </WRAP>
+\\ \\ \\ \\
 ----
-====== Projektübersicht ======
+====== Anhang ======
-===== Aufgabenstellung/Problemstellung =====
-FIXME
+===== A1. Pflichtenheft =====
-Die Aufgabenstellung war eine kompakte Controllerplatine zu erstellen, welche als Basis für unterschiedlichste Projekte genutzt werden kann. Dabei sollte Wert auf Kompatibilität und größtmögliche Ausnutzung des verwendeten Microcontrollers werden.
-===== Pflichtenheft =====
 FIXME
 Das Pflichtenheft in diesem Projekten ist zweigeteilt:
   - Einerseits das tatsächliche Pflichtenheft, bei dem die Projektziele als kurze Aussage mit Beschreibung angegeben werden (erste Tabelle unten)
-  - Andererseits eine Beschreibung der einzelnen Platinen und Softwarekomponenten, welche Sie neu entwickeln. Dabei sind die [[:est_projekt_leitplanken]] zu beachten.
+  - Andererseits eine Beschreibung der einzelnen Platinen und Softwarekomponenten, welche Sie neu entwickeln. Dabei sind die [[elektronik_labor:est_projekt_leitplanken]] zu beachten.
+Das Pflichtenheft ist zwar für die Durchführung und
 {{tablelayout?colwidth="73px,165px,-,75px"&rowsHeaderSource=1&rowsVisible=10&tableSearch=1&tableSort=1}}
@@ Zeile 177: / Zeile 247: @@
 ^ HW-03  | ja             | Joystick-Platine                  | Joystick mit Mikrocontroller, um die Eingabewerte in I2C Daten umzuwandeln                                                                                                     | eigenes Format  |
 | -      | nein           | MmC1x1 328_2.x ATmega328 Platine  | Mikrocontroller-Platine für Motor                                                                                                                                              | MEXLE 1x1       |
-^ SW-01  | ja             | Motoransteuerung                  | Ansteuern des Motortreibers, Einlesen und Ausgeben über I2C                                                                                                                    | C / Cpp              |
+^ SW-01  | ja             | Motoransteuerung                  | Ansteuern des Motortreibers, Einlesen und Ausgeben über I2C                                                                                                                    | C               |
-^ SW-02  | ja             | Menuführung                       | Auswahl zwischen manueller Steuerung                                                                                                                                           | C / Cpp              |
+^ SW-02  | ja             | Menuführung                       | Auswahl zwischen manueller Steuerung                                                                                                                                           | C               |
 ^ SW-03  | ja             | Joystick-Auswertung               | Software, welche die Joystickeingabe in I2C umwandelt                                                                                                                          | C               |
 SW ... Software, HW ... (Elektronik)Hardware
-===== Lösungsansatz =====
+===== A2. Projektberichte =====
-DELETEME
+<WRAP group><WRAP column half>
-  - Wie wurde das Problem angegangen?
+{{tablelayout?rowsHeaderSource=Auto&colwidth="387px"}}
-  - Wieso wurden die genutzten Bauteile und Platinen (z.B. MMC_328PB) verwendet?
+^ Status                                            ^
+| Punkt 1. (Zeilenumbruch mit <Umschalt>+<Return>)  |
+| Punkt 2. (Zeilenumbruch mit <Umschalt>+<Return>)  |
+| Punkt 3. (Zeilenumbruch mit <Umschalt>+<Return>)  |
-===== Erstellung der Hardware =====
+</WRAP><WRAP column half>
-DELETEME
+</WRAP>
-  - hier **nicht** Schaltplan / Board darstellen, sondern in den Unterseiten.
-  - Auf was wurde bei der Systemauswahl Wert gelegt? \\ Welche Hürden wurden genommen?
-===== Erstellung der Software =====
-DELETEME
-  - Auf was wurde Wert gelegt? \\ Welche Hürden wurden genommen?
-  - hier sollte auch der Code beschrieben werden, welcher nicht explizit für die genutzte Hardware notwendig ist. Also zum Beispiel bei Spielen, die [[https://de.wikipedia.org/wiki/Spielmechanik|Spielmechanik]] oder bei einer Wetterstation die Aufteilung auf dem Display. In beiden Beispielen wäre die Beschreibung der Bibliothek der Anzeige nicht hier, sondern im Software-Kapitel der Anzeigehardware zu beschreiben.
-===== Überprüfung/Test =====
-DELETEME
-  - Gab es Zwischenschritte / Zwischenergebnisse?
-  - Wurden Testplatinen und/oder Testkonzepte erstellt?
-<wavedrom>
-{signal: [
-  {name: 'clk', wave: 'n.....|...'},
-  {name: 'dat', wave: 'x.x345|=x=', data: ['head', 'body', 'tail', 'data']},
-  {name: 'req', wave: '0.1..0|1.0'},
-  {},
-  {name: 'test', wave: 'HNNLPP|zdu'}
-]}
-</wavedrom>
-Kurzanleitung zu WaveDrom: [[https://observablehq.com/@drom/wavedrom-ark?collection=@drom/wavedrom]]
-===== Offene Punkte =====
-FIXME
-Bitte verfolgend sie die in Ihrem finalen Stand offenen Punkte (Bugs, fehlende Features, nicht vorgenommene Tests) in der [[https://wiki.mexle.hs-heilbronn.de/doku.php?id=mexle:mexle-modul_template#bekannte_bugs_verbessungsvorschlaege|jeweiligen Seite der einzelnen Platine]]. Im Ausnahmefall (z.B. Architektur-Fehler wie fehlende Platinen) kann auch hier die Liste aus der Platine kopiert und gefüllt werden
-===== Resumee =====
-DELETEME
-  - Fazit für das gesamte System
-  - Verbesserungsvorschläge (Ausblick): Was könnte im Gesamtsystem noch umgesetzt werden?