Espressif IDF – Menuconfig

Last Updated on 8. Januar 2021 by sfambach

Eine der schönen Erungenschaften der IDF ist die Menü gesteuerte Konfiguration. Noch schöner finde ich, dass eigenen Konfiguratiospunkte erstellt werden können. Diese werden dann automatisch in das Haupt Menü eingehängt. Vorab:

  • Die Biliothek „esp_system.h“ wird im Quellcode benötigt sonst klappts nicht
  • Nach Änderungen am Menü ein idf.py clean durchführen

Zur Erstellung solch eines Konfigurationspunktes nehme ich das Programm aus dem Beipiel Konsolenausgabe und ersetze den Text durch einen Konfigruationspunkt. Benannt werden diese grundsätzlich mit CONFIG_ , gefolgt von einen sprechenden Namen.

Damit diese Konfiguration im Menuconfig angezeigt wird, muss noch eine Datei "Kconfig.projbuild" erstellt werden. Diese enthält zusätzliche Informationen zum Konfigurationspunkt:

nun einmal Menuconfig Starten (>idf.py menuconfig) :

Noch bauen und schauen wie es aussieht (idf.py build flash -p COM7 monitor )

Ausgabe mit konfiguriertem Text.

Es gibt nicht nur die Möglichkeit Text zu formatieren, Zahlen und Auswahlisten sind ebenfalls möglich. Hier ein paar Beipiele

menu "Example Configuration"
config MOSI_GPIO
		int "MOSI GPIO number"
		range 0 46
		default 23 if IDF_TARGET_ESP32
		default 35 if IDF_TARGET_ESP32S2
		help
		    GPIO number (IOxx) to SPI MOSI. ...

config INVERSION
		bool "Enable Display Inversion"
		default false
		help
		    Enable Display Inversion.
		
choice
        bool "Mesh AP Authentication Mode"
        default WIFI_AUTH_WPA2_PSK
        help
            Authentication mode.

        config WIFI_AUTH_OPEN
            bool "WIFI_AUTH_OPEN"
        config WIFI_AUTH_WPA_PSK
            bool "WIFI_AUTH_WPA_PSK"
        config WIFI_AUTH_WPA2_PSK
            bool "WIFI_AUTH_WPA2_PSK"
        config WIFI_AUTH_WPA_WPA2_PSK
            bool "WIFI_AUTH_WPA_WPA2_PSK"
endchoice

config MESH_GLOBAL_DNS_IP
        hex "Global DNS"
        depends on MESH_USE_GLOBAL_DNS_IP
        default 0x08080808
        help
            The IP address of global DNS server that is used
            for internal IP subnet formed by the mesh network
            if MESH_USE_GLOBAL_DNS_IP is enabled.
            Note: The IP address is in platform (not network)
            format.
...

endmenu

Es sind auch Abhängigkeiten zwischen Kondifgurations Punkten möglich. Diese werden mit dem Schlüsselwörtern "depends on" gefolgt von einem oder mehreren Konfigurationsname mit logischen verknüpfungen. Logische Verknüpfungen sind || (oder) oder && (und).

... 
config SW1_PIN
		int "SW1 pin"
		range 0 39
        default 36
		depends on SW1_ENABLE
		help 
			Switch 1 Gpio pin
config SW2_ENABLE
		bool "SW2 Enable"
        default false
		help 
			Enable Switch 2
config SW2_PIN
		int "SW2 pin"
		range 0 39
        default 35
		depends on SW2_ENABLE
		help 
			SW2 Gpio pin
config LONG_PRESS_ENABLED
		bool "Long press enabled"
        default false
		depends on (SW1_ENABLE || SW2_ENABLE)
		help 
		   If this is enabled the system 
		   distinguishes between long pressed buttons
                   and short pressed buttons
	config LONG_PRESS_TIME_MS
		int "Long press time ms"
		range 1000 8000
        default 2000
		depends on LONG_PRESS_ENABLED
		help 
		  How long should the a button be pressed to be
                  marked as a long pess	if it is not long pressed 
                  it is a short press
...

Fazit

Die Idee Konfigurationen auszulagern ist nicht neu. Sie aber mit eine Menü zu versehen finde ich sehr charmant gelöst.

Verwandte Beiträge

Hauptbeitrag

Quellen

IDF - Konfiguration

KConfig Anleitung

KConfig Erweiterungen

2 Gedanken zu „Espressif IDF – Menuconfig

  1. Hallo Jürgen,

    wie im Impressum steht mache ich keine Anleitungen für Anfänger sondern dokumentiere nur was ich mir selbst erarbeite. Ich denke Profies brauchen diese Anleitung nicht. Ich bin aber gerne bereit Anpassungen/Ergänzungen vorzunehmen wenn du mir genau schreibst an welcher Stelle es hapert.

    Zur Veranschaulichung der Projektstruktur ist ein Beispielprojekt auf GitHub gelinkt, in dem alle nötigen Dateien an der passenden Position sind. Reicht das nicht? Was kann ich hier besser machen?

    Dein Kommentar ist zu einem Bericht über die Anwendung der Menuconfig über die Konsole, wo spielt da VSCode mit rein? Ja die Bedienung geht auch mit VSCode aber hier auf Basis eines Menüs das mit der Mouse bedient wird. Allerdings ist es auch bei mir so, dass VSCode an einem Tag funktioniert und mit der nächsten Version schon wieder nicht. Deshalb würde erstmal versuchen die IDF auf der Konsole (CMD) zum laufen zu bringen.

    NCurses Menüs wurden/werden oft unter Linux (o.ä. in der Window Konsole) verwendet deshalb bin ich hier nicht mehr näher darauf eingegangen. Im Grunde brauchst du nur Enter um in ein Untermenü zu kommen oder einen Menüpunkt zu bearbeiten und Esc um wieder heraus zu kommen. Die Pfeiltasten helfen beim navigieren, evtl noch Tab zum springen bzw. s zum speichern.

    Die IDF ist definitiv schon mal nicht sonderlich geeignet für Anfänger, leider kommt man an ihr für neue ESPs nicht vorbei, da die Implementierung auf für die Arduino Gui immer etwas hinterherhinkt. Ansonsten würde ich empfehlen als Anfänger die Arduino Gui zu verwenden.

    Gruß
    Stefan

  2. Hallo,

    Ihre Begeisterung für menuconfig kann ich nicht teilen.

    Klar, lässt sich die aus VS Ciode/PlatformIO heraus aufrufen. Der Irrsinn fängt damit an, dass unten einige Tastaturkürzel stehen, die wichtigsten (j und k) aber nicht.

    Und so simpel, einfach eine „kconfig.projbuild“ erstellen und menuconfig starten, ist es auch nicht. Wo muss die denn stehen, damit sie erkannt wird?

    Es gibt eine Taste „o“ zum Laden, aber in dem erscheinenden Fenster funktionieren nicht einmal j und k. Also wie zum Pfad navigieren, wo die kconfig.projbuild steht?

    Ihr Blog scheint eher für Profis gedacht zu sein, die schon alles wissen. Als Anfänger wühlt man sich nur stundenlang durchs Internet, auch die Doku von Espressif ist wenig hilfreich.

    Grüße

Schreibe einen Kommentar

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