Cross platform serial debug assistant


Keywords
Serial Debug Tool Assistant, assistant, debug, python, serial, tool
License
LGPL-3.0
Install
pip install COMTool==1.7.8

Documentation

COMTool

PyPI

Build Status

A cross platform serial debug tools written by python

Windows Windows screenshot Linux(Elementry OS) Linux(Elementry OS)screenshot Raspberry Pi3 Raspberry Pi screenshot

screenshot shows the version 1.0, the latest may not the same totally! But better performance、more easy to use and more elegant

Features

  • cross platform (Windows, Linux, MacOS, Raspberry Pi ... ...)
  • port baudrate bytesize parity stopbits settings
  • basic send data (ascii and hex)
  • basic receive data (ascii and hex)
  • send and receive data count
  • clear received data area
  • auto linefeed on every once receive
  • scheduled auto send
  • send history and select send again
  • serial auto detect
  • CR LF / LF select support
  • auto save settings
  • Ctrl+Enter to send
  • escape character support, like \x \r \n etc.
  • multiple character encode support(ASII,GBK(Chinese),UTF-8,UTF-16......)
  • multiple auto send (order and disorder)
  • unix style terminal color support
  • night theme and White theme
  • real time data graphic display
  • rts & dtr control by hand

Install

Windows

Test pass on Win10

there's three ways:

  1. download excutable bin file, easiest way for one never used python
  • Download the latest bin file at the release page
  • unzip, and run comtool.exe
  1. Install Python3 first then install from pypi:
pip install comtool
comtool
  1. Or you can download source code, then install from source code
  • download sourcecode
  • install
python setup.py bdist_wheel
pip install dist/COMTool-*.*.*-py3-none-any.whl
comtool

Linux

Test on Ubuntu 16 and Elementry OS 4

there's many ways to install comtool on linux

The installation proccess will automatically install PyQt5, it may takes a long times!!! you can install pyqt5 manually by command sudo apt install python3-pyqt5 or sudo pip3 install pyqt5

  • (1) Download and install from [pypi] by pip
sudo apt install python3
sudo apt install python3-pip
sudo pip3 install comtool
sudo comtool
  • (2) Or get by tool get-pip.py
sudo apt install python3
wget https://bootstrap.pypa.io/get-pip.py 
sudo python3 get-pip.py
sudo pip3 install comtool
sudo comtool

be sure python bin path already in the $PATH env.

  • (3) Just install from github source code by pip
sudo apt install python3 python3-pip
sudo pip3 install git+https://github.com/Neutree/COMTool
sudo comtool
  • (4) Or you can download source code, then install from source code
python setup.py bdist_wheel
sudo pip3 install dist/COMTool-*.*.*-py3-none-any.whl

We should add current user to dialout group to avoid sudo command

sudo usermod -a -G dialout $USER
grep 'dialout' /etc/group
reboot #must reboot to take effect

macOS

brew install python3 python3-pip
sudo pip3 install COMTool

It will automatically install pyqt5, may takes a lot of time depend on your network

Rasberry Pi

Test pass on Raspberry Pi 3 just open terminal, type the command below:

sudo apt install git
git clone https://github.com/Neutree/COMTool.git
cd COMTool
python setup.py bdist_wheel
sudo pip3 install dist/COMTool-*.*.*-py3-none-any.whl
comtool

then enjoy

Development

  1. Install python3.6 and pip3

Linux:

sudo apt install python3 python3-pip

Windows: dowload python3

  1. install pyserial and PyQt5
sudo pip3 install pyserial pyqt5 bs4

On Raspberry:

sudo pip3 install --upgrade pyserial bs4
sudo apt install python3-pyqt5
  1. clone project
git clone https://github.com/Neutree/COMTool.git
  1. code, resolve bugs or add new reatures

Recommended PyCharm IDE to get start

  1. pull request

Issue and improvement

Create issue here