VS-Code Espressif IDF

Last Updated on 5. Dezember 2020 by sfambach

Hier möchte ich die Einrichtung der Espressif IDF für VS-Code unter Windows beschreiben. Ich werde die Installation in Form eine Klickanleitung nur kurz umreissen, wer weiterführende Informationen benötig findet diese auf der Espressif und den anderen unten gelinkten Seiten

Fakten

Wir benötigen:

  • ESP IDF (Anleitung gibts HIER )
    • Python
    • IDF
    • Umgebungsvariablen
  • VS-Code Installation (Anleitung gibts HIER )
  • Espressif IDF Plugin für VS-Code

Anwendungsbereiche

  • Programmierung aller ESP32
  • IDF ist aktuell die einzige Möglichkeit ESP32-S2 und ESP32-S3 Chips zu programmieren

Installation

Espressif IDF

Installationsanleitung zur Espressif IDF

VS-Code Portable Version

VS Code Installieren

Espressif IDF Plugin Installieren

VS-Code öffnen, den Paketmanager anwählen, in der Suchzeile „Esp idf“ eingeben und das gefunden Plugin auswählen. Nun mit dem Knopf Install das Plugin installieren.

VS-Code – Plugin suchen und installieren

Espressif IDF konfigurieren

Nach der installation erscheint ein neues Zeichen mit dem Espressif Logo auf der linken Seite. Dieses auswählen. Beim ersten Start sollte die Konfiguration geöffnet werden. (Siehe Kapitel Probleme falls die Seite nicht geöffnet oder später nochmal benötigt wird). Der Knopf Start, beginnt den Konfigurationsprozess.

VS-Code Espressif Konfiguration – Einstieg

Python Version auswählen, und mit dem Check knopf bestätigen.

VS-Code Espressif Konfiguration – Python Auswahl

Mit Bestätigung der „Configure ESP-IDF“ gehts weiter.

VS-Code Espressif Konfiguration – Python Verifikation

Es ist möglich die IDF aus diesem Bildschirm heraus zu installieren. Ich habe dies mit ein paar Versionen versucht, leider ohne Erfolg. Deshalb hatte ich mich dazu enschlossen die IDF vorher zu installieren, um deren Funktion vorab in der Konsole testen zu können. Somit muss hier nur der Inatallationspfad der schon vorhandenen Version angegeben werden. Danch den Click Button betätigen.

VS-Code Espressif Konfiguration – Installierte IDF auswählen

Wenn die IDF gefunden wurde, den Vorgang mit dem GO-Button fortsetzen.

VS-Code Espressif Konfiguration – Ausgewählte IDF Überprüfen

Auch die Tools sind schon installiert, somit geht’s hier mit dem rechten Button weiter.

VS-Code Espressif Konfiguration – Zur Konfiguration wechseln, Installation überspringen

Alle Pfade eintragen und mit dem Button unten bestätigen.

VS-Code Espressif Konfiguration – Pfadeingabe

Jede Box sollte einen Harken haben. Und die beiden Pfade untern sollten ein „zufrieden“ aufweisen 😉

VS-Code Espressif Konfiguration – Verifikation der Pfade

Im Nächten Schritt kann ein Beispiel Programm ausgewählt werden, für uns gehts weiter im Kapitel Programmierung.

Programmierung

Bibliotheken

Die IDF bietet alles was zur Programmierung des ESP selbst nötig ist.

Testprogramm

Entweder als Folgeschritt der Installation oder über das Befehlsmenü ein Tesprogramm aussuchen. Hierzu die F1 Taste drücken, „esp-idf“ in die erscheinende Zeile eintragen und „Show ESP-IDF Examples Projects“ auswählen.

VS-Code Espressif Test – Beispiel Programm Übersicht öffnen

Das Espressif Plugin scheint gerne mit Buttons zu arbeiten um den nächsten Prozess anzutrigger, also beugen wir uns dem zusätzlichen Schritt.

VS-Code Espressif Test – Anzeige bestätigen

Ohne zusätzlichen Bildschirm kommt man dann über das Menü durch die Wahl der Espressif IDF weiter.

VS-Code Espressif Test – IDF Framework wählen

Als ich die Liste zum ersten Mal gesehen habe war ich begeistert. Es gibt sehr viele Beispiele und wir suchen uns für den Einstieg das einfachste mal aus. Die Anderen sind analog dazu zu verwenden. Links auswählen und wieder den Knopf drücken.

VS-Code Espressif Test – Links Projekt wählen und rechts bestätigen

Speicheort auswählen, dies kann ein beliebiges Verzeichnis sein.

VS-Code Espressif Test – Speicherort auswählen

Das Projekt wird angezeigt und muss nun noch für das Board vorbereitet werden.

VS-Code Espressif Test – Erster Blick aufs Projekt, links Dateien

Zielplattform auswählen. Hierfür wieder die F1-Taste drücken, nach „ESP-IDF set“ suchen und den Punkt „Set Espressif device target“ wählen.

