Home
Softono
WebSerial

WebSerial

Open source C++
643
Stars
122
Forks
0
Issues
16
Watchers
6 months
Last Commit

About WebSerial

<p align="center"> <a href="https://webserial.pro?ref=ghfeature" target="_blank"> <img src="/docs/feature.png" width="1200"> </a> </p> <br/> <p> <img src="https://img.shields.io/github/last-commit/ayushsharma82/WebSerial.svg?style=for-the-badge" /> &nbsp; <img src="https://img.shields.io/github/actions/workflow/status/ayushsharma82/WebSerial/ci.yml?branch=master&style=for-the-badge" /> &nbsp; <img src="https://img.shields.io/github/license/ayushsharma82/WebSerial.svg?style=for-the-badge" /> </p> <br/> **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. <br/> <br/> ## 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 cod ...

Platforms

Web Self-hosted

Languages

C++


   


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
  • RP2040+W (Example: Raspberry Pico W)
  • RP2350+W (Example: Raspberry Pico 2W)
  • ( 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:



Looking for 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:


WebSerial Pro


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.2 ( SCL-1.2 ).