Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asjdf/webseriallite
Super lightweight remote serial monitor for ESP8266 & ESP32 (frontend <3k)
https://github.com/asjdf/webseriallite
arduino esp32 esp8266 webserial
Last synced: 10 days ago
JSON representation
Super lightweight remote serial monitor for ESP8266 & ESP32 (frontend <3k)
- Host: GitHub
- URL: https://github.com/asjdf/webseriallite
- Owner: asjdf
- License: gpl-3.0
- Created: 2022-08-26T15:48:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-14T20:51:42.000Z (about 1 year ago)
- Last Synced: 2023-12-15T12:09:13.344Z (about 1 year ago)
- Topics: arduino, esp32, esp8266, webserial
- Language: HTML
- Homepage:
- Size: 51.8 KB
- Stars: 36
- Watchers: 3
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WebSerialLite
WebSerial is a Serial Monitor for ESP8266 & ESP32 Microcontrollers that can be accessed remotely via a web browser. Webpage is stored in program memory of the microcontroller.
## Preview
[DemoVideo](https://www.bilibili.com/video/BV1Jt4y1E7kj)
## Upgrade to Pro?
I'm sorry that the current version is already the Pro version. XD
## 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
For ESP8266:
- ESP8266 Arduino Core - (latest)
- ESPAsyncTCP - v1.2.2
- ESPAsyncWebServer - v1.2.3
For ESP32:
- ESP32 Arduino Core - (latest)
- AsyncTCP - v1.1.1
- ESPAsyncWebServer - v1.2.3
## Documentation
WebSerialLite is very similar to the default Serial Monitor Library of Arduino.
Please see `Demo` examples for better understanding on how to setup WebSerialLite for your Project.
WebSerialLite has 2 main functions:
- `print`
- `println`
`print` - simply prints the data sent over WebSerialLite without any newline character.
`println` - prints the data sent over WebSerialLite with a newline character.
Both functions support the following datatypes: `String`, `const char`, `char`, `int`, `uint8_t`, `uint16_t`, `uint32_t`, `double`, `float`.
To Access WebSerialLite: Go to `/webserial` in your browser ( where `` is the IP of your ESP).
## FAQ
1. **last `println` not being received** [#4](https://github.com/asjdf/WebSerialLite/issues/4)
> This issue is not caused by this library. As you can see in , they limit the length of queue, and they define the max length of queue to 8 for ESP8266, you can check in .
>
> So if you want to send many messages through websocket rapidly, I recommend you make a temp storage. Or you can edit the ESPAsyncWebServer to solve this problem. By the way, I create a PR try to let user config the WS_MAX_QUEUED_MESSAGES (esphome/ESPAsyncWebServer#10), hope it can be proved.
## Contributions
Every Contribution to this repository is highly appreciated! Don't fear to create pull requests which enhance or fix the library as ultimately you are going to help everybody.
## License
WebSerialLite is licensed under General Public License v3 ( GPLv3 ).