Installation
Install WebSerial Lite or WebSerial Pro and their platform-specific dependencies in the Arduino IDE or PlatformIO.
This page lists the dependencies WebSerial requires on each platform and describes how to install the library in the Arduino IDE and PlatformIO.
Dependencies
WebSerial requires the following libraries in your libraries folder. Install only the versions listed below; other versions can cause WebSerial to fail to compile or to work only partially.
WebSerial Lite
- ESP8266 Arduino Core >= v3.1.2
- (ESP32Async) ESPAsyncTCP @ v2.0.0
- (ESP32Async) ESPAsyncWebServer >= v3.9.0
RP2040 refers to the Raspberry Pi Pico W and RP2350 to the Raspberry Pi Pico 2 W.
WebSerial Pro
WebSerial Pro supports ESP8266 and ESP32 and uses the same ESP32Async libraries as WebSerial Lite:
- ESP8266 Arduino Core >= v3.1.2
- (ESP32Async) ESPAsyncTCP @ v2.0.0
- (ESP32Async) ESPAsyncWebServer >= v3.9.0
Earlier WebSerial Pro releases were built against the mathieucarbou forks of AsyncTCP and ESPAsyncWebServer. Remove those forks from your libraries folder before installing the ESP32Async libraries; two copies of ESPAsyncWebServer cannot be installed side by side.
Install WebSerial Lite
WebSerial Lite can be installed in the Arduino IDE or in PlatformIO.
Library Manager
Open Sketch > Include Library > Manage Libraries, search for "WebSerial" and click Install.
Manual installation
- Download the WebSerial repository archive.
- Extract the archive into your Arduino libraries folder:
- Windows:
Documents/Arduino/libraries/ - Linux:
<sketchbook>/libraries/
- Windows:
Import a ZIP library
- Download the WebSerial repository archive.
- Open Sketch > Include Library > Add .ZIP Library and select the downloaded file.
Install WebSerial Pro
WebSerial Pro is distributed as a ZIP archive after purchase. The archive contains a WebSerialPro-x.x.x folder with the library files.
- Extract the downloaded ZIP archive.
- Copy the
WebSerialPro-x.x.xfolder (the folder that contains the library files). - In the Arduino IDE, open File > Preferences (Arduino IDE 1.8) or File > Settings (Arduino IDE 2) and note the Sketchbook location.
- Open the
librariesfolder inside the sketchbook location. - Paste the
WebSerialPro-x.x.xfolder into thelibrariesfolder.
In your sketch, include WebSerialPro.h instead of WebSerial.h. See Upgrading to WebSerial Pro.
Next steps
- Integration Guide: add WebSerial to an existing web server sketch.
- Examples: browse the example sketches.
- High Performance Mode: enable unbuffered, high-throughput logging.