Numerierungen in der Anleitung
This commit is contained in:
Tristan Krause
parent
28277098cb
commit
9640bb00c8
64 changed files with 98 additions and 98 deletions
|
|
@ -3,6 +3,8 @@
|
|||
# Author: Tristan Krause
|
||||
# Creation Date: 2019-03-22
|
||||
|
||||
# Änderungen veröffentlichen, vorher nochmal: make clean && make && make doc && make clean && make doc && make
|
||||
|
||||
# Environment
|
||||
PATH_COMPILER = g++
|
||||
PATH_DOXYGEN = ../bin/doxygen
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
- Als Student/Studentin können Sie davon ausgehen, dass die Steuersoftware auf Ihrem Arbeitsplatz bereits installiert ist
|
||||
- D.h. Sie müssen zu Beginn jeder Übung nur die Firmware neu aufspielen (Installation Abschnitt 3)
|
||||
|
||||
## Einführung
|
||||
## 1 Einführung
|
||||
Das gesamte Softwareprojekt besteht aus zwei Teilen:
|
||||
Die ***Firmware*** ist die Software auf dem Mikrocontroller (MCU) des Board 15. Der Mikrocontroller steuert die Peripherie (ADCs, DACs, ...) über einen SPI-BUS.
|
||||
|
||||
|
|
@ -12,9 +12,9 @@ Der zweite Teil von B15F ist die ***Steuersoftware***, die auf dem PC ausgeführ
|
|||
Die Steuersoftware besitzt ein *CLI* (command line interface) mit einer Benutzerschnittstelle für die einfache Fernsteuerung des B15F.
|
||||
Außerdem wird eine Bibliothek (*b15fdrv*) installiert, die eine einfache Entwicklung kleiner Steuerprogramme erlaubt.
|
||||
|
||||
## Installation
|
||||
## 2 Installation
|
||||
|
||||
### Installation mit Installationsscript (empfohlen)
|
||||
### 2.1 Installation mit Installationsscript (empfohlen)
|
||||
|
||||
(a) Laden Sie das [Installationsscript](https://raw.githubusercontent.com/devfix/b15f/master/install) herunter, am besten nach **/tmp/**
|
||||
(b) Setzen Sie die Ausführungsberechtigung
|
||||
|
|
@ -22,17 +22,17 @@ Außerdem wird eine Bibliothek (*b15fdrv*) installiert, die eine einfache Entwic
|
|||
(d) Starten Sie das Installationsscript
|
||||
(e) Treten Probleme auf? Das B15F Verzeichnis löschen und das Script nocheinmal starten
|
||||
|
||||
### Installation von Hand (falls Installationsscript mit Fehler abbricht)
|
||||
### 2.2 Installation von Hand (falls Installationsscript mit Fehler abbricht)
|
||||
|
||||
#### 1. Abhängigkeiten installieren
|
||||
#### 2.2.1. Abhängigkeiten installieren
|
||||
(a) APT-Pakete aktualisieren: **sudo apt-get update**
|
||||
(b) Notwendige Pakete installieren bzw. aktualisieren: **sudo apt-get install git avr-libc avrdude libncurses5-dev g++ astyle**
|
||||
|
||||
#### 2. Das Repository klonen
|
||||
#### 2.2.2. Das Repository klonen
|
||||
(a) Home-Verzeichnis betreten: **cd /home/famulus/**
|
||||
(b) B15F-Repository klonen (herunterladen): **git clone "https://github.com/devfix/b15f.git"**
|
||||
|
||||
#### 3. Die Firmware installieren
|
||||
#### 2.2.3. Die Firmware installieren
|
||||
(a) Installations-Verzeichnis betreten: **cd "/home/famulus/b15f/firmware"**
|
||||
(b) Passen Sie in der Datei *Makefile* (im aktuellen Verzeichnis) die Option "MCU = ..." an die MCU des vorliegenden Boards an.
|
||||
**Achtung**: *atmega1284* und *atmega1284p* sind nicht identisch!
|
||||
|
|
@ -48,17 +48,17 @@ ATTR{idVendor}=="03eb", ATTR{idProduct}=="2104", MODE="660", GROUP="dialout"
|
|||
(h) Kompiliere Firmware: **make**
|
||||
(i) Lade Firmware auf das B15: **make upload**
|
||||
|
||||
#### 4. Die Steuersoftware (Bibliothek & CLI) installieren
|
||||
#### 2.2.4. Die Steuersoftware (Bibliothek & CLI) installieren
|
||||
(a) Installations-Verzeichnis betreten: **cd "/home/famulus/b15f/control/src"**
|
||||
(b) Kompiliere Steuersoftware: **make**
|
||||
(c) Installiere die Bibliothek und CLI (global): **sudo make install**
|
||||
|
||||
## Aktualisierung
|
||||
## 3 Aktualisierung
|
||||
|
||||
### Aktualisierung mit Installationsscript (empfohlen)
|
||||
### 3.1 Aktualisierung mit Installationsscript (empfohlen)
|
||||
Wiederholen Sie den Schritt "Installation mit Installationsscript". Das Script erkennt die bereits installierte Version und aktualisiert diese.
|
||||
|
||||
### Aktualisierung von Hand (falls Installationsscript mit Fehler abbricht)
|
||||
### 3.2 Aktualisierung von Hand (falls Installationsscript mit Fehler abbricht)
|
||||
(a) Installations-Verzeichnis betreten: **cd /home/famulus/b15f/**
|
||||
(b) Neuste Software-Version vom GitHub-Server ziehen: **git pull && git pull --prune**
|
||||
(c) Betrete Firmware-Verzeichnis: **cd "/home/famulus/b15f/firmware"**
|
||||
|
|
@ -67,15 +67,15 @@ Wiederholen Sie den Schritt "Installation mit Installationsscript". Das Script e
|
|||
(f) Lösche altes Kompilat der Steuersoftware: **make clean**
|
||||
(g) "Installation von Hand" ab Schritt 3 (h) durchführen
|
||||
|
||||
## Die CommandLineInterface (CLI) benutzen
|
||||
## 4 Die CommandLineInterface (CLI) benutzen
|
||||
(a) Öffnen Sie ein Terminal und maximieren Sie das Fenster
|
||||
(b) Start des CLI erfolgt durch den Befehl **b15fcli**
|
||||
(c) Die Navigation erfolgt durch <Tab>, die Pfeiltasten und <Enter> oder die Maus
|
||||
(d) Mit <Strg + c> kann das Programm sofort verlassen werden
|
||||
|
||||
## Eigene Programme mit der B15F-Bibliothek schreiben
|
||||
## 5 Eigene Programme mit der B15F-Bibliothek schreiben
|
||||
|
||||
### Grundsätzliches
|
||||
### 5.1 Grundsätzliches
|
||||
Verwendet wird die Bibliothekt *b15fdrv*.
|
||||
Die wichtigste Klasse für die Steuerung des Board 15 ist [B15F](https://devfix.github.io/b15f/html/classB15F.html).
|
||||
Dort befindet sich auch eine Übersicht der verfügbaren Befehle.
|
||||
|
|
@ -83,12 +83,12 @@ Dort befindet sich auch eine Übersicht der verfügbaren Befehle.
|
|||
Hinweise zur Struktur (sind für die Verwendung nicht weiter wichtig):
|
||||
Die Header-Dateien sind global unter "/usr/include/b15f/" installiert. Die *b15fdrv*-Bibliothekt befindet sich in dem Verzeichnis "/usr/lib/" und die ausführbaren Programme (plotty, b15fcli) "/usr/bin/".
|
||||
|
||||
### Beispiele
|
||||
### 5.2 Beispiele
|
||||
In dem Verzeichnis [b15f/control/examples](https://github.com/devfix/b15f/tree/master/control/examples) (des Repositories) sind einige Beispiele für die Verwendung einzelner B15F Funktionen.
|
||||
Zu jedem Beispiel gehört eine *main.cpp* mit dem Quellcode und eine *Makefile*-Datei. Durch das Makefile wird beim Kompilieren und Linken die Bibliothek *b15fdrv* automatisch einbezogen.
|
||||
Das Beispiel muss durch Sie also nur mit **make** kompiliert und mit .**/main.elf** gestartet werden.
|
||||
|
||||
### Den B15F Treiber verwenden
|
||||
### 5.3 Den B15F Treiber verwenden
|
||||
Benötigt wird der B15F-Header:
|
||||
`#include <b15f/b15f.h>`
|
||||
und der Header für die plottyfile-Generierung, falls mit Kennlinien gearbeitet werden soll:
|
||||
|
|
@ -100,7 +100,7 @@ Falls noch keine existiert, wird automatisch eine erzeugt und Verbindung zum Boa
|
|||
|
||||
Ab jetzt können auf dem Object `drv` verschiedene Methoden angewand werden, siehe [B15F](https://devfix.github.io/b15f/html/classB15F.html).
|
||||
|
||||
### Kennlinien mit plottyfile generieren
|
||||
### 5.4 Kennlinien mit plottyfile generieren
|
||||
Die Beschreibung zu Plottyfile befindet sich [hier](https://devfix.github.io/b15f/html/classPlottyFile.html).
|
||||
Nach dem Include von plottyfile kann ein neues Objekt erzeugt und konfiguriert werden:
|
||||
```C++
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
#ifndef COMMIT_HASH_H
|
||||
#define COMMIT_HASH_H
|
||||
const char COMMIT_HASH[] = "63bdf77ff2a041e05e0b4a5f0e02225a334eb064";
|
||||
const char COMMIT_HASH[] = "28277098cbdeb228c0fcb0c04394643f6fd15a20";
|
||||
#endif // COMMIT_HASH_H
|
||||
|
|
|
|||
|
|
@ -1,2 +0,0 @@
|
|||
#!/bin/bash
|
||||
make clean && make && make doc && make clean && make doc && make
|
||||
Loading…
Add table
Add a link
Reference in a new issue