183 lines
12 KiB
HTML
183 lines
12 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.16"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>B15F: B15F Benutzerhandbuch</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">B15F
|
|
</div>
|
|
<div id="projectbrief">Board 15 Famulus Edition</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.16 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="PageDoc"><div class="header">
|
|
<div class="headertitle">
|
|
<div class="title"><a class="el" href="classB15F.html">B15F</a> Benutzerhandbuch </div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><p><em>Hinweise</em>: <br />
|
|
- Terminal-Befehle sind <b>fett</b> gedruckt <br />
|
|
- Als Student/Studentin können Sie davon ausgehen, dass die Steuersoftware auf Ihrem Arbeitsplatz bereits installiert ist <br />
|
|
- 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>
|
|
<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>
|
|
<h2><a class="anchor" id="autotoc_md3"></a>
|
|
Installation mit Installationsscript (empfohlen)</h2>
|
|
<p>(a) Laden Sie das <a href="https://raw.githubusercontent.com/devfix/b15f/master/install">Installationsscript</a> herunter <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 />
|
|
(d) Starten Sie das Installationsscript <br />
|
|
</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) 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>
|
|
<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>
|
|
<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 />
|
|
(c) Fügen Sie den Nutzer <em>famulus</em> zu Gruppe <em>dialout</em> hinzu: <b>sudo adduser famulus dialout</b> <br />
|
|
(d) Schreiben Sie (mit root-Rechten) Folgendes in die Datei */etc/udev/rules.d/60-olimex.rules*: <br />
|
|
</p><div class="fragment"><div class="line">ATTR{idVendor}=="03eb", ATTR{idProduct}=="2104", MODE="660", GROUP="dialout"</div></div><!-- fragment --><p> Damit wird per udev-rule der Zugriff auf das ISP-Programmiergerät ohne root-Rechte erlaubt. <br />
|
|
(e) Laden Sie die udev-Regeln neu ein: <b>sudo udevadm control –reload-rules</b> <br />
|
|
(f) Stoße Verarbeitung der udev-Regeln an: <b>sudo udevadm trigger</b> <br />
|
|
(g) Programmiergerät rausziehen, drei Sekunden warten, wieder hineinstecken <br />
|
|
(h) Kompiliere Firmware: <b>make</b> <br />
|
|
(i) Lade Firmware auf das B15: <b>make upload</b> <br />
|
|
</p>
|
|
<h3><a class="anchor" id="autotoc_md8"></a>
|
|
4. Die Steuersoftware (Bibliothek & 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>
|
|
<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) Installations-Verzeichnis betreten: <b>cd /home/famulus/b15f/</b> <br />
|
|
(b) Neuste Software-Version vom GitHub-Server ziehen: <b>git pull && git pull –prune</b> <br />
|
|
(c) Betrete Firmware-Verzeichnis: <b>cd "/home/famulus/b15f/firmware"</b> <br />
|
|
(d) Lösche altes Kompilat der Firmware: <b>make clean</b> <br />
|
|
(e) Betrete Steuersoftware-Verzeichnis: <b>cd "/home/famulus/b15f/control/src"</b> <br />
|
|
(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>
|
|
<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 <Tab>, die Pfeiltasten und <Enter> oder die Maus <br />
|
|
(d) Mit <Strg + c> kann das Programm sofort verlassen werden</p>
|
|
<h1><a class="anchor" id="autotoc_md13"></a>
|
|
Eigene Programme mit der B15F-Bibliothek schreiben</h1>
|
|
<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 />
|
|
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>
|
|
<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>
|
|
<p>Benötigt wird der B15F-Header: <br />
|
|
<code>#include <b15f/b15f.h></code> <br />
|
|
und der Header für die plottyfile-Generierung, falls mit Kennlinien gearbeitet werden soll: <br />
|
|
<code>#include <b15f/plottyfile.h></code></p>
|
|
<p>Für die Interaktion wird eine Referenz auf die aktuelle Treiberinstanz benötigt: <br />
|
|
<code><a class="el" href="classB15F.html">B15F</a>& drv = <a class="el" href="classB15F.html#a8b4533d232c55ef2aa967e39e2d23380">B15F::getInstance()</a>;</code> <br />
|
|
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_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 />
|
|
</p><div class="fragment"><div class="line"> {C++}</div><div class="line">PlottyFile pf; </div><div class="line">pf.setUnitX("V"); </div><div class="line">pf.setUnitY("V"); </div><div class="line">pf.setUnitPara("V"); </div><div class="line">pf.setDescX("U_{OUT}"); // Markdown wird unterstuetzt </div><div class="line">pf.setDescY("U_{IN}"); </div><div class="line">pf.setDescPara(""); </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 />
|
|
Dabei gehören Punkte mit dem gleichen Index für <code>curve</code> (<em>uint8_t</em>) zur selben Kurve und erhalten durch Plotty automatisch die gleiche Farbe. <br />
|
|
</p><div class="fragment"><div class="line"> {C++}</div><div class="line">pf.addDot(Dot(x, y, curve));</div></div><!-- fragment --><p> <em>Wichtig</em>: Die Werte für <code>x</code> und <code>y</code> sind <em>uint16_t</em>, also keine Gleitkommazahlen. Stattdessen sind sie auf RefX und RefY bezogen. </p>
|
|
</div></div><!-- PageDoc -->
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Mon Jul 8 2019 21:09:34 for B15F by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.16
|
|
</small></address>
|
|
</body>
|
|
</html>
|