Installation
Install ESP-DASH v4 and its platform-specific dependencies in the Arduino IDE or PlatformIO.
This page lists the dependencies ESP-DASH v4 requires on each platform and describes how to install the library in the Arduino IDE and PlatformIO.
Dependencies
ESP-DASH requires the following libraries in your libraries folder. Install only the versions listed below; other versions can cause ESP-DASH to fail to compile or to work only partially.
ESPAsyncWebServer source
As of v4.0.9, ESP-DASH depends on ESP32Async/ESPAsyncWebServer, which is the only officially maintained version of the library. Remove older forks and install the latest release from the ESP32Async organization.
The ESP32Async organization was formed by several core collaborators to maintain a single active version. All changes and improvements from mathieucarbou's fork of ESPAsyncWebServer have been merged into ESP32Async/ESPAsyncWebServer.
Install the dependencies for your platform:
- ESP8266 Arduino Core >= v3.1.2
- (ESP32Async) ESPAsyncTCP @ v2.0.0
- (ESP32Async) ESPAsyncWebServer >= v3.7.1
- ArduinoJson >= v7.3.0
RP2040 refers to the Raspberry Pi Pico W and RP2350 to the Raspberry Pi Pico 2 W. RP2350 support was added in ESP-DASH v4.0.9.
Install ESP-DASH
The latest ESP-DASH release is v5. When installing ESP-DASH v4, select a 4.x version (the final v4 release is v4.0.9) rather than the latest version.
Library Manager
Open Sketch > Include Library > Manage Libraries, search for "ESP-DASH", select a 4.x version and click Install.
Manual installation
- Download the ESP-DASH v4.0.9 archive.
- Extract the archive into your Arduino libraries folder:
- Windows:
Documents/Arduino/libraries/ - Linux:
<sketchbook>/libraries/
- Windows:
Import a ZIP library
- Download the ESP-DASH v4.0.9 archive.
- Open Sketch > Include Library > Add .ZIP Library and select the downloaded file.
Next steps
- Integration: add a dashboard to an existing web server sketch.
- Examples: browse the example sketches.