README.md 2.7 KB
WebSerial is a remote terminal to log, monitor or debug your firmware without being connected by wire. It lives on your wireless microcontroller itself and can be accessed anytime through your browser.
## Features
- 📜 Log, monitor or debug your firmware/product with ease
- 🔥 A powerful tool that lives in your microcontroller itself
- 🛜 Access it anytime & from anywhere within same network (LAN)
- 🎷 No need to learn HTML/CSS/JS
- 🛫 Ready to use within 4-5 lines of code
## Supported MCUs
WebSerial works on the following microcontrollers/boards:
- ESP8266
- ESP32
- *( more coming soon )*
Documentation
Learn more about Installation & Usage: Click Here
OSS Preview
Once you have integrated WebSerial library in your code, a terminal like below will be accessible over your WiFi microcontroller's IP:
## Want More? Upgrade to Pro WebSerial Pro comes with the following extended functionality: - Export logs into TXT, JSON or CSV file - Lock scroll feature - Timestamps - Enable/Disable Command Input Bar - Customizable font & terminal font size from UI itself - Branding (Add your own Logo) - Commercial License
Available here: - [Official Website ( webserial.pro )](https://webserial.pro?ref=ghrepo)
Contributions
Every contribution to this repository is highly appreciated! If you spot any bug or problem, open a issue or pull request so that it can be rectified for everyone.
**For feature requests:** Please open a issue and I'll add the feature in a future release once I get some time in my hands.License
WebSerial open-source edition is licensed under Affero General Public License v3.0 ( AGPL-3.0 ).
If you are intending to use WebSerial in a commercial project, please consider purchasing WebSerial Pro which comes with a less restrictive SOFTT Commercial License 1.1 ( SCL-1.1 ).