Brak opisu

Ayush Sharma 6562e9f3dc Merge pull request #9 from ayushsharma82/dependabot/npm_and_yarn/ui/eslint-utils-1.4.3 4 lat temu
.github 4b38ea0079 Added libraries in build_platform.sh 4 lat temu
docs f81d558aa1 Create logo.svg 5 lat temu
examples 8f64e2b1a3 Update ESP8266_Demo.ino 5 lat temu
src 1a5cbd91f1 Added UI 4 lat temu
ui 74f9508149 Bump eslint-utils from 1.3.1 to 1.4.3 in /ui 4 lat temu
.gitattributes cd635a665f Initial commit 6 lat temu
.gitignore 1a5cbd91f1 Added UI 4 lat temu
.travis.yml d415360faa Add Travis 4 lat temu
LICENSE cd635a665f Initial commit 6 lat temu
README.md 4b38ea0079 Added libraries in build_platform.sh 4 lat temu
build_platformio.sh 4b38ea0079 Added libraries in build_platform.sh 4 lat temu
keywords.txt 5d45184a5f Update keywords.txt 5 lat temu
library.json 8bb2fc8307 Version Bump 4 lat temu
library.properties 8bb2fc8307 Version Bump 4 lat temu

README.md


     



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




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 ( Currently Submitted for Approval. Use Mannual Install till it gets Approved.)

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 ).