ESPEasy – eigene oder zusätzliche Plugins einbinden

Die Beliebtheit und die Verbreitung von ESPEasy steigt immer mehr. Es gibt immer mehr Plugins für ESPEasy. Sie es offizielle Plugins oder Plugins von Drittanbietern. Genau um diese wird es in diesem Beitrag gehen. Ich möchte euch zeigen, wir ihr diese in ESPEasy am einfachsten einbindet.

Dieser Beitrag geht davon aus, dass ESPEasy mit der Arduino geflasht wird und sich die Bibliotheken von Arduino, sowie der eigentliche ESPEasy-Ordner im Sketckbok-Ordner unter dem Ordner "libraries" befinden. Dazu einfach die aktuelle Version von ESPEasy hier herunterladen. Dann alle Bibliotheken im Ordner "lib" in Ordner "libraries" in den Sketch-Ordner kopieren und den Ordner "src" in "ESPEasy" umbenennen und ebenfalls in den Sketch-Ordner kopieren. 

Es gibt natürlich noch andere mögliche Ordnerstrukturen, ich habe jedoch mit dieser ganz gute Erfahrungen gemacht. 

Euren aktuellen Sketch-Ordner könnt ihr unter den Einstellungen in der Arduino IDE anpassen.

Plugin-Datei herunterladen und richtig kopieren

Die Plugin-Datei besteht im Normalfall aus einer Datei mit der Endung ".ino". Diese muss in den ESPEasy-Ordner kopiert werden, in dem sich die ganzen Plugin-Dateien befinden. Erkennen könnt ihr dies an deren Syntax. Eine Plugin-Datei fängt immer mit einem Unterstrich und der Plugin-Nummer an. Diese Nummer muss einmalig sein. Sollte eure Plugin-Datei also noch nicht diesen Syntax entsprechend, so nennt diese vor dem kopieren zunächst entsprechend um. 

Die Plugin-Nummer kann im Grunde frei gewählt werden, sollte jedoch einmalig sein und zur eigentlichen Plugin-Datei passen. Das "#ifdef USES_P124" am Anfang der Datei ist später für das Einbinden des Plugins notwendig. 

In diesem Beitrag werde ich euch zeigen, wie die das Plugin "NeoPixelBusFX" einbindet. Die Plugin-Datei könnt ihr hier herunterladen. Um nun das Plugin einzubinden, kopiert ihr die Datei "_P124_NeoPixelBusFX.ino" in den ESPEasy-Ordner. In diesem Fall gibt es noch eine weitere Header-Datei - "faketv..h". Diese wird ebenfalls einfach in den ESPEasy-Ordner kopiert. 

Einbinden des Plugins aktivieren

Das Kopieren der Datei reicht leider noch nicht aus, damit die Plugin-Datei beim kompilieren mit einbezogen wird. Im Normalfall werden nur stabile und offizielle Plugin eingebunden. 

ESPEasy unterscheidet die Plugins beim Kompilieren in drei Kategorien:

  • PLUGIN_BUILD_NORMAL
  • PLUGIN_BUILD_TESTING
  • PLUGIN_BUILDEV

Wie der Name schon sagt, wird hier zwischen dem Entwicklungszustand der Plugins unterschieden. Im Auslieferungszustand wird die Kategorie "PLUGIN_BUILD_NORMAL" verwendet.

Damit das neue Plugin nun kompiliert wird, gibt es zwei Möglichkeiten.

Möglichkeit 1

Das Plugin in die Gruppe "PLUGIN_BUILD_NORMAL" hinzufügen. Dies könnt ihr in der Datei "define_plugin_sets.h" vornehmen. Direkt am Anfang der Datei kann man eine weitere Aufteilung der einzelnen Kategorien sehen:

Das neue Plugin "_P124_NeoPixelBusFX" muss nun also in die Gruppe "PLUGIN_SET_STABLE" hinzugefügt werden. Scrollt ihr in der Datei etwas herunter, so findet ihr die Auflistung, der als stabil gekennzeichnet Plugins. 

Diese Liste dann einfach um den Eintrag "#define USES_P124" erweitern.

Möglichkeit 2

Möchtet ihr das Plugin noch nicht als "STABLE" setzten, so könnt ihr das Modul in die Liste "PLUGIN_SET_EXPERIMENTAL" setzen, ebenfalls in der Datei "define_plugin_sets.h". Des Weiteren müsst ihr dann in der Datei "ESPEasy-Globals.h" entsprechend die Zeile kommentieren bzw. auskommentieren, damit die DEV-Plugins verwendet werden.

Flashen

Egal welche Möglichkeit ihr verwendet, wichtig ist, dass das Plugin (wie auch immer)  mit "#define USES_P124" eingebunden wird. Dank dem Anfang der Plugin-Datei (siehe oben) wird das Plugin nun beim Kompilieren einbezogen.

Hinterlasse einen Kommentar

avatar
Fotos und Bilder
 
 
 
sonstiges Dateiformat
 
 
 
  Subscribe  
Benachrichtige mich zu: