Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen Revision Vorhergehende Überarbeitung Nächste Überarbeitung | Vorhergehende Überarbeitung | ||
mexle:template_fuer_die_projektbeschreibung [2020/01/24 01:22] – tfischer | mexle:template_fuer_die_projektbeschreibung [2021/09/14 13:14] (aktuell) – tfischer | ||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
- | ====== | + | ====== |
+ | FIXME | ||
- | <WRAP right> | + | <WRAP right> |
- | + | {{: | |
- | | + | <fs 70%> |
- | + | Dummy-Bild\\ | |
+ | FIXME Source: [[https:// | ||
+ | ([[https:// | ||
+ | </ | ||
</ | </ | ||
- | ^ Ersteller | ??? | | + | ^Ersteller| ??? | |
- | ^ letzte Änderung | Sommersemester 2019 | | + | ^letzte Änderung|Sommersemester 2019| |
- | ^ Kurzbeschreibung | In der Kurzbeschreibung soll \\ die wesentliche Funktion des Projekts in \\ einem Satz zusammengefasst werden | | + | ^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!** | ||
+ | Für die Niederschrift bietet sich folgendes Vorgehen an: | ||
- erst Bilder, Diagramme und Tabellen erstellen und den Kapiteln zuordnen | - erst Bilder, Diagramme und Tabellen erstellen und den Kapiteln zuordnen | ||
- | - dann mit dem Text beginnen! | + | - dann mit dem Text beginnen! |
- Auch Fehler dürfen beschrieben werden | - Auch Fehler dürfen beschrieben werden | ||
- Es sollte soviel beschrieben werden, dass nachfolgende Studierende ohne Rückfragen Ihren Weg und Ziel nachvollziehen können. | - Es sollte soviel beschrieben werden, dass nachfolgende Studierende ohne Rückfragen Ihren Weg und Ziel nachvollziehen können. | ||
- Keine Ich-Form, Emotionen vermeiden! | - Keine Ich-Form, Emotionen vermeiden! | ||
+ | - Mit DELETEME ist Text gekennzeichnet, | ||
+ | - Mit FIXME ist Text gekennzeichnet, | ||
+ | - Tipps zur Wikisyntax finden sich im [[:DokuWiki CheatSheet]] | ||
+ | </ | ||
+ | <WRAP left round important 60%> | ||
+ | DELETEME | ||
+ | |||
+ | Leider hat der "CKG Editor" | ||
+ | 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 " | ||
+ | - links zur vorletzte Version anklicken (Vorversion der aktuellen Version) | ||
+ | - in der Menüleiste rechts auf die " | ||
+ | |||
+ | In ähnlicher Form kann auch vorgegangen werden, wenn versehentlich " | ||
+ | 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. | ||
</ | </ | ||
- | <pagebreak> | + | ~~CLEARFIX~~ |
+ | |||
+ | | ||
+ | |||
+ | ====== Projektübersicht ====== | ||
+ | |||
+ | ===== Aufgabenstellung/ | ||
+ | |||
+ | 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:// | ||
+ | |||
+ | ===== Überprüfung/ | ||
+ | DELETEME | ||
+ | - Gab es Zwischenschritte / Zwischenergebnisse? | ||
+ | - Wurden Testplatinen und/oder Testkonzepte erstellt? | ||
+ | |||
+ | <wavedrom> | ||
+ | {signal: [ | ||
+ | {name: ' | ||
+ | {name: ' | ||
+ | {name: ' | ||
+ | {}, | ||
+ | {name: ' | ||
+ | ]} | ||
+ | </ | ||
+ | |||
+ | {{url> | ||
+ | Kurzanleitung zu WaveDrom: [[https:// | ||
+ | |||
+ | |||
+ | ===== Offene Punkte ===== | ||
+ | FIXME | ||
+ | |||
+ | Bitte verfolgend sie die in Ihrem finalen Stand offenen Punkte (Bugs, fehlende Features, nicht vorgenommene Tests) in der [[https:// | ||
+ | ===== Resumee ===== | ||
+ | DELETEME | ||
+ | - Fazit für das gesamte System | ||
+ | - Verbesserungsvorschläge (Ausblick): Was könnte im Gesamtsystem noch umgesetzt werden? | ||
---- | ---- | ||
+ | |||
====== Hardwareübersicht ====== | ====== Hardwareübersicht ====== | ||
- | <a2s> | + | Die Hardwareübersicht soll einen Überblick über die verwendete Elektronik (und ggf. mechanische Hardware) geben. |
+ | <a2s> | ||
.-------. .-------. | .-------. .-------. | ||
|Sensor | |DRV8835| | |Sensor | |DRV8835| | ||
|Platine| | | | |Platine| | | | ||
- | ' | + | ' |
- | ^ | | + | ^ | |
| : | : | | : | : | ||
v | v | | v | v | | ||
- | .---+-. .----+-. .------. | + | .---+--. .---+-. .------. |
- | |MMC | |MMC | + | | MMC | | MMC | |Power | |
- | |32U4 | |328PB | |Supply| | + | | 32U4 | |328PB| |Supply| |
- | ' | + | '-+-+--' ' |
- | ^ | | | | | + | ^ | ^ | | |
| : | : : | | : | : : | ||
v | v | | | v | v | | | ||
- | .---+-------+------+-. | + | .---+-------+------+--. |
- | |[BB]Basisboard | + | |[BB] Modulträger |
- | ' | + | '---------------------' |
- | [BB]: {" | + | [BB]: {" |
- | </ | ||
- | |||
- | < | ||
===== Neu erstellte Module ===== | ===== Neu erstellte Module ===== | ||
+ | |||
+ | DELETEME Falls es von Ihnen neu erstellte Elektronik-Module gab, so sind diese hier kurz zu beschreiben. Für eine ausführliche Beschreibung wird eine neue Seite für jedes Modul angelegt. | ||
---- | ---- | ||
- | |||
- | < | ||
====== Softwareübersicht ====== | ====== Softwareübersicht ====== | ||
- | In diesem Projekt wurde die Platine [[:mexle: | + | DELETEME Beschreiben Sie kurz, auf welchem Chip / Board die Software läuft. z.B.: |
+ | In diesem Projekt wurde die Platine [[mexle2020: | ||
- | ==== State Machine | + | ==== Blockbilder |
- | <uml> | + | FIXME |
- | [*] –> Init | + | |
- | Init –> [*] | + | |
- | State1 : this is a string | + | |
- | State1 : this is another string | + | |
- | State1 –> State2 | + | |
- | State2 –> [*] | + | |
- | </ | + | |
- | Tipps zum Chart-Plugin: | + | --> Modulblockbild # |
+ | < | ||
+ | [*] -right-> main | ||
- | <WRAP> | + | state "void main(void)" |
+ | state " | ||
+ | main_Init -right-> Programmschleife : Wenn kein Fehler, dann | ||
+ | state " | ||
+ | 10ms : springe zu input | ||
+ | 100ms : springe zu calculate\nspringe zu was anderem | ||
+ | 10ms -down-> input | ||
+ | 100ms -down-> calculate | ||
+ | } | ||
+ | } | ||
- | <WRAP half column> | + | state "void input(void)" |
+ | state "ADC initialisieren" | ||
+ | state " | ||
+ | input1 --> input2 | ||
+ | input1 -left-> ADC_init | ||
+ | } | ||
- | <code C [enable_line_numbers=1, | + | state "void ADC_init(void)" as ADC_init |
- | void main () { | + | |
- | printf (" | + | |
- | exit 0; | + | |
} | } | ||
- | </ | ||
- | </ | + | state "void calculate(void)" |
+ | } | ||
- | <WRAP half column> | + | state "void init_calculate(void)" |
+ | } | ||
+ | calculate--> | ||
+ | </uml> | ||
+ | <uml> | ||
- | Erklärung zum Code: | + | state " |
+ | state "I2C Status auslesen" | ||
+ | state " | ||
+ | TWI1 --> TWI2 | ||
+ | } | ||
- | * '' | + | </ |
- | </WRAP> | + | Tipps zum Chart-Plugin: |
+ | <-- | ||
- | </ | ||
- | ---- | + | --> Statemachine # |
- | <pagebreak> | + | <uml> |
- | ====== Projektübersicht ====== | + | [*] --> Init |
+ | Init --> [*] | ||
+ | State1 : this is a string | ||
+ | State1 : this is another string | ||
- | ===== Aufgabenstellung/Problemstellung ===== | + | State1 --> State2 |
+ | State2 --> [*] | ||
+ | </uml> | ||
- | 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. | + | Tipps zum Chart-Plugin: |
+ | <-- | ||
- | ===== Lösungsansatz ===== | + | < |
+ | <WRAP half column> | ||
+ | <code C [enable_line_numbers=1, start_line_numbers_at=42]> | ||
+ | void main () { | ||
+ | printf (" | ||
+ | exit 0; | ||
+ | } </ | ||
+ | </ | ||
+ | <WRAP half column> | ||
+ | Erklärung zum Code: | ||
+ | * '' | ||
+ | </ | ||
+ | </ | ||
+ | \\ \\ \\ \\ | ||
+ | ---- | ||
- | - Wie wurde das Problem angegangen? | + | ====== Anhang ====== |
- | - Wieso wurden die genutzten Bauteile und Platinen (z.B. MMC_328PB) verwendet? | + | |
- | ===== Erstellung der Hardware | + | ===== A1. Pflichtenheft |
+ | FIXME | ||
- | - hier **nicht** | + | Das Pflichtenheft |
- | - Auf was wurde bei der Systemauswahl Wert gelegt? Welche Hürden wurden genommen? | + | - Einerseits das tatsächliche Pflichtenheft, |
+ | - Andererseits eine Beschreibung | ||
- | ===== Erstellung der Software ===== | + | Das Pflichtenheft ist zwar für die Durchführung und |
- | - Auf was wurde Wert gelegt? Welche Hürden wurden genommen? | + | {{tablelayout?colwidth=" |
- | | + | ^ Nr. ^ Projektziel |
+ | ^ PH-01 | Motor wird angesteuert | ||
+ | ^ PH-02 | Joystick wird eingelesen | ||
+ | ^ PH-03 | Bewegungsablauf wird abgerufen | ||
+ | ^ PH-04 | Kamera erzeugt Bilder | ||
+ | ^ PH-05 | Speicherung | ||
- | ===== Überprüfung/ | + | PH ... Pflichtenheft |
- | - Gab es Zwischenschritte / Zwischenergebnisse? | + | {{tablelayout?rowsHeaderSource=1& |
- | - Wurden Testplatinen | + | ^ Nr. ^ neuentwickelt |
+ | ^ HW-01 | ja | Spannungswandler-Platine | ||
+ | ^ HW-02 | ja | Motortreiber-Platine | ||
+ | ^ HW-03 | ja | Joystick-Platine | ||
+ | | - | nein | MmC1x1 328_2.x ATmega328 Platine | ||
+ | ^ SW-01 | ja | Motoransteuerung | ||
+ | ^ SW-02 | ja | Menuführung | ||
+ | ^ SW-03 | ja | Joystick-Auswertung | ||
- | < | + | SW ... Software, HW ... (Elektronik)Hardware |
- | {name: ' | + | |
- | {name: ' | + | |
- | {name: ' | + | |
- | {}, | + | |
- | {name: ' | + | |
- | ]} </ | + | ===== A2. Projektberichte ===== |
- | Kurzanleitung zu WaveDrom: [[https:// | + | <WRAP group>< |
- | + | {{tablelayout? | |
- | ===== Resumee ===== | + | ^ Status |
- | + | | Punkt 1. (Zeilenumbruch mit < | |
- | ==== Fazit ==== | + | | Punkt 2. (Zeilenumbruch mit < |
- | + | | Punkt 3. (Zeilenumbruch mit < | |
- | nur für die einzelne Platine. Das Abschlussfazit sollte auf der Projekt-Seite stehen. | + | |
- | ==== bekannte Bugs / Verbessungsvorschläge ==== | + | |
- | + | ||
- | - Welche Fehler sind auf der Platine / in der Software bekannt? | + | |
- | - Verbesserungsvorschläge (Ausblick): Was könnte im Gesamtsystem noch umgesetzt werden? | + | |
- | + | ||
- | {{tablelayout? | + | |
- | ^ Nr. ^ Bug/ | + | |
- | ^ Iss-01 | + | |
- | ^ Iss-02 | + | |
- | ^ Iss-03 | + | |
- | ^ Iss-04 | + | |
- | ^ Iss-05 | + | |
+ | </ | ||
+ | </ |