docu aktualisiert

This commit is contained in:
Tristan Krause 2019-06-18 10:51:58 +02:00
parent e9fc26d8a3
commit db39ec0f4b
59 changed files with 83 additions and 73 deletions

View file

@ -81,17 +81,22 @@ Außerdem wird eine Bibliothek (<em>b15fdrv</em>) installiert, die eine einfache
<h1><a class="anchor" id="autotoc_md2"></a>
Installation</h1>
<h2><a class="anchor" id="autotoc_md3"></a>
1. Abhängigkeiten installieren</h2>
Installation mit Installationsscript (empfohlen)</h2>
<p>(a) Laden Sie das <a href="https://raw.githubusercontent.com/devfix/b15f/master/install">Installationsscript</a> herunter (b) Setzen Sie die Ausführungsberechtigung (c) Starten Sie das Script</p>
<h2><a class="anchor" id="autotoc_md4"></a>
Installation von Hand (falls Installationsscript mit Fehler abbricht)</h2>
<h3><a class="anchor" id="autotoc_md5"></a>
1. Abhängigkeiten installieren</h3>
<p>(a) <b>sudo apt-get update</b> <br />
(b) <b>sudo apt-get install git avr-libc avrdude libncurses5-dev g++ astyle</b> <br />
</p>
<h2><a class="anchor" id="autotoc_md4"></a>
2. Das Repository klonen</h2>
<h3><a class="anchor" id="autotoc_md6"></a>
2. Das Repository klonen</h3>
<p>(a) <b>cd /home/famulus/</b> <br />
(b) <b>git clone "https://github.com/devfix/b15f.git"</b> <br />
</p>
<h2><a class="anchor" id="autotoc_md5"></a>
3. Die Firmware installieren</h2>
<h3><a class="anchor" id="autotoc_md7"></a>
3. Die Firmware installieren</h3>
<p>(a) <b>cd "/home/famulus/b15f/firmware"</b> <br />
(b) Passen Sie in der Datei <em>Makefile</em> die Option "MCU = ..." an die MCU des vorliegenden Boards an <br />
(<em>atmega1284</em> und <em>atmega1284p</em> sind nicht identisch!) <br />
@ -101,41 +106,46 @@ Installation</h1>
Sonst: <br />
(d II) <b>sudo make upload</b> <br />
</p>
<h2><a class="anchor" id="autotoc_md6"></a>
4. Die Steuersoftware (Bibliothek &amp; CLI) installieren</h2>
<h3><a class="anchor" id="autotoc_md8"></a>
4. Die Steuersoftware (Bibliothek &amp; CLI) installieren</h3>
<p>(a) <b>cd "/home/famulus/b15f/control/src"</b> <br />
(b) <b>make</b> <br />
(Die Warnungen durch doxygen können ignoriert werden.)</p>
<p>(c) <b>sudo make install</b> <br />
</p>
<h1><a class="anchor" id="autotoc_md7"></a>
<h1><a class="anchor" id="autotoc_md9"></a>
Aktualisierung</h1>
<h2><a class="anchor" id="autotoc_md10"></a>
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>
<p>(a) <b>cd /home/famulus/b15f/</b> <br />
(b) <b>git pull &ndash;prune</b> <br />
(c) <b>cd "/home/famulus/b15f/firmware"</b> <br />
(d) <b>make clean</b> <br />
(e) <b>cd "/home/famulus/b15f/control/src"</b> <br />
(f) <b>make clean</b> <br />
(g) Installation ab Schritt 3 wiederholen</p>
<h1><a class="anchor" id="autotoc_md8"></a>
(g) "Installation von Hand" ab Schritt 3 durchführen</p>
<h1><a class="anchor" id="autotoc_md12"></a>
Die CommandLineInterface (CLI) benutzen</h1>
<p>(a) Öffnen Sie ein Terminal und maximieren Sie das Fenster <br />
(b) Start des CLI erfolgt durch <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_md9"></a>
<h1><a class="anchor" id="autotoc_md13"></a>
Eigene Programme mit B15F schreiben</h1>
<h2><a class="anchor" id="autotoc_md10"></a>
<h2><a class="anchor" id="autotoc_md14"></a>
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 />
</p>
<h2><a class="anchor" id="autotoc_md11"></a>
<h2><a class="anchor" id="autotoc_md15"></a>
Beispiele</h2>
<p>In dem Verzeichnis <a href="https://github.com/devfix/b15f/tree/master/control/examples">b15f/control/examples</a> 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_md12"></a>
<h2><a class="anchor" id="autotoc_md16"></a>
Den B15F Treiber verwenden</h2>
<p>Benötigt wird der B15F-Header: <br />
<code>#include &lt;b15f/b15f.h&gt;</code> <br />
@ -146,7 +156,7 @@ und der Header für die plottyfile-Generierung, falls mit Kennlinien gearbeitet
Falls noch keine existiert, wird automatisch eine erzeugt und Verbindung zum Board hergestellt. <br />
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_md13"></a>
<h2><a class="anchor" id="autotoc_md17"></a>
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 />
@ -157,7 +167,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 Tue Jun 18 2019 10:44:44 for B15F by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Tue Jun 18 2019 10:51:48 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>