Awesome Open Source
Awesome Open Source


     



WebSerial is a Serial Monitor for ESP8266 & ESP32 Microcontrollers that can be accessed remotely via a web browser. Webpage is stored in program memory of the microcontroller.


Preview




Upgrade to Pro

Checkout the Pro version of the WebSerial library which comes with enhanced & snappy UI, along with 'clear' & 'lock scroll' buttons on the monitor interface. Best of all, it's only 10KB in size compared to 50KB of regular WebSerial.

Available Here:

  1. https://www.buymeacoffee.com/6QGVpSj/e/25091
  2. https://webserial.pro

WebSerialPro



Features

  • Works on Websockets
  • Realtime logging
  • Any number of Serial Monitors can be opened on the browser
  • Uses Async Webserver for better performance


Dependencies

For ESP8266:
  • ESP8266 Arduino Core - (latest)
  • ESPAsyncTCP - v1.2.2
  • ESPAsyncWebServer - v1.2.3
For ESP32:
  • ESP32 Arduino Core - (latest)
  • AsyncTCP - v1.1.1
  • ESPAsyncWebServer - v1.2.3

How to Install

Directly Through Arduino IDE

Go to Sketch > Include Library > Library Manager > Search for "WebSerial" > Install

Manual Install

For Windows: Download the Repository and extract the .zip in Documents>Arduino>Libraries>{Place "WebSerial" folder Here}

For Linux: Download the Repository and extract the .zip in Sketchbook>Libraries>{Place "WebSerial" folder Here}

Include other library https://github.com/me-no-dev/ESPAsyncWebServer https://github.com/me-no-dev/AsyncTCP

Manually through IDE

Download the Repository, Go to Sketch>Include Library>Add .zip Library> Select the Downloaded .zip File.


Documentation

WebSerial is very similar to the default Serial Monitor Library of Arduino.

Please see Demo examples for better understanding on how to setup WebSerial for your Project: Click Here

WebSerial has 2 main functions:

  • print
  • println

print - simply prints the data sent over WebSerial without any newline character.

println - prints the data sent over WebSerial with a newline character.

Both functions support the following datatypes: String, const char, char, int, uint8_t, uint16_t, uint32_t, double, float.

To Access Webserial: Go to <IP Address>/webserial in your browser ( where <IP Address> is the IP of your ESP).


Contributions

Every Contribution to this repository is highly appriciated! Don't fear to create pull requests which enhance or fix the library as ultimatly you are going to help everybody.

If you want to donate to the author then you can buy me a coffee, It really helps me keep these libraries updated:



License

WebSerial is licensed under General Public License v3 ( GPLv3 ).


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
c (15,209
vuejs (1,101
arduino (743
esp8266 (260
esp32 (224
monitor (165
interface (81
remote (74
serial (62