Skip to main content

Installation

This guide explains how to install ArmorLink and prepare your development environment.

ArmorLink is an Arduino-compatible framework for ESP32-based projects.

It can be used with:

  • Arduino IDE
  • Visual Studio Code with PlatformIO
  • Other Arduino-compatible ESP32 development environments

Requirements​

Before using ArmorLink, make sure you have:

  • An ESP32-based development board
  • ESP32 Arduino Core installed
  • A working Arduino-compatible development environment
  • The latest ArmorLink release
  • ArduinoJson

ArmorLink is designed for ESP32-based projects.

Install the ESP32 Board Package​

If you are using the Arduino IDE, install the ESP32 board package first.

  1. Open Arduino IDE
  2. Open Settings
  3. Add the ESP32 board manager URL
  4. Open Boards Manager
  5. Search for esp32
  6. Install the ESP32 package
  7. Select your ESP32 board from the board menu

Download the latest ArmorLink release from GitHub:

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

Download the release archive and extract it.

After extracting, you should have an ArmorLink folder that contains the library files.

The recommended installation method is to copy the extracted ArmorLink folder into your Arduino libraries directory.

The final folder should be named:

ArmorLink

and should contain the ArmorLink source files.

macOS​

Copy the extracted ArmorLink folder to:

~/Documents/Arduino/libraries/ArmorLink

Typical final structure:

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

Windows​

Copy the extracted ArmorLink folder to:

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

Typical final structure:

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

Linux​

Copy the extracted ArmorLink folder to:

~/Arduino/libraries/ArmorLink

or, depending on your Arduino IDE setup:

~/Documents/Arduino/libraries/ArmorLink

Typical final structure:

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

Avoid Nested Folders​

Make sure the library is not nested inside an additional folder.

Correct:

Documents/Arduino/libraries/ArmorLink/ArmorLink.h

Incorrect:

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

If the folder name contains a version suffix such as ArmorLink-v0.1.0, rename it to:

ArmorLink

Restart the Arduino IDE​

After copying the library folder, restart the Arduino IDE.

Then ArmorLink can be included in your sketch:

#include <ArmorLink.h>

Install ArduinoJson​

ArmorLink uses ArduinoJson.

If ArduinoJson is not already installed:

  1. Open Arduino IDE
  2. Open Library Manager
  3. Search for ArduinoJson
  4. Install the library by Benoit Blanchon

PlatformIO​

When using PlatformIO, ArmorLink can be referenced directly from GitHub.

Example platformio.ini:

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

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

Verify the Installation​

Create a minimal 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();
}

Upload the sketch to your ESP32.

If the sketch compiles and starts, ArmorLink is installed correctly.

Troubleshooting​

ArmorLink.h not found​

Check that the folder structure is correct:

Documents/Arduino/libraries/ArmorLink/ArmorLink.h

Then restart the Arduino IDE.

ArduinoJson.h not found​

Install ArduinoJson through the Arduino Library Manager.

Wrong board selected​

Make sure an ESP32 board is selected in your development environment.

Next Steps​

Continue with: