Softwareprojekt anlegen

Die entwickelte Experimentier-Leiterplatte soll nun durch verschiedene Testprogramme geprüft werden. Als Entwicklungumgebung wird Microsoft Visual Studio Code ("VSCode") eingesetzt. Die Installation und Grundkonfiguration des Programms ist bereits erfolgt, so wird nun mit Hilfe des Erweiterungstools PlatformIO ein neues Projekt angelegt. Die Abbildung zeigt die Projektstruktur unmittelbar nach Erstellen des neuen Softwareprojekts:

Strukturierung des Projekts

Die von PlatformIO erstellten Ordner und Einzeldateien haben folgende Bedeutung:

-- .pio
Dieser Ordner wird automatisch von PlatformIO erstellt und enthält z. B. kompilierten Code, temporäre Dateien u.a.
Bei jedem Build wird der Inhalt neu erstellt.

-- .vscode
VSCode-spezifische Einstellungen, insbesondere für das aktuelle Projekt, z.B. in den Datei settings.json, launch.json,  tasks.json.

-- include
Hier befinden sich Header-Dateien (.h), die im gesamten Projekt verwendet werden können.
z.B. Konfigurations-Header, Funktionsprototypen, globale Definitionen

-- lib
Ordner für eigene Bibliotheken, die selbst entwickelt oder modifiziert werden. Jede Bibliothek hat meist einen eigenen Unterordner:
 lib/
└── TestLib/
├── TestLib.cpp
└── TestLib.h
Diese Bibliotheken werden automatisch eingebunden.

-- src
Enthält den Hauptprogrammcode des Projekts. Die Standarddatei ist main.cpp Weitere .cpp-Dateien sind möglich.

-- test
Optional zu verwendender Ordner für Unit-Tests des Codes, z. B. mit dem Unity-Test-Framework, das PlatformIO unterstützt.

.gitignore
Die Datei legt fest, welche Dateien nicht in ein Git-Repository übernommen werden sollen.

platform.ini
Dies ist die zentrale Konfigurationsdatei des Projekts.
- Ziel-Plattform (z. B. esp32, atmelavr)
- verwendetes Board
- Bibliotheken
- Build-Flags
- serielle Schnittstelle
- ...

Einstellung für den Seriellen Monitor

Durch Ergänzung der platform.ini wird sichergestellt, dass der Datenaustausch zwischen ESP32-MCU und VSCode mit einheitlicher Bitrate funktioniert.

Git-Hub Versionsverwaltung

Für größere Softwareprojekte ist es empfehlenswert mit einer Versionsverwaltung (z.B. Git) zu arbeiten.
Deshalb wird nach Initialisieren des Projekts bei Git zunächst aus dem originalen Hauptzweig ein neuer Arbeits-Branch angelegt und benannt (hier "Grundfunktionen").

Die Einstellungen werden commitet und auch gleich als privates Repository bei Git-Hib veröffentlicht.