VS-Code Espressif Test – Zielplattform setzen

Ich wähle für mein neues Projekt den ESP32-S2 aus.

VS-Code Espressif Test – Wahl der Zielplattform

Das kann einen Moment dauern

VS-Code Espressif Test – Arbeitsnachricht

Da ich schon ein paar Läufe hinter mir habe, ändere ich das Programm noch einwenig ab. So kann ich leicht erkennen ob auch wirklich mein Programm auf das Board geladen wurde.

VS-Code Espressif Test – Code ändern

Board anstecken und die serielle Schnittstelle auswählen, bei mir ist es COM30.

VS-Code Espressif Test – Serielle Schnittstelle wählen

Jetzt das ganze mal bauen (Zylinder Symbol unten links). Sollte es Probleme geben kann über das Bildschirmsymbol der IDF Monitor aktiviert werden. Oberhalb der Konsole kann der Task auf IDF-Build umgeschaltet werden.

VS-Code Espressif Test – Knöpfe links unten und Konsolen wahl rechts
VS-Code Espressif Test – Zylinder = Bauen / Monitor = Konsole

Auch das Bauen dauert …

VS-Code Espressif Test – Bauen in Arbeit Dialog

Im besten Fall erscheint eine Erfolgsnachricht so wie folgende, im schlechtesten Fall passt etwas nicht dann gehts an die Fehlersuche.

VS-Code Espressif Test -Bauen Erfolgsnachricht

Mit dem Blitzsymbol kann das Programm auf das Board geladen werden.

VS-Code Espressif Test – Board flashen

Jetzt wird das Programm auf das Board geschrieben. Bei Erfolg kommt die folgende Nachricht.

VS-Code Espressif Test -Faschen Erfolgsnachricht

Soll ein Fehler (s.u.) bezüglich Monitor kommen, einfach nochmal flashen, der Monitor sollte mit dem Fehler geschlossen worden sein und das Flashen nun funktionieren.

VS-Code Espressif Test – Flashen Fehler Nachricht

Nun den Monitor nochmal starten.

VS-Code Espressif Test – Monitor starten

Im Monitor sollte der gänderte Satz gefunden werden.

VS-Code Espressif Test – Monitor Ausgabe

Das erste Flashen hat geklappt und weitere Hürden können in Angriff genommen werden.

Probleme

Konfigurationsseite öffnet sich nicht

Sollte sich die Konfigurationsseite beim ersten starten des Espressif Plugins nicht erscheinen oder später nochmal benötigt werden, kann diese manuell geöffnet werden.

Die F1 Taste öffnet das Befehlsmenü. Dort „ESP-IDF“ eingeben. Es erscheinen alle Befehle für die Espressiferweiterung. Hier den Befehl Configure ESP-IDF extension auswählen.

VS-Code – Befehlsmenü auswahl der Konfiguration

Danach sollte der Einstiegsbildschirm der Konfigruation erscheinen.

VS-Code – IDF Erweiterung Konfiguration

Config – Requirements not satified

Bei der Konfiguration bricht das Skript ab, und es kommt eine Auflistung von Python modulen deren Version nicht stimmt.

Python requirements are not satified

Den folgenden Befehl eingeben (Pfade bitte entprechend anpassen)

C:\Users\spam\.espressif\python_env\idf4.3_py3.9_env\Scripts\python.exe -m pip install -r c:\Devel\VSCodeEspressifIDF\data\extensions\espressif.esp-idf-extension-0.5.1\esp_debug_adapter\requirements.txt"

Das Skript installiert die richtigen Versionen, danach nochmal den Check-Button drücken und es sollte funktionieren.

Set Target schlägt fehl wegen Build Verzeichnis

Build Verzeichnis löschen und erneut Target setzen.

Prozess kann nicht auf Verzeichnis zugreifen

Schauen ob Dateien oder das Verzeichnis noch anderweitig geöffnet wurde. (Explorer, Notepad … )

Fazit

Wenn man weiss wie es geht ist die Installation einfach und schnell erledigt. Ich habe allerdings einige Anläufe und Tage gebraucht bis es so lief. Entweder hat die Pythonversion nicht gepasst, es fehlte was bei den IDF Sourcen oder die Tools hatten die falsche Version. Dies mag zum einen der neuen ESP32-S2 Umgebung geschuldet sein, kann aber auch am Installationsdesaster auf meinem PC liegen. Mit der getrennten IDF Installation konnte ich das bauen der Sourcen sicherstellen und danach die Fehler in den Pfaden der VS-Code Umgebung suchen.

Verwandte Beiträge

Quellen

Getting Started with Espressif IDF

Github ESP-IDF Extension für VS-Code

Microsoft Market Place ESP-IDF Extension

Beitrag auf Random Tutorials zum Thema

Beitrag auf Instructables zum Thema

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.