ESP32 Firmware¶

Die ESP32 Firmware kann in mehreren Varianten für verschiedenen Geräte gebaut werden:

Die Firmware ist in C/C++ programmiert und der Quelltext ist frei auf GitHub verfügbar. Als Basis dienen das Arduino ESP32 Projekt und PlatformIO.

Vorbereitung¶

Zuerst müssen uv (mindestens Version 0.10), und git anhand der Anleitung des jeweiligen Projekts installiert werden.

Zusätzlich müssen auf Windows Node.js (mindestens Version 20) und der Node.js Package Manager npm (mindestens Version 9) installiert werden.

Für Windows muss der Silicon Labs CP210x Universal Windows Driver installiert werden. Linux und macOS bringen diesen Treiber schon von sich aus mit.

Die ESP32 Firmware beinhaltet einige Datein mit sehr langen Dateinamen. Diese können die veraltet Windows Beschänkung von maximal 260 Zeichen überschreiten. Es wird empfohlen die Unterstützung für lange Dateinamen in Windows zu aktivieren.

Dann das esp32-firmware Repository von GitHub mittels git clonen.

Als IDE with Visual Studio Code mit der PlatformIO IDE Erweiterung empfohlen.

Zur initialen Einrichtung muss z.B. im Terminal in Visual Studio Code der Befehl uv sync im software/ Verzeichnis ausgeführt werden.

Damit Visual Studio Code die uv-Umgebung richtig benutzt, müssen folgende Einstellungen (Strg+,) geändert werden:

python-envs.terminal.autoActivationType auf shellStartup umstellen
platformio-ide.customPATH auf den absoluten Pfad zum software/.venv/bin/ Verzeichnis (Linux und macOS) bzw. auf den absoluter Pfad zum software/.venv/Scripts/ Verzeichnis (Windows)
platformio-ide.useBuiltinPIOCore auf false
platformio-ide.useBuiltinPython auf false

Danach einmal Visual Studio Code neustarten.

Falls die PlatformIO IDE Erweiterung Fehler meldet, dann kann es helfen das .platformio/ Verzeichnis im Home-Verzeichnis zu löschen und Visual Studio Code neuzustarten.

Die platformio.ini Datei befindet sich im software/ Verzeichnis. Achte darauf das software/ Verzeichnis in Visual Studio Code als Projekt-Verzeichnis zu öffnen um eine der Umgebungen zu bauen (build).

Firmware bauen¶

Die Standard-PlatformIO-Umgebung ist auf empty gesetzt und erzeugt keine nützliche Firmware. Abhängig von der zu bauenden Variante der Firmware muss die entsprechenden PlatformIO-Umgebung gewählt werden:

ESP32 Brick: esp32 definiert in esp32.ini
ESP32 Ethernet Brick: esp32_ethernet definiert in esp32_ethernet.ini
WARP Charger Smart und Pro: warp definiert in warp.ini
WARP2 Charger Smart und Pro: warp2 definiert in warp2.ini
WARP3 Charger Smart und Pro: warp3 definiert in warp3.ini
WARP Energy Manager: energy_manager definiert in energy_manager.ini
WARP Energy Manager 2.0: energy_manager_v2 definiert in energy_manager_v2.ini

Um die entsprechende Firmware zu bauen muss dann die PlatformIO "Build" Aufgabe ausgeführt werden. Es kann aber auch die Standard-PlatformIO-Umgebung in der platformio.ini Datei von empty auf die gewünschte Umgebung geändert werden. Zum Beispiel empty durch esp32_ethernet in dieser Zeile ersetzen, um standardmäßig die ESP32 Ethernet Brick Firmware zu bauen:

default_envs = empty

Um die Firmware in einem Schritt zu bauen, auf den Brick hochzuladen und eine Verbindung zur seriellen Konsole herzustellen kann die PlatformIO "Upload and Monitor" Aufgabe ausgeführt werden. Dazu muss der Brick vorher per USB angeschlossen werden. Alternativ kann die gebaute Firmware über das Webinterface hochgeladen werden.

Die Firmware-Datei befindet sich im Verzeichnis software/build/ und endet auf _merged.bin. Der Aufbau des Dateinamens ist wie folgt: [Umgebung]_firmware_[Versionsnummer]_[Bauzeitpunkt][Endung], zum Beispiel ist warp2_firmware_2_0_7_62d7d0b1_merged.bin eine Firmware für den WARP2 Charger mit der Version 2.0.7, die am Unix Timestamp 0x62d7d0b1 = 1658310833, also am 20.07.2022 13:27:02 gebaut wurde.

Struktur der Firmware¶

Die Funktionalität und das Webinterface der Firmware sind aus Modulen zusammengesetzt. Die verschiedenen Varianten der Firmware unterscheiden sich hauptsächlich durch die aktiven Module. Die Liste der aktiven Module wird in der jeweligen .ini Datei für jede Umgebung durch die Optionen custom_backend_modules und custom_frontend_modules festgelegt.

Das Tutorial zur ESP32 Firmware zeigt Schritt für Schritt wie die Standard-Firmware um ein eigenes Modul erweitert werden kann.