A remote terminal library for wireless microcontrollers to log, monitor or debug your firmware/product
Full Changelog: https://github.com/ayushsharma82/WebSerial/compare/v2.0.1...v2.0.2
Full Changelog: https://github.com/ayushsharma82/WebSerial/compare/v2.0.0...v2.0.1
WebSerial was something which was waiting for so long to be updated to current standards, and.. here it is! The main focus of V2 release was to work on stability of the library and make it a useful thing that can stay alongside your code for monitoring, logging or debugging your firmware/product.
[!IMPORTANT] We have officially switched to fork of ESPAsyncWebServer from @mathieucarbou which contain a lot of bug fixes and arduino-esp32 core v3 support. Please make sure you have correct dependencies by checking here - Installation Docs.
Here's a quick rundown of things that have been added with V2:
Like my other libraries, WebSerial v2 now uses SvelteJS to produce a smaller bundle which in return provides you with more space for code and it's significant! That's a tiny bundle with much better UI and more functionality compared to previous version.
Here's the comparison:
| V1 | New V2 |
|---|---|
| 57Kb | 20Kb (-63%) |
Improved compression script, now webpage header files are divided between header and source. This fixes linker issues when using WebSerial within another class/library.
New UI features light/dark/system theme toggle which comes in really handy and making the whole interface comfortable to use.
We are seeing a ton of changes in C++ library with v2, essentially it can be divided into 2 major things:
Binary Encoding The library now uses custom made binary packet encoding technique to allow multiple commands and responses over the same WebSocket transmission pipe. This means a lot for WebSerial in future as we are now not limited to just sending logs/messages to UI via WebSocket.
Dual Buffer Approach WebSerial originally came without any kind of buffering which lead to lack of performance as a teeny-tiny microcontroller can only handle little data over a network. To overcome this, WebSerial v2 and the latest WebSerial Pro v2 uses dual buffer approach which increases the performance of WebSerial to handle more data and short bursts of data without any issue.
Timestamps are now synced with C++ library! This means a lot for accurate time stamping which is precise down to level of millisecond and all this without any requiring any time-keeping dependency!
You can now download all your received logs directly from the UI. You can choose between mulitple file formats including text, json and csv! Know More
Wish to use WebSerial for monitoring purposes only? Think no more! You can easily disable input bar from the C++ library itself. Know More
You can now change the font style and size of your WebSerial terminal without leaving the interface, it's right there in the settings tab. Just click on settings and change the font family, or if you want you can increase or decrease the font size according to your comfort. Know More
You can now add your own custom portal title. Know More
I know people wanted to add their own project/company logo to personalize their WebSerial terminal, therefore with v2 I've separated the logos from the webpage and now those can be set within the C++ code without touching the HTML, CSS or JS which is just awesome. Know More
The license of WebSerial open source edition has been changed from GPL-3.0 to AGPL-3.0 to better facilitate users with a good library and user experience. Please be aware if you are running WebSerial in any of your commercial products and consider switching to SCL-1.1 ( SOFTT Commercial License 1.1 ) which allows for commercial usage. WebSerial Pro comes included with SCL-1.1 license.
Print class. Thanks to @jksempleImproved webpage.h generation and updated finalize script
This resolves #37 .
This release includes:
Added Vuejs UI for everyone and updated dependencies.
Rolling out V1.0.0 of WebSerial!