Legosortiermaschine gesamte Anlage - Versionsgeschichte

Madlen Bartnick am 30. Januar 2019 um 12:46 Uhr

2019-01-30T12:46:35Z

← Nächstältere Version		Version vom 30. Januar 2019, 14:46 Uhr
Zeile 11:		Zeile 11:
	!Beschreibung der Spezifikation		!Beschreibung der Spezifikation
	!Arbeitsergebnis		!Arbeitsergebnis
	\|- ~~1 Inbetriebnahmeprotokoll "Eidhoff,~~		\|-
	~~Brandt, Bartnick" Madlen Bartnick MS3 erledigt Prof. Schneider 05.10.18~~
	\|-		\|-
	\| 0057		\| 0057
Zeile 676:		Zeile 675:
	<br/>		<br/>
	<br/>		<br/>
	[[Datei: Übersicht der Dokumentationen.jpg \| ~~800px~~ \| thumb \| zentriert\| Abbildung 7: Übersicht der Dokumentationen]]		[[Datei: Übersicht der Dokumentationen.jpg \| 750px \| thumb \| zentriert\| Abbildung 7: Übersicht der Dokumentationen]]

Madlen Bartnick am 30. Januar 2019 um 12:40 Uhr

2019-01-30T12:40:02Z

← Nächstältere Version		Version vom 30. Januar 2019, 14:40 Uhr
Zeile 11:		Zeile 11:
	!Beschreibung der Spezifikation		!Beschreibung der Spezifikation
	!Arbeitsergebnis		!Arbeitsergebnis
			\|- 1 Inbetriebnahmeprotokoll "Eidhoff,
			Brandt, Bartnick" Madlen Bartnick MS3 erledigt Prof. Schneider 05.10.18
			\|-
			\| 0057
			\| REQ10.2041
			\| Sicherheit/ Gefährdungsbeurteilung
			\| Schaltschrank verdrahten
			\| [http://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/22_Pruefprotokolle/Inbetriebnahmeprotokoll.docx Inbetriebnahmeprotokoll]
	\|-		\|-
	\| 0010		\| 0010
Zeile 99:		Zeile 107:
	\| REQ10.2060		\| REQ10.2060
	\| Verarbeitungszeit		\| Verarbeitungszeit
	\| > 80 Legoteile in 10min		\| > 120 Legoteile in 10min
			\|[http://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/02_Versuchsprotokolle/Protokoll%20Verarbeitungsrate.xlsx Protokoll Verarbeitungsrate]
	\|-		\|-
	\| 0320		\| 0320
Zeile 105:		Zeile 114:
	\| Ablagestruktur für Versionsverwaltung		\| Ablagestruktur für Versionsverwaltung
	\| Geeignete Struktur für SVN definieren und einrichten		\| Geeignete Struktur für SVN definieren und einrichten
			\|
	\|-		\|-
	\| 0330		\| 0330
Zeile 110:		Zeile 120:
	\| Dokumentation		\| Dokumentation
	\| Projektergebnisse nachvollziehbar und nachbaubar darstellen für fachversierte Nutzer		\| Projektergebnisse nachvollziehbar und nachbaubar darstellen für fachversierte Nutzer
	\|		\| [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/%C3%9Cbersicht%20der%20Dokumentationen.xlsx Übersicht Dokumentationen]
	\|-		\|-
	\| 0520.1		\| 0520.1
Zeile 663:		Zeile 673:


	Die Ergebnisse des Projektes wurden, wie in Spezifikation 0330 gefordert, nachvollziehbar und nachbaubar dokumentiert. Die gesamten Dateien und Unterlagen zur Dokumentation sind strukturiert in [https://svn.hshl.de/usvn/project/MTR_SDE_Praktikum_2015/browser SVN] gesichert und versioniert. Abbildung 7 zeigt eine [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/%C3%9Cbersicht%20der%20Dokumentationen.xlsx Übersicht der Dokumentationen], die im ~~SS18~~ anzufertigen waren. Mit Hilfe der dort dargestellten Tabelle wurde die Vollständigkeit sowie der Fortschritt der Dokumentation überprüft.		Die Ergebnisse des Projektes wurden, wie in Spezifikation 0330 gefordert, nachvollziehbar und nachbaubar dokumentiert. Die gesamten Dateien und Unterlagen zur Dokumentation sind strukturiert in [https://svn.hshl.de/usvn/project/MTR_SDE_Praktikum_2015/browser SVN] gesichert und versioniert. Abbildung 7 zeigt eine [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/%C3%9Cbersicht%20der%20Dokumentationen.xlsx Übersicht der Dokumentationen], die im WS18/19 anzufertigen waren. Mit Hilfe der dort dargestellten Tabelle wurde die Vollständigkeit sowie der Fortschritt der Dokumentation überprüft.
	<br/>		<br/>
	<br/>		<br/>

Jerome Wolf: /* MATLAB Dokumentation */

2019-01-29T20:44:35Z

MATLAB Dokumentation

← Nächstältere Version		Version vom 29. Januar 2019, 22:44 Uhr
Zeile 630:		Zeile 630:
	[[Datei:M2html_Index.png \| thumb \| left \| Abbildung 4: m2html Übersicht]]		[[Datei:M2html_Index.png \| thumb \| left \| Abbildung 4: m2html Übersicht]]
	[[Datei:M2html_Funktionsbeispiel.png \| right \| thumb \| Abbildung 5: m2html Funktionsbeispiel]]		[[Datei:M2html_Funktionsbeispiel.png \| right \| thumb \| Abbildung 5: m2html Funktionsbeispiel]]
	Die MATLAB Dokumentation wurde mit [https://www.artefact.tk/software/matlab/m2html/ m2html] erstellt. Es handelt sich dabei um ein doxygen-ähnliches Werkzeug, welches die Quelldateien eines Projektes automatisch analysiert und eine im Webbrowser benutzbare Dokumentation erstellt. Hierbei werden für jede Quelldatei Funktionsname, Kopf, Eingabe- und Ausgabeparameter, sowie Zugriffe von und auf andere Funktionen im Projekt untersucht und übersichtlich dargestellt. Zu den Funktionszugriffen wird optional auch ein Graph erstellt, wie in ABB gezeigt. Da das Tool für eine sehr alte MATLAB-Version geschrieben wurde, sind einige Funktionen, unter anderem die Benutzeroberfläche zur einfachen Bedienung nicht mehr vollständig benutzbar. Zudem musste der Algorithmus zur Code-Analyse an einigen Stellen leicht abgeändert werden, um mit den neu erstellten [[Richtlinien zur Codegestaltung]] zu funktionieren. Weitere Änderungen können falls nötig in [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/06_MATLAB/06_Dokumentation_mit_m2html/m2html/private/mfileparse.m mfileparse.m] vorgenommen werden. Die [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/06_MATLAB/06_Dokumentation_mit_m2html/m2html_Anleitung.txt Anleitung] sowie ein kurzes [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/06_MATLAB/06_Dokumentation_mit_m2html/m2html_Anleitung_Video.mp4 Bedienungs- und Demovideo] sind im SVN zu finden.		Die MATLAB Dokumentation wurde mit [https://www.artefact.tk/software/matlab/m2html/ m2html] erstellt. Es handelt sich dabei um ein doxygen-ähnliches Werkzeug, welches die Quelldateien eines Projektes automatisch analysiert und eine im Webbrowser benutzbare Dokumentation erstellt. Hierbei werden für jede Quelldatei Funktionsname, Kopf, Eingabe- und Ausgabeparameter, sowie Zugriffe von und auf andere Funktionen im Projekt untersucht und übersichtlich dargestellt. Zu den Funktionszugriffen wird optional auch ein Graph erstellt, wie in ABB gezeigt. Da das Tool für eine sehr alte MATLAB-Version geschrieben wurde, sind einige Funktionen, unter anderem die Benutzeroberfläche zur einfachen Bedienung nicht mehr vollständig benutzbar. Zudem musste der Algorithmus zur Code-Analyse an einigen Stellen leicht abgeändert werden, um mit den neu erstellten [[#Richtlinien zur Codegestaltung \| Richtlinien zur Codegestaltung]] zu funktionieren. Weitere Änderungen können falls nötig in [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/06_MATLAB/06_Dokumentation_mit_m2html/m2html/private/mfileparse.m mfileparse.m] vorgenommen werden. Die [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/06_MATLAB/06_Dokumentation_mit_m2html/m2html_Anleitung.txt Anleitung] sowie ein kurzes [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/06_MATLAB/06_Dokumentation_mit_m2html/m2html_Anleitung_Video.mp4 Bedienungs- und Demovideo] sind im SVN zu finden.

	Nach der Erstellung der Dokumentation kann diese mit dem öffnen der [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/06_MATLAB/06_Dokumentation_mit_m2html/Doc/index.html index.html] im [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/06_MATLAB/06_Dokumentation_mit_m2html/Doc Dokumentationsordner] eingesehen werden. Die Übersicht sowie eine beispielhafte Funktionsinformation sind im folgenden in Abbildung 4 bzw. 5 dargestellt.		Nach der Erstellung der Dokumentation kann diese mit dem öffnen der [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/06_MATLAB/06_Dokumentation_mit_m2html/Doc/index.html index.html] im [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/06_MATLAB/06_Dokumentation_mit_m2html/Doc Dokumentationsordner] eingesehen werden. Die Übersicht sowie eine beispielhafte Funktionsinformation sind im folgenden in Abbildung 4 bzw. 5 dargestellt.

Jerome Wolf: /* Code Reviews */

2019-01-29T20:06:49Z

Code Reviews

@@ Zeile 358: / Zeile 358: @@
 [[Datei:Codereview_Beispiel_Legoteilmaschine.png | 700px | thumb | rechts | Abbildung 2: Beispiel eines Code-Reviews mit neuem Template]]
 Gegen Ende des Projektzeitraums wurden für alle nennenswert veränderten Dateien des Projektes Code-Reviews durchgeführt. Dabei wurde in Anlehnung an ein vorhandenes Hella-Template ein neues, für den Umfang des Projektes besser geeignetes, neues Template erstellt. In diesem befindet sich neben den allgemeinen Projektdaten und dem Ergebnis der Analyse eine Checkliste, mit welcher Schritt für Schritt die einzelnen Dateien und Funktionen untersucht werden können.
 <ref name="Autor: Wolf"> Autor Jerome Wolf</ref>

Jerome Wolf: /* Code Reviews */

2019-01-29T19:55:53Z

Code Reviews

← Nächstältere Version		Version vom 29. Januar 2019, 21:55 Uhr
Zeile 356:		Zeile 356:

	== Code Reviews ==		== Code Reviews ==
	[[Datei:Codereview_Beispiel_Legoteilmaschine.png \| ~~800px~~ \| thumb \| rechts \| Abbildung 2: Beispiel eines Code-Reviews mit neuem Template]]		[[Datei:Codereview_Beispiel_Legoteilmaschine.png \| 700px \| thumb \| rechts \| Abbildung 2: Beispiel eines Code-Reviews mit neuem Template]]
	Gegen Ende des Projektzeitraums wurden für alle nennenswert veränderten Dateien des Projektes Code-Reviews durchgeführt. Dabei wurde in Anlehnung an ein vorhandenes Hella-Template ein neues, für den Umfang des Projektes besser geeignetes, neues Template erstellt. In diesem befindet sich neben den allgemeinen Projektdaten und dem Ergebnis der Analyse eine Checkliste, mit welcher Schritt für Schritt die einzelnen Dateien und Funktionen untersucht werden können.		Gegen Ende des Projektzeitraums wurden für alle nennenswert veränderten Dateien des Projektes Code-Reviews durchgeführt. Dabei wurde in Anlehnung an ein vorhandenes Hella-Template ein neues, für den Umfang des Projektes besser geeignetes, neues Template erstellt. In diesem befindet sich neben den allgemeinen Projektdaten und dem Ergebnis der Analyse eine Checkliste, mit welcher Schritt für Schritt die einzelnen Dateien und Funktionen untersucht werden können.

Jerome Wolf: /* Dokumentation */

2019-01-29T19:55:20Z

Dokumentation

← Nächstältere Version		Version vom 29. Januar 2019, 21:55 Uhr
Zeile 614:		Zeile 614:


	Die Ergebnisse des Projektes wurden, wie in Spezifikation 0330 gefordert, nachvollziehbar und nachbaubar dokumentiert. Die gesamten Dateien und Unterlagen zur Dokumentation sind strukturiert in [https://svn.hshl.de/usvn/project/MTR_SDE_Praktikum_2015/browser SVN] gesichert und versioniert. Abbildung 6 zeigt eine [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/%C3%9Cbersicht%20der%20Dokumentationen.xlsx Übersicht der Dokumentationen], die im SS18 anzufertigen waren. Mit Hilfe der dort dargestellten Tabelle wurde die Vollständigkeit sowie der Fortschritt der Dokumentation überprüft.		Die Ergebnisse des Projektes wurden, wie in Spezifikation 0330 gefordert, nachvollziehbar und nachbaubar dokumentiert. Die gesamten Dateien und Unterlagen zur Dokumentation sind strukturiert in [https://svn.hshl.de/usvn/project/MTR_SDE_Praktikum_2015/browser SVN] gesichert und versioniert. Abbildung 7 zeigt eine [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/%C3%9Cbersicht%20der%20Dokumentationen.xlsx Übersicht der Dokumentationen], die im SS18 anzufertigen waren. Mit Hilfe der dort dargestellten Tabelle wurde die Vollständigkeit sowie der Fortschritt der Dokumentation überprüft.
	<br/>		<br/>
	<br/>		<br/>
	[[Datei: Übersicht der Dokumentationen.jpg \| 800px \| thumb \| zentriert\| Abbildung 6: Übersicht der Dokumentationen]]		[[Datei: Übersicht der Dokumentationen.jpg \| 800px \| thumb \| zentriert\| Abbildung 7: Übersicht der Dokumentationen]]

Jerome Wolf: /* Software Dokumentation */

2019-01-29T19:54:59Z

Software Dokumentation

← Nächstältere Version		Version vom 29. Januar 2019, 21:54 Uhr
Zeile 515:		Zeile 515:
	== Allgemeine Informationen ==		== Allgemeine Informationen ==
	<br>		<br>
	[[Datei:PAP-Beispiel.JPG\|250px\|thumb\|rechts\|Abbildung 2: Beispiel PAP]]		[[Datei:PAP-Beispiel.JPG\|250px\|thumb\|rechts\|Abbildung 3: Beispiel PAP]]
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
Zeile 546:		Zeile 546:


	Für den Ablauf der Legosortiermaschine wurde mit der Software PAP-Designer ein Ablaufplan erstellt. In der neben stehenden Abbildung 2 ist ein Auszug zu sehen.		Für den Ablauf der Legosortiermaschine wurde mit der Software PAP-Designer ein Ablaufplan erstellt. In der neben stehenden Abbildung 3 ist ein Auszug zu sehen.

	Das Dokument ist unter folgendem Link abrufbar:		Das Dokument ist unter folgendem Link abrufbar:
Zeile 579:		Zeile 579:


	[[Datei:M2html_Index.png \| thumb \| left \| Abbildung 3: m2html Übersicht]]		[[Datei:M2html_Index.png \| thumb \| left \| Abbildung 4: m2html Übersicht]]
	[[Datei:M2html_Funktionsbeispiel.png \| right \| thumb \| Abbildung 4: m2html Funktionsbeispiel]]		[[Datei:M2html_Funktionsbeispiel.png \| right \| thumb \| Abbildung 5: m2html Funktionsbeispiel]]
	Die MATLAB Dokumentation wurde mit [https://www.artefact.tk/software/matlab/m2html/ m2html] erstellt. Es handelt sich dabei um ein doxygen-ähnliches Werkzeug, welches die Quelldateien eines Projektes automatisch analysiert und eine im Webbrowser benutzbare Dokumentation erstellt. Hierbei werden für jede Quelldatei Funktionsname, Kopf, Eingabe- und Ausgabeparameter, sowie Zugriffe von und auf andere Funktionen im Projekt untersucht und übersichtlich dargestellt. Zu den Funktionszugriffen wird optional auch ein Graph erstellt, wie in ABB gezeigt. Da das Tool für eine sehr alte MATLAB-Version geschrieben wurde, sind einige Funktionen, unter anderem die Benutzeroberfläche zur einfachen Bedienung nicht mehr vollständig benutzbar. Zudem musste der Algorithmus zur Code-Analyse an einigen Stellen leicht abgeändert werden, um mit den neu erstellten [[Richtlinien zur Codegestaltung]] zu funktionieren. Weitere Änderungen können falls nötig in [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/06_MATLAB/06_Dokumentation_mit_m2html/m2html/private/mfileparse.m mfileparse.m] vorgenommen werden. Die [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/06_MATLAB/06_Dokumentation_mit_m2html/m2html_Anleitung.txt Anleitung] sowie ein kurzes [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/06_MATLAB/06_Dokumentation_mit_m2html/m2html_Anleitung_Video.mp4 Bedienungs- und Demovideo] sind im SVN zu finden.		Die MATLAB Dokumentation wurde mit [https://www.artefact.tk/software/matlab/m2html/ m2html] erstellt. Es handelt sich dabei um ein doxygen-ähnliches Werkzeug, welches die Quelldateien eines Projektes automatisch analysiert und eine im Webbrowser benutzbare Dokumentation erstellt. Hierbei werden für jede Quelldatei Funktionsname, Kopf, Eingabe- und Ausgabeparameter, sowie Zugriffe von und auf andere Funktionen im Projekt untersucht und übersichtlich dargestellt. Zu den Funktionszugriffen wird optional auch ein Graph erstellt, wie in ABB gezeigt. Da das Tool für eine sehr alte MATLAB-Version geschrieben wurde, sind einige Funktionen, unter anderem die Benutzeroberfläche zur einfachen Bedienung nicht mehr vollständig benutzbar. Zudem musste der Algorithmus zur Code-Analyse an einigen Stellen leicht abgeändert werden, um mit den neu erstellten [[Richtlinien zur Codegestaltung]] zu funktionieren. Weitere Änderungen können falls nötig in [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/06_MATLAB/06_Dokumentation_mit_m2html/m2html/private/mfileparse.m mfileparse.m] vorgenommen werden. Die [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/06_MATLAB/06_Dokumentation_mit_m2html/m2html_Anleitung.txt Anleitung] sowie ein kurzes [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/06_MATLAB/06_Dokumentation_mit_m2html/m2html_Anleitung_Video.mp4 Bedienungs- und Demovideo] sind im SVN zu finden.

	Nach der Erstellung der Dokumentation kann diese mit dem öffnen der [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/06_MATLAB/06_Dokumentation_mit_m2html/Doc/index.html index.html] im [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/06_MATLAB/06_Dokumentation_mit_m2html/Doc Dokumentationsordner] eingesehen werden. Die Übersicht sowie eine beispielhafte Funktionsinformation sind im folgenden in Abbildung 3 bzw. 4 dargestellt.		Nach der Erstellung der Dokumentation kann diese mit dem öffnen der [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/06_MATLAB/06_Dokumentation_mit_m2html/Doc/index.html index.html] im [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/06_MATLAB/06_Dokumentation_mit_m2html/Doc Dokumentationsordner] eingesehen werden. Die Übersicht sowie eine beispielhafte Funktionsinformation sind im folgenden in Abbildung 4 bzw. 5 dargestellt.

	== Arduino Dokumentation ==		== Arduino Dokumentation ==

	[[Datei:Serielle_Steuerung_PAP.jpg \| thumb \| right \| Abbildung 5: PAP der Seriellen Steuerung]]		[[Datei:Serielle_Steuerung_PAP.jpg \| thumb \| right \| Abbildung 6: PAP der Seriellen Steuerung]]

	{\| class="wikitable"		{\| class="wikitable"
Zeile 604:		Zeile 604:
	\|}		\|}

	Die Arduino Dokumentation beschränkt sich auf eine einzelne Datei, welche die via USB empfangenen seriellen Daten auswertet und die jeweiligen Elemente der Maschine entsprechend ansteuert. Da sich somit keine komplexen Zusammenhänge zwischen verschiedenen Dateien im Programm ergeben, wurde für den Code mithilfe von PapDesigner ein genauer Ablaufplan in PapDesigner erstellt. Das Ergebnis ist in Abbildung 5 zu sehen.		Die Arduino Dokumentation beschränkt sich auf eine einzelne Datei, welche die via USB empfangenen seriellen Daten auswertet und die jeweiligen Elemente der Maschine entsprechend ansteuert. Da sich somit keine komplexen Zusammenhänge zwischen verschiedenen Dateien im Programm ergeben, wurde für den Code mithilfe von PapDesigner ein genauer Ablaufplan in PapDesigner erstellt. Das Ergebnis ist in Abbildung 6 zu sehen.

Jerome Wolf: /* Code Reviews */

2019-01-29T19:53:55Z

Code Reviews

← Nächstältere Version		Version vom 29. Januar 2019, 21:53 Uhr
Zeile 356:		Zeile 356:

	== Code Reviews ==		== Code Reviews ==
	[[Datei:Codereview_Beispiel_Legoteilmaschine.png \| 800px \| thumb \| ~~links~~ \| Abbildung 2: Beispiel eines Code-Reviews mit neuem Template]]		[[Datei:Codereview_Beispiel_Legoteilmaschine.png \| 800px \| thumb \| rechts \| Abbildung 2: Beispiel eines Code-Reviews mit neuem Template]]
	Gegen Ende des Projektzeitraums wurden für alle nennenswert veränderten Dateien des Projektes Code-Reviews durchgeführt. Dabei wurde in Anlehnung an ein vorhandenes Hella-Template ein neues, für den Umfang des Projektes besser geeignetes, neues Template erstellt. In diesem befindet sich neben den allgemeinen Projektdaten und dem Ergebnis der Analyse eine Checkliste, mit welcher Schritt für Schritt die einzelnen Dateien und Funktionen untersucht werden können.		Gegen Ende des Projektzeitraums wurden für alle nennenswert veränderten Dateien des Projektes Code-Reviews durchgeführt. Dabei wurde in Anlehnung an ein vorhandenes Hella-Template ein neues, für den Umfang des Projektes besser geeignetes, neues Template erstellt. In diesem befindet sich neben den allgemeinen Projektdaten und dem Ergebnis der Analyse eine Checkliste, mit welcher Schritt für Schritt die einzelnen Dateien und Funktionen untersucht werden können.

Jerome Wolf: /* Richtlinien zur Codegestaltung */

2019-01-29T19:52:55Z

Richtlinien zur Codegestaltung

← Nächstältere Version		Version vom 29. Januar 2019, 21:52 Uhr
Zeile 208:		Zeile 208:

	=Richtlinien zur Codegestaltung=		=Richtlinien zur Codegestaltung=

			== Übersicht über die Richtlinien ==

	Die Softwarekomponenten der Legoteil-Zählmaschine wurden in MATLAB und Arduino C implementiert. Um den Entwicklungsprozess zu vereinfachen mussten zunächst formalen Guidelines überarbeitet werden.		Die Softwarekomponenten der Legoteil-Zählmaschine wurden in MATLAB und Arduino C implementiert. Um den Entwicklungsprozess zu vereinfachen mussten zunächst formalen Guidelines überarbeitet werden.
	Diese legen die formelle und syntaktische Gestaltung des im Rahmen des Praktikums erzeugten Codes fest.		Diese legen die formelle und syntaktische Gestaltung des im Rahmen des Praktikums erzeugten Codes fest.
Zeile 350:		Zeile 353:
	[[Datei:Codeedit.jpg \| 1000px \| thumb \| zentriert\| Abbildung 1: Ausschnitt aus der Analysetabelle]]		[[Datei:Codeedit.jpg \| 1000px \| thumb \| zentriert\| Abbildung 1: Ausschnitt aus der Analysetabelle]]

	Eine komplette [https://svn.hshl.de/usvn/project/MTR_SDE_Praktikum_2015/show/trunk/Dokumentation/28_Software_Analyse/Analyse_MATLAB.xlsx Liste mit allen überarbeiteten und gelöschten Dateien] sowie [https://svn.hshl.de/usvn/project/MTR_SDE_Praktikum_2015/show/trunk/Dokumentation/28_Software_Analyse/Variablenumbenennung.xlsx Informationen zu den Umbenennungen] sind im SVN zu finden. Eine erneute Überarbeitung ~~der~~ Header aufgrund wiederholter Anpassungen steht noch aus. ~~Auch~~ Code Reviews wurden ~~aufgrund~~ des ~~Arbeitsaufwandes durch~~ die ~~Überarbeitung~~ und ~~den geringen Programmierfortschritt der anderen Teilteams noch nicht durchgeführt~~.		Eine komplette [https://svn.hshl.de/usvn/project/MTR_SDE_Praktikum_2015/show/trunk/Dokumentation/28_Software_Analyse/Analyse_MATLAB.xlsx Liste mit allen überarbeiteten und gelöschten Dateien] sowie [https://svn.hshl.de/usvn/project/MTR_SDE_Praktikum_2015/show/trunk/Dokumentation/28_Software_Analyse/Variablenumbenennung.xlsx Informationen zu den Umbenennungen] sind im SVN zu finden. Eine erneute Überarbeitung aller Header aufgrund wiederholter Anpassungen steht noch aus. Die tatsächlich bearbeiteten Dateien wurden im Verlaufe des Projektes entsprechend angepasst.

			== Code Reviews ==
			[[Datei:Codereview_Beispiel_Legoteilmaschine.png \| 800px \| thumb \| links \| Abbildung 2: Beispiel eines Code-Reviews mit neuem Template]]
			Gegen Ende des Projektzeitraums wurden für alle nennenswert veränderten Dateien des Projektes Code-Reviews durchgeführt. Dabei wurde in Anlehnung an ein vorhandenes Hella-Template ein neues, für den Umfang des Projektes besser geeignetes, neues Template erstellt. In diesem befindet sich neben den allgemeinen Projektdaten und dem Ergebnis der Analyse eine Checkliste, mit welcher Schritt für Schritt die einzelnen Dateien und Funktionen untersucht werden können.

	<ref name="Autor: Wolf"> Autor Jerome Wolf</ref>		<ref name="Autor: Wolf"> Autor Jerome Wolf</ref>


	=SVN=		=SVN=

Jerome Wolf: /* Arduino Dokumentation */

2019-01-29T19:29:45Z

Arduino Dokumentation

← Nächstältere Version		Version vom 29. Januar 2019, 21:29 Uhr
Zeile 582:		Zeile 582:

	[[Datei:Serielle_Steuerung_PAP.jpg \| thumb \| right \| Abbildung 5: PAP der Seriellen Steuerung]]		[[Datei:Serielle_Steuerung_PAP.jpg \| thumb \| right \| Abbildung 5: PAP der Seriellen Steuerung]]

			{\| class="wikitable"
			\|-
			!Spezifikations-ID
			!Anforderungs-ID
			!Anforderungstitel
			!Beschreibung der Spezifikation
			!Arbeitsergebnis
			\|-
			\| 0530
			\| REQ10.3310
			\| Dokumentation von Software
			\| Geeignete Software zur Dokumentation des Quellcodes (zb LaTeX oder Doxygen)
			\| [https://svn.hshl.de/svn/MTR_SDE_Praktikum_2015/trunk/Dokumentation/10_Arduino_Software/PAP_Dokumentation_Codeablauf.pap Arduino mit PapDesigner]
			\|}

	Die Arduino Dokumentation beschränkt sich auf eine einzelne Datei, welche die via USB empfangenen seriellen Daten auswertet und die jeweiligen Elemente der Maschine entsprechend ansteuert. Da sich somit keine komplexen Zusammenhänge zwischen verschiedenen Dateien im Programm ergeben, wurde für den Code mithilfe von PapDesigner ein genauer Ablaufplan in PapDesigner erstellt. Das Ergebnis ist in Abbildung 5 zu sehen.		Die Arduino Dokumentation beschränkt sich auf eine einzelne Datei, welche die via USB empfangenen seriellen Daten auswertet und die jeweiligen Elemente der Maschine entsprechend ansteuert. Da sich somit keine komplexen Zusammenhänge zwischen verschiedenen Dateien im Programm ergeben, wurde für den Code mithilfe von PapDesigner ein genauer Ablaufplan in PapDesigner erstellt. Das Ergebnis ist in Abbildung 5 zu sehen.