68 lines
2.4 KiB
Markdown
68 lines
2.4 KiB
Markdown
# MycilaWebSerial
|
|
|
|
[](https://opensource.org/licenses/MIT)
|
|
[](https://github.com/mathieucarbou/MycilaWebSerial/actions/workflows/ci.yml)
|
|
[](https://registry.platformio.org/libraries/mathieucarbou/MycilaWebSerial)
|
|
|
|
MycilaWebSerial is a Serial Monitor for ESP32 that can be accessed remotely via a web browser. Webpage is stored in program memory of the microcontroller.
|
|
|
|
This library is based on the UI from [asjdf/WebSerialLite](https://github.com/asjdf/WebSerialLite) (and this part falls under GPL v3).
|
|
|
|
## Changes
|
|
|
|
- Simplified callbacks
|
|
- Fixed UI
|
|
- Fixed Web Socket auto reconnect
|
|
- Fixed Web Socket client cleanup (See `WEBSERIAL_MAX_WS_CLIENTS`)
|
|
- Command history (up/down arrow keys) saved in local storage
|
|
- Support logo and fallback to title if not found.
|
|
- Arduino 3 / ESP-IDF 5.1 Compatibility
|
|
- Improved performance: can stream up to 20 lines per second is possible
|
|
|
|
To add a logo, add a handler for `/logo` to serve your logo in the image format you want, gzipped or not.
|
|
You can use the [ESP32 embedding mechanism](https://docs.platformio.org/en/latest/platforms/espressif32.html).
|
|
|
|
## Preview
|
|
|
|
|
|
|
|
[DemoVideo](https://www.bilibili.com/video/BV1Jt4y1E7kj)
|
|
|
|
## Features
|
|
|
|
- Works on WebSockets
|
|
- Realtime logging
|
|
- Any number of Serial Monitors can be opened on the browser
|
|
- Uses Async Webserver for better performance
|
|
- Light weight (<3k)
|
|
- Timestamp
|
|
- Event driven
|
|
|
|
## Dependencies
|
|
|
|
- [mathieucarbou/ESPAsyncWebServer](https://github.com/mathieucarbou/ESPAsyncWebServer)
|
|
|
|
## Usage
|
|
|
|
```c++
|
|
WebSerial.onMessage([](const String& msg) { Serial.println(msg); });
|
|
WebSerial.begin(server);
|
|
|
|
WebSerial.print("foo bar baz");
|
|
```
|
|
|
|
If you need line buffering to use print(c), printf, write(c), etc:
|
|
|
|
```c++
|
|
WebSerial.onMessage([](const String& msg) { Serial.println(msg); });
|
|
WebSerial.begin(server);
|
|
|
|
WebSerial.setBuffer(100); // initial buffer size
|
|
|
|
WebSerial.printf("Line 1: %" PRIu32 "\nLine 2: %" PRIu32, count, ESP.getFreeHeap());
|
|
WebSerial.println();
|
|
WebSerial.print("Line ");
|
|
WebSerial.print(3);
|
|
WebSerial.println();
|
|
```
|