Zum Hauptinhalt springen

Installation

Diese Anleitung erklärt, wie du ArmorLink installierst und deine Entwicklungsumgebung vorbereitest.

ArmorLink ist ein Arduino-kompatibles Framework für ESP32-basierte Projekte.

Es kann verwendet werden mit:

  • Arduino IDE
  • Visual Studio Code with PlatformIO
  • anderen Arduino-kompatiblen ESP32-Entwicklungsumgebungen

Voraussetzungen​

Bevor du ArmorLink verwendest, stelle sicher, dass du Folgendes hast:

  • Ein ESP32-basiertes Entwicklungsboard
  • Installierten ESP32 Arduino Core
  • Eine funktionierende Arduino-kompatible Entwicklungsumgebung
  • Die aktuelle ArmorLink-Version
  • ArduinoJson

ArmorLink wurde für ESP32-basierte Projekte entwickelt.

ESP32-Boardpaket installieren​

Wenn du die Arduino IDE verwendest, installiere zuerst das ESP32-Boardpaket.

  1. Öffne die Arduino IDE
  2. Öffne die Einstellungen
  3. Füge die URL für den ESP32 Board Manager hinzu
  4. Öffne den Boards Manager
  5. Suche nach esp32
  6. Installiere das ESP32-Paket
  7. Wähle dein ESP32-Board im Board-Menü aus

Lade die aktuelle ArmorLink-Version von GitHub herunter:

https://github.com/Muehli-Industries/ArmorLink/releases

Lade das Release-Archiv herunter und entpacke es.

Nach dem Entpacken solltest du einen ArmorLink-Ordner mit den Bibliotheksdateien haben.

Die empfohlene Installationsmethode besteht darin, den entpackten ArmorLink-Ordner in dein Arduino-Libraries-Verzeichnis zu kopieren.

Der finale Ordner sollte heißen:

ArmorLink

und die ArmorLink-Quelldateien enthalten.

macOS​

Kopiere den entpackten ArmorLink-Ordner nach:

~/Documents/Arduino/libraries/ArmorLink

Typische Ordnerstruktur:

Documents/
`- Arduino/
   `- libraries/
      `- ArmorLink/
         |- ArmorLink.h
         |- ArmorLinkModule.h
         |- ArmorLinkProtocol.h
         `- ...

Windows​

Kopiere den entpackten ArmorLink-Ordner nach:

C:\Users\<YourUserName>\Documents\Arduino\libraries\ArmorLink

Typische Ordnerstruktur:

Documents
`- Arduino
   `- libraries
      `- ArmorLink
         |- ArmorLink.h
         |- ArmorLinkModule.h
         |- ArmorLinkProtocol.h
         `- ...

Linux​

Kopiere den entpackten ArmorLink-Ordner nach:

~/Arduino/libraries/ArmorLink

or, depending on your Arduino IDE setup:

~/Documents/Arduino/libraries/ArmorLink

Typische Ordnerstruktur:

Arduino/
`- libraries/
   `- ArmorLink/
      |- ArmorLink.h
      |- ArmorLinkModule.h
      |- ArmorLinkProtocol.h
      `- ...

Verschachtelte Ordner vermeiden​

Stelle sicher, dass die Bibliothek nicht in einem zusätzlichen Unterordner liegt.

Korrekt:

Documents/Arduino/libraries/ArmorLink/ArmorLink.h

Falsch:

Documents/Arduino/libraries/ArmorLink-v0.1.0/ArmorLink/ArmorLink.h

Wenn der Ordnername einen Versionszusatz wie ArmorLink-v0.1.0 enthält, benenne ihn um in:

ArmorLink

Arduino IDE neu starten​

Nachdem du den Bibliotheksordner kopiert hast, starte die Arduino IDE neu.

Danach kann ArmorLink in deinem Sketch eingebunden werden:

#include <ArmorLink.h>

ArduinoJson installieren​

ArmorLink verwendet ArduinoJson.

Falls ArduinoJson noch nicht installiert ist:

  1. Öffne die Arduino IDE
  2. Öffne den Library Manager
  3. Search for ArduinoJson
  4. Installiere die Bibliothek von Benoit Blanchon

PlatformIO​

Bei Verwendung von PlatformIO kann ArmorLink direkt über GitHub eingebunden werden.

Example platformio.ini:

[env:esp32dev]
platform = espressif32
board = esp32dev
framework = arduino

lib_deps =
    bblanchon/ArduinoJson
    https://github.com/Muehli-Industries/ArmorLink.git

Installation prüfen​

Erstelle einen minimalen Test-Sketch:

#include <ArmorLink.h>

ArmorLinkModule module(
    "Demo",
    ArmorLinkModuleType::Generic
);

void setup()
{
    Serial.begin(115200);

    ArmorLinkOptions options;
    options.enableGateway = true;
    options.enableBle = true;
    options.enableEspNow = false;

    ArmorLink.begin(module, options);

    ArmorLink.info("ArmorLink started");
}

void loop()
{
    ArmorLink.loop();
}

Lade den Sketch auf deinen ESP32 hoch.

Wenn der Sketch kompiliert und startet, wurde ArmorLink korrekt installiert.

Fehlerbehebung​

ArmorLink.h nicht gefunden​

Prüfe, ob die Ordnerstruktur korrekt ist:

Documents/Arduino/libraries/ArmorLink/ArmorLink.h

Starte anschließend die Arduino IDE neu.

ArduinoJson.h nicht gefunden​

Installiere ArduinoJson über den Arduino Library Manager.

Falsches Board ausgewählt​

Stelle sicher, dass in deiner Entwicklungsumgebung ein ESP32-Board ausgewählt ist.

Nächste Schritte​

Weiter mit: