Skip to content

askac/webuartZ

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WebSerial UART Console

A lightweight, portable, browser-based serial console using the Web Serial API and xterm.js.

Features

  • Zero Dependencies: Runs entirely in the browser. No Node.js or Python required for the host server.
  • Portable: Includes a standalone PowerShell-based HTTP server (serve.bat) for easy local launching.
  • Modern UI: Dark-themed, responsive interface.
  • Terminal: Full functional VT100/xterm emulation.
  • Controls:
    • Baud rate (standard & custom), Data bits, Parity, Stop bits.
    • Hardware Flow Control (RTS/CTS).
    • Manual DTR/RTS signal toggling.
  • Tools:
    • Local Echo: See what you type.
    • RX HEX: View received data in hexadecimal.
    • Timestamp: Auto-timestamp received lines (with millisecond precision).
    • TX HEX: Send data as hexadecimal bytes.
    • Log Save: Export session logs to text file.
  • Offline Capable: All libraries are included locally.

Usage

Windows (Recommended)

  1. Double-click serve.bat.
  2. A browser window will automatically open to http://localhost:8080/uart.html.
  3. Click Connect and select your COM port.

Manual / Other OS

You can serve the directory using any static HTTP server. Note that the Web Serial API requires a Secure Context (HTTPS or localhost).

# Python
python -m http.server 8080

# Node.js
npx http-server .

Access at http://localhost:8080/uart.html.

Requirements

  • Browser: Chrome 89+ or Edge 89+ (Firefox/Safari do not support Web Serial API yet).
  • OS: Windows, Linux, macOS, Android (with compatible browser).

License

This project is licensed under the MIT License - see the LICENSE file for details.

Third-Party Libraries

This project uses the following open-source libraries:

  • xterm.js - Terminal component. (MIT License)
  • xterm-addon-fit - Fit addon for xterm.js. (MIT License)
  • xterm-addon-web-links - Web Links addon for xterm.js. (MIT License)

About

Zero dependency web uart console

Resources

License

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors