Numerierungen in der Anleitung

This commit is contained in:
Tristan Krause 2019-07-31 11:34:23 +02:00
parent 28277098cb
commit 9640bb00c8
64 changed files with 98 additions and 98 deletions

View file

@ -72,16 +72,16 @@ $(function() {
- D.h. Sie müssen zu Beginn jeder Übung nur die Firmware neu aufspielen (Installation Abschnitt 3) <br />
</p>
<h1><a class="anchor" id="autotoc_md1"></a>
Einführung</h1>
1 Einführung</h1>
<p>Das gesamte Softwareprojekt besteht aus zwei Teilen: <br />
Die <em><b>Firmware</b></em> ist die Software auf dem Mikrocontroller (MCU) des Board 15. Der Mikrocontroller steuert die Peripherie (ADCs, DACs, ...) über einen SPI-BUS. <br />
Der zweite Teil von <a class="el" href="classB15F.html">B15F</a> ist die <em><b>Steuersoftware</b></em>, die auf dem PC ausgeführt wird. Diese sendet über eine USART-Schnittstelle (RS-232) Befehle an den Mikrocontroller. <br />
Die Steuersoftware besitzt ein <em>CLI</em> (command line interface) mit einer Benutzerschnittstelle für die einfache Fernsteuerung des <a class="el" href="classB15F.html">B15F</a>. <br />
Außerdem wird eine Bibliothek (<em>b15fdrv</em>) installiert, die eine einfache Entwicklung kleiner Steuerprogramme erlaubt.</p>
<h1><a class="anchor" id="autotoc_md2"></a>
Installation</h1>
2 Installation</h1>
<h2><a class="anchor" id="autotoc_md3"></a>
Installation mit Installationsscript (empfohlen)</h2>
2.1 Installation mit Installationsscript (empfohlen)</h2>
<p>(a) Laden Sie das <a href="https://raw.githubusercontent.com/devfix/b15f/master/install">Installationsscript</a> herunter, am besten nach **/tmp/** <br />
(b) Setzen Sie die Ausführungsberechtigung <br />
(c) Schalten Sie die Stromversorgung von B15 an und schließen Sie den ISP Programmer an <br />
@ -89,19 +89,19 @@ Installation mit Installationsscript (empfohlen)</h2>
(e) Treten Probleme auf? Das <a class="el" href="classB15F.html">B15F</a> Verzeichnis löschen und das Script nocheinmal starten <br />
</p>
<h2><a class="anchor" id="autotoc_md4"></a>
Installation von Hand (falls Installationsscript mit Fehler abbricht)</h2>
2.2 Installation von Hand (falls Installationsscript mit Fehler abbricht)</h2>
<h3><a class="anchor" id="autotoc_md5"></a>
1. Abhängigkeiten installieren</h3>
2.2.1. Abhängigkeiten installieren</h3>
<p>(a) APT-Pakete aktualisieren: <b>sudo apt-get update</b> <br />
(b) Notwendige Pakete installieren bzw. aktualisieren: <b>sudo apt-get install git avr-libc avrdude libncurses5-dev g++ astyle</b> <br />
</p>
<h3><a class="anchor" id="autotoc_md6"></a>
2. Das Repository klonen</h3>
2.2.2. Das Repository klonen</h3>
<p>(a) Home-Verzeichnis betreten: <b>cd /home/famulus/</b> <br />
(b) B15F-Repository klonen (herunterladen): <b>git clone "https://github.com/devfix/b15f.git"</b> <br />
</p>
<h3><a class="anchor" id="autotoc_md7"></a>
3. Die Firmware installieren</h3>
2.2.3. Die Firmware installieren</h3>
<p>(a) Installations-Verzeichnis betreten: <b>cd "/home/famulus/b15f/firmware"</b> <br />
(b) Passen Sie in der Datei <em>Makefile</em> (im aktuellen Verzeichnis) die Option "MCU = ..." an die MCU des vorliegenden Boards an. <br />
<b>Achtung</b>: <em>atmega1284</em> und <em>atmega1284p</em> sind nicht identisch! <br />
@ -115,18 +115,18 @@ Installation von Hand (falls Installationsscript mit Fehler abbricht)</h2>
(i) Lade Firmware auf das B15: <b>make upload</b> <br />
</p>
<h3><a class="anchor" id="autotoc_md8"></a>
4. Die Steuersoftware (Bibliothek &amp; CLI) installieren</h3>
2.2.4. Die Steuersoftware (Bibliothek &amp; CLI) installieren</h3>
<p>(a) Installations-Verzeichnis betreten: <b>cd "/home/famulus/b15f/control/src"</b> <br />
(b) Kompiliere Steuersoftware: <b>make</b> <br />
(c) Installiere die Bibliothek und CLI (global): <b>sudo make install</b> <br />
</p>
<h1><a class="anchor" id="autotoc_md9"></a>
Aktualisierung</h1>
3 Aktualisierung</h1>
<h2><a class="anchor" id="autotoc_md10"></a>
Aktualisierung mit Installationsscript (empfohlen)</h2>
3.1 Aktualisierung mit Installationsscript (empfohlen)</h2>
<p>Wiederholen Sie den Schritt "Installation mit Installationsscript". Das Script erkennt die bereits installierte Version und aktualisiert diese.</p>
<h2><a class="anchor" id="autotoc_md11"></a>
Aktualisierung von Hand (falls Installationsscript mit Fehler abbricht)</h2>
3.2 Aktualisierung von Hand (falls Installationsscript mit Fehler abbricht)</h2>
<p>(a) Installations-Verzeichnis betreten: <b>cd /home/famulus/b15f/</b> <br />
(b) Neuste Software-Version vom GitHub-Server ziehen: <b>git pull &amp;&amp; git pull &ndash;prune</b> <br />
(c) Betrete Firmware-Verzeichnis: <b>cd "/home/famulus/b15f/firmware"</b> <br />
@ -135,26 +135,26 @@ Aktualisierung von Hand (falls Installationsscript mit Fehler abbricht)</h2>
(f) Lösche altes Kompilat der Steuersoftware: <b>make clean</b> <br />
(g) "Installation von Hand" ab Schritt 3 (h) durchführen</p>
<h1><a class="anchor" id="autotoc_md12"></a>
Die CommandLineInterface (CLI) benutzen</h1>
4 Die CommandLineInterface (CLI) benutzen</h1>
<p>(a) Öffnen Sie ein Terminal und maximieren Sie das Fenster <br />
(b) Start des CLI erfolgt durch den Befehl <b>b15fcli</b> <br />
(c) Die Navigation erfolgt durch &lt;Tab&gt;, die Pfeiltasten und &lt;Enter&gt; oder die Maus <br />
(d) Mit &lt;Strg + c&gt; kann das Programm sofort verlassen werden</p>
<h1><a class="anchor" id="autotoc_md13"></a>
Eigene Programme mit der B15F-Bibliothek schreiben</h1>
5 Eigene Programme mit der B15F-Bibliothek schreiben</h1>
<h2><a class="anchor" id="autotoc_md14"></a>
Grundsätzliches</h2>
5.1 Grundsätzliches</h2>
<p>Verwendet wird die Bibliothekt <em>b15fdrv</em>. Die wichtigste Klasse für die Steuerung des Board 15 ist <a href="https://devfix.github.io/b15f/html/classB15F.html">B15F</a>. <br />
Dort befindet sich auch eine Übersicht der verfügbaren Befehle. <br />
Hinweise zur Struktur (sind für die Verwendung nicht weiter wichtig): <br />
Die Header-Dateien sind global unter "/usr/include/b15f/" installiert. Die <em>b15fdrv</em>-Bibliothekt befindet sich in dem Verzeichnis "/usr/lib/" und die ausführbaren Programme (plotty, b15fcli) "/usr/bin/".</p>
<h2><a class="anchor" id="autotoc_md15"></a>
Beispiele</h2>
5.2 Beispiele</h2>
<p>In dem Verzeichnis <a href="https://github.com/devfix/b15f/tree/master/control/examples">b15f/control/examples</a> (des Repositories) sind einige Beispiele für die Verwendung einzelner <a class="el" href="classB15F.html">B15F</a> Funktionen. <br />
Zu jedem Beispiel gehört eine <em>main.cpp</em> mit dem Quellcode und eine <em>Makefile</em>-Datei. Durch das Makefile wird beim Kompilieren und Linken die Bibliothek <em>b15fdrv</em> automatisch einbezogen. <br />
Das Beispiel muss durch Sie also nur mit <b>make</b> kompiliert und mit .**/main.elf** gestartet werden.</p>
<h2><a class="anchor" id="autotoc_md16"></a>
Den B15F Treiber verwenden</h2>
5.3 Den B15F Treiber verwenden</h2>
<p>Benötigt wird der B15F-Header: <br />
<code>#include &lt;b15f/b15f.h&gt;</code> <br />
und der Header für die plottyfile-Generierung, falls mit Kennlinien gearbeitet werden soll: <br />
@ -165,7 +165,7 @@ Falls noch keine existiert, wird automatisch eine erzeugt und Verbindung zum Boa
Ab jetzt können auf dem Object <code>drv</code> verschiedene Methoden angewand werden, siehe <a href="https://devfix.github.io/b15f/html/classB15F.html">B15F</a>. <br />
</p>
<h2><a class="anchor" id="autotoc_md17"></a>
Kennlinien mit plottyfile generieren</h2>
5.4 Kennlinien mit plottyfile generieren</h2>
<p>Die Beschreibung zu Plottyfile befindet sich <a href="https://devfix.github.io/b15f/html/classPlottyFile.html">hier</a>. <br />
Nach dem Include von plottyfile kann ein neues Objekt erzeugt und konfiguriert werden: <br />
</p><div class="fragment"><div class="line"> {C++}</div><div class="line">PlottyFile pf; </div><div class="line">pf.setUnitX(&quot;V&quot;); </div><div class="line">pf.setUnitY(&quot;V&quot;); </div><div class="line">pf.setUnitPara(&quot;V&quot;); </div><div class="line">pf.setDescX(&quot;U_{OUT}&quot;); // Markdown wird unterstuetzt </div><div class="line">pf.setDescY(&quot;U_{IN}&quot;); </div><div class="line">pf.setDescPara(&quot;&quot;); </div><div class="line">pf.setRefX(5); </div><div class="line">pf.setRefY(5); </div><div class="line">pf.setParaFirstCurve(0); </div><div class="line">pf.setParaStepWidth(0);</div></div><!-- fragment --><p> Messpunkte können anschließend hinzugefügt werden. <br />
@ -175,7 +175,7 @@ Dabei gehören Punkte mit dem gleichen Index für <code>curve</code> (<em>uint8_
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jul 31 2019 11:26:28 for B15F by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Wed Jul 31 2019 11:33:44 for B15F by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>