WLED compile helper

Dieses Werkzeug hilft Ihnen eine Konfiguration vorzubereiten um selbst WLED Software mit speziellen Einstellungen und/oder UserMods zu kompilieren. Es erzeugt die sogenannten „Enviroment“ Einstellungen, die man dann in platformio.ini Datei in VSC/PlattformIO kopieren und mit einem Befehl „pio run -e custom_build“ kompilieren kann.

You also can compile WLED using GitHub using YAML workflow script generated below.

Im Folgenden wird erklärt, wie man WLED Software auf Github kompilieren kann. Der Vorteil diese Methode ist, dass man keine Software (VSC/PlatformIO) auf dem eigenen PC installieren muss. GitHub nutzt dabei eigene Server und das ganze wird durch ein Script gesteuert durchgeführt. Man muss lediglich sich auf GitHub registrieren (alles kostenlos), Repository und Workflow (Skript) anlegen und starten:
  1. Wenn Du noch kein Account auf GitHub hast, registriere Dich. Es reicht ein „free“ Account. Damit kannst Du ca. 600 Mal pro Monat WLED kompilieren.
  2. Erstelle in deinem Github eine neue Repository (mit dem grünen Knopf „Create a new repository“). Diese kannst du beliebig benennen.
  3. In deiner Repository gebe den Workflows die Berechtigung diese Repository beschreiben zu dürfen. Dafür gehe in deine Repository, dann oben zu „Settings“, dann in der Spalte links zu „Actions“-> „General“. Jetzt musst Du die Seite „Actions Permissions“ sehen. Weiter unten auf dieser Seite im Bereich „Workflow permissions“ musst Du „Read and write permissions“ anklicken und dann auf „Save“ drunter.
  4. Gehe jetzt zurück zu „< > Code“ in deiner Repository und erstelle eine Workflow Datei. Dafür klicke auf „Add file“ und dann auf „Create new file“. Oben im Feld „Name your file“ tippe folgendes ein „.github/workflows/wled-compile.yaml“. Dabei jedes Mal wenn man „/“ eintippt, erstellt Github einen Unterverzeichnis. In den Bereich „Edit“ kannst Du jetzt den Inhalt der wled-compile.yaml Datei reinkopieren. Dann klicke auf den grünen Knopf „Commit changes...“ und dann im geöffneten Fenster noch mal auf „Commit changes“.
  5. Jetzt kann man den Workflow starten damit WLED compiliert wird. Dafür gehe oben zu „Actions“ und links in de rListe der Workflows auf dem Workflow „WLED compile“, Nun in hellblauer Zeile ( wo steht „This workflow has a workflow_dispatch event trigger.“) kannst Du rechts auf „Run workflow“ klicken und dann noch mal auf den grünen Knopf „Run workflow“. Nach paar Sekunden erscheint dann unter dieser hellblauen Zeile dann die Zeile mit „WLED Compile“, wo rechts dann der Status „in progress“ steht.
  6. Sobald dieser Workflow erfolgreich abgeschlossen ist (dauert normalerweise ca. 3-10 Minuten), erscheint bei „WLED Compile“ links ein grüner Hacken. Dann kannst Du wieder zu „Code“ gehen und da ist dann die kompilierte WLED Software in der Datei custom_build.bin zu finden. Du kannst diese Datei herunterladen: auf die Datei klicken und dann rechts auf Symbol „Download raw file“.
    Wenn der Workflow nicht erfolgreich war, erscheint kein grüner Hacken, dafür aber ein rotes Kreuz. Man kann dann den Workflow verlauf untersuchen um rauszufinden, woran das Problem liegt.
  7. Diese Datei kannst du dann auf deinem WLED Controller per „Manual OTA Update“ installieren.


Optionen:

UserMods verwenden:

Ergebnisse:

Das folgende YAML-Skript generiert nicht nur eine Datei „custom_build.bin“, sondern eine für jeden Branch und jede ausgewählte Enviroment. Jede kompilierte .bin-Datei erhält den Namen build__.bin. Die oben genannten Einstellungen werden auf jeden Build angewendet (mit der Ausnahme, dass der Enviroment Name jedes Mal angepasst wird). Bedenken Sie, dass ein kostenloses GitHub-Konto nur 2000 Build-Minuten pro Monat hat und jeder Build etwa 3 Minuten dauert. Sie können also maximal ca. 660 Builds pro Monat bauen. Danach benötigen Sie ein weiteres kostenloses GitHub-Konto.
Select multiple branches:
Select multiple enviroments:

Nützliche Informationen:


Impressum

Angaben gemäß § 5 TMG:
Verantwortlicher: Wladislaw Waag
Adresse: Wasserburger Landstr. 29, 81825 München, Deutschland
Kontakt: +49 (0) 176 47 11 5206, info@myhome-control.de

EU-Streitschlichtung: Die Europäische Kommission stellt eine Plattform zur Online-Streitbeilegung (OS) bereit: https://ec.europa.eu/consumers/odr/.

Verbraucherstreitbeilegung/Universalschlichtungsstelle: Wir sind nicht bereit oder verpflichtet, an Streitbeilegungsverfahren vor einer Verbraucherschlichtungsstelle teilzunehmen.


Datenschutzerklärung

Der Betreiber dieser Webseite (https://wled-faq.github.io) sammelt und verarbeitet keinerlei personenbezogenen Daten der Nutzer dierser Webseite. Diese Seite wird jedoch im Rahmen von 'Github Pages' gehostet und betrieben. Es ist möglich und wahrscheinlich, dass Github die personenbezogenen Daten sammelt und verarbeitet. Das betrifft dann auch die Besucher der Webseite wled-installer.github.io. Ich habe aber keinerlei Einfluss darauf. Bitte lesen Sie dazu die Datenschutzerklärung von Github: https://docs.github.com/en/github/site-policy/github-privacy-statement

Unsere Webseite enthält Links zu externen Webseiten Dritter, auf deren Inhalte wir keinen Einfluss haben. Für diese fremden Inhalte können wir keine Gewähr und keine Haftung übernehmen. Für die Inhalte der verlinkten Seiten ist immer der jeweilige Anbieter oder Betreiber der Seiten verantwortlich. Die verlinkten Seiten wurden zum Zeitpunkt der Verlinkung auf mögliche Rechtsverstöße überprüft. Rechtswidrige Inhalte waren dabei nicht erkennbar. Sollten uns Rechtsverletzungen bekannt werden, werden wir die entsprechende Verlinkung umgehend entfernen.