Skip to content

Serial monitor in rust since I don't like TeraTerm

Notifications You must be signed in to change notification settings

brendon-felix/spewcap

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

83 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SpewCap

Basic serial monitor program to capture serial spew (BIOS spew, Super I/O spew, etc) written in the best programming language. I kinda hate using TeraTerm, so this is intended to replace that.

Features

  • Use the TOML file or CLI arguments to configure the application (CLI arguments take precedent)
  • Easy-to-use key commands (C to clear, Q to quit, etc.)
  • Save logs using the built-in file explorer (use S to save)
  • Serial input (for host TX)

Installation

  1. Clone this repository

    git clone https://github.azc.ext.hp.com/wks-fw/SpewCap.git
    cd spewcap
  2. Build the project (optional, requires Rust and Cargo)

    cargo build --release
  3. Place the executable and TOML file in another location

    • If building from source:
      cp .\target\release\spewcap.exe 'C:\Program Files\SpewCap\'
      cp .\config.toml 'C:\Program Files\SpewCap\'
    • If using an existing release:
      cp .\Releases\v0.10.0\spewcap.exe 'C:\Program Files\SpewCap\'
      cp .\config.toml 'C:\Program Files\SpewCap\'
  4. Right click on spewcap.exe to create a shortcut, then add the shortcut to the Start menu folder

    Tip: Place the shortcut file here: C:\ProgramData\Microsoft\Windows\Start Menu\Programs\SpewCap\

Usage

  1. Change settings in cargo.toml (optional)

  2. Start the program from a terminal/shell

    With config.toml configured

    ./spewcap.exe

    With command line option flags (override config.toml if it exists)

    ./spewcap.exe -p <port-name> -b <baud-rate>

    To view all options use -h or --help

    ./spewcap.exe -h

    Tip: In Windows Terminal settings, under 'Defaults > Advanced', increase 'History size' to 100,000 and save

    Use CTRL+SHIFT+F to search spew without saving a log

  3. Press L to list avaiable ports and H to view all key commands

  4. Quit the program using Q

Example

With command line option flags

./spewcap.exe -p COM5 -b 115200

With config.toml configured

# config.toml

port = 'COM5'
baud_rate = 115200
log_folder = 'C:\Users\username\Logs'
clear_on_start = true
./spewcap.exe

About

Serial monitor in rust since I don't like TeraTerm

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 100.0%