• ComChan
  • Installation
    • From crates.io
    • From source
• Documentation Link
  • Common Commands
    • Basic Serial Monitor
    • Verbose Mode
    • Log Mode
  • Features
    • Legends
• Examples
  • "Hello World" Program
  • User Input
• Feedback Form
• Stargazers over time

ComChan

ComChan is a Blazingly Fast Serial monitor for Embedded Systems and Serial Communication.

Latest Version: 0.1.4

Installation

From crates.io

[!NOTE] cargo install NOW AVAILABLE

cargo install comchan

#Install the binary directly
cargo binstall comchan

After installing, check if it has been installed with

comchan --version

From source

# Clone from GitHub
git clone git@github.com:Vaishnav-Sabari-Girish/ComChan.git

# Clone from Codeberg
git clone ssh://git@codeberg.org/Vaishnav-Sabari-Girish/ComChan.git

cd ComChan

cargo build --release

cargo run

Documentation Link

Documentation Link : https://vaishnav.world/ComChan

Common Commands

Basic Serial Monitor

comchan -p <port> -r <baud_rate>

# OR

comchan --port <port> --baud <baud_rate>

Verbose Mode

comchan -p <port> -r <baud_rate> -v

# OR

comchan --port <port> --baud <baud_rate> --verbose

Log Mode

comchan -p <port> -r <baud_rate> -l <log_file_name>

# OR 

comchan --port <port> --baud <baud_rate> --log <log_file_name>

For an example log file , get it here

Features

• Read incoming Serial data from Serial ports
• Write to Serial port i.e Send data to Serial device.
• Basic logging.
• Write serial data to a file for later use (can be .txt , .csv and more)
• Terminal based Serial Plotter (to be implemented with the --plot command)

[!NOTE] The Serial Plotter has been implemented in the add_tui branch. You can test it out by cloning that branch.

Legends

• Implemented Features
• Yet to me implemented

Examples

"Hello World" Program

User Input

Feedback Form

The Feedback form was created using Bashforms (Forms in the terminal itself).

To give you feedback, please type this on your terminal

ssh -t bashform.me f comchan

Stargazers over time