{"id":23085357,"url":"https://github.com/asjdf/webseriallite","last_synced_at":"2025-08-16T04:31:21.130Z","repository":{"id":65410400,"uuid":"529317774","full_name":"asjdf/WebSerialLite","owner":"asjdf","description":"Super lightweight remote serial monitor for ESP8266 \u0026 ESP32 (frontend \u003c3k)","archived":false,"fork":false,"pushed_at":"2023-12-14T20:51:42.000Z","size":53,"stargazers_count":36,"open_issues_count":3,"forks_count":12,"subscribers_count":3,"default_branch":"main","last_synced_at":"2023-12-15T12:09:13.344Z","etag":null,"topics":["arduino","esp32","esp8266","webserial"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/asjdf.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-08-26T15:48:33.000Z","updated_at":"2023-12-15T12:09:13.345Z","dependencies_parsed_at":"2023-12-14T12:18:30.168Z","dependency_job_id":null,"html_url":"https://github.com/asjdf/WebSerialLite","commit_stats":null,"previous_names":[],"tags_count":5,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asjdf%2FWebSerialLite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asjdf%2FWebSerialLite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asjdf%2FWebSerialLite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asjdf%2FWebSerialLite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/asjdf","download_url":"https://codeload.github.com/asjdf/WebSerialLite/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230005241,"owners_count":18158367,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arduino","esp32","esp8266","webserial"],"created_at":"2024-12-16T17:54:02.680Z","updated_at":"2024-12-16T17:54:03.606Z","avatar_url":"https://github.com/asjdf.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WebSerialLite\n\nWebSerial is a Serial Monitor for ESP8266 \u0026 ESP32 Microcontrollers that can be accessed remotely via a web browser. Webpage is stored in program memory of the microcontroller.\n\n## Preview\n\n![Preview](https://s2.loli.net/2022/08/27/U9mnFjI7frNGltO.png)\n\n[DemoVideo](https://www.bilibili.com/video/BV1Jt4y1E7kj)\n\n## Upgrade to Pro?\n\nI'm sorry that the current version is already the Pro version. XD\n\n## Features\n\n- Works on WebSockets\n- Realtime logging\n- Any number of Serial Monitors can be opened on the browser\n- Uses Async Webserver for better performance\n- Light weight (\u003c3k)\n- Timestamp\n- Event driven\n\n## Dependencies\n\nFor ESP8266:\n\n- ESP8266 Arduino Core - (latest)\n- ESPAsyncTCP - v1.2.2\n- ESPAsyncWebServer - v1.2.3\n\nFor ESP32:\n\n- ESP32 Arduino Core - (latest)\n- AsyncTCP - v1.1.1\n- ESPAsyncWebServer - v1.2.3\n\n## Documentation\n\nWebSerialLite is very similar to the default Serial Monitor Library of Arduino.\n\nPlease see `Demo` examples for better understanding on how to setup WebSerialLite for your Project.\n\nWebSerialLite has 2 main functions:\n\n- `print`\n- `println`\n\n`print` - simply prints the data sent over WebSerialLite without any newline character.\n\n`println` - prints the data sent over WebSerialLite with a newline character.\n\nBoth functions support the following datatypes: `String`, `const char`, `char`, `int`, `uint8_t`, `uint16_t`, `uint32_t`, `double`, `float`.\n\nTo Access WebSerialLite: Go to `\u003cIP Address\u003e/webserial` in your browser ( where `\u003cIP Address\u003e` is the IP of your ESP).\n\n## FAQ\n\n1. **last `println` not being received** [#4](https://github.com/asjdf/WebSerialLite/issues/4)\n   \u003e This issue is not caused by this library. As you can see in \u003chttps://github.com/me-no-dev/ESPAsyncWebServer/blob/f71e3d427b5be9791a8a2c93cf8079792c3a9a26/src/AsyncWebSocket.cpp#L550\u003e , they limit the length of queue, and they define the max length of queue to 8 for ESP8266, you can check in \u003chttps://github.com/me-no-dev/ESPAsyncWebServer/blob/f71e3d427b5be9791a8a2c93cf8079792c3a9a26/src/AsyncWebSocket.h#L30\u003e.\n   \u003e\n   \u003e 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.\n\n## Contributions\n\nEvery 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.\n\n## License\n\nWebSerialLite is licensed under General Public License v3 ( GPLv3 ).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasjdf%2Fwebseriallite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fasjdf%2Fwebseriallite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasjdf%2Fwebseriallite/lists"}