Sem descrição

Ayush Sharma 3145252bce v2.1.1 há 5 dias atrás
.github 8be00282e1 fix: add high perf flag in ci há 6 dias atrás
docs 3a3dd10ca3 fix: side lines in preview image há 6 meses atrás
examples 72b37bc8d8 fix: examples for arduino-pico há 6 dias atrás
src a5eb74e39e Revert "fix: consecutive whitespace characters not displaying on web - closes #112" há 5 dias atrás
.gitattributes cd635a665f Initial commit há 5 anos atrás
.gitignore a35af3f84b chore: updated gitignore há 9 meses atrás
CLA.md c52b153d60 fix: add CLA há 5 meses atrás
CODE_OF_CONDUCT.md 3bac49f9e6 chore: add code of conduct há 5 meses atrás
LICENSE d735de291d V2 (#75) há 9 meses atrás
README.md 57abf71a0f fix: reformat readme markdown há 6 dias atrás
keywords.txt d735de291d V2 (#75) há 9 meses atrás
library.json 550d0dc54c chore: bump version há 5 dias atrás
library.properties 550d0dc54c chore: bump version há 5 dias atrás
platformio.ini 29f6b26c04 fix: update ci há 6 dias atrás

README.md


   


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