Installation
Learn how to effortlessly set up WebSerial, a sleek, web-based tool for remote debugging and logging. This guide walks you through the installation process, from initial setup to first use, helping you upgrade your projects with ease and style.
Dependencies
WebSerial depends on the following libraries present in your libraries folder. Please stricly install the compatible versions of these dependencies only! Using any other version might break WebSerial or may cause WebSerial to work partially.
Install dependencies based on your platform:
ESP8266
- ESP8266 Arduino Core >= v3.1.2
- (ESP32Async) ESPAsyncTCP @ v2.0.0
- (ESP32Async) ESPAsyncWebServer >= v3.8.1
Install WebSerial
Please follow the instructions below to install WebSerial based on your development environment. WebSerial can be installed in both Arduino IDE and PlatformIO, making it versatile for various projects.
Arduino IDE
You can install WebSerial in the following ways in Arduino IDE.
1. Library Manager
Go to Sketch > Include Library > Library Manager > Search for “WebSerial” > Install
2. Manual Installation
Windows
- Download the Repository
- Extract the .zip in
Documents > Arduino > Libraries > {Place "WebSerial" folder Here}
Linux
- Download the Repository
- Extract the .zip in
Sketchbook > Libraries > {Place "WebSerial" folder Here}
3. Import through Arduino IDE
- Download the Repository
- Go to
Sketch > Include Library > Add .zip Library > Select the Downloaded .zip File.