Cross platform serial debug assistant with GUI
Project description
COMTool
English | 中文
A cross platform serial debug tools written by python
Windows | Linux | Raspberry Pi | macOS |
---|---|---|---|
White theme | Dark theme | protocol plugin | TCP/UDP | Terminal | Graph |
---|---|---|---|---|---|
screenshot maybe the old version, 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)(code with python, only if your platform support python)
- reliable stability, no UI freeze
- multiple language support
- configs save and auto load(auto save settings when exit)
- multiple character encode support(
ASII,GBK(Chinese),UTF-8,UTF-16
etc.) - night theme and White theme(can create more theme if you want)
- multiple connection type support, and support add connection plugin
- serial port
- serial auto detect, and remember last selected support
- serial offline auto reconnect support
- port baudrate(any value) bytesize parity stopbits flow control etc. settings
- rts & dtr control by hand
- TCP/UDP support, include client and server mode
- SSH client support
- serial port
- plugin support(Create plugin see docs/plugins.md), built-in plugin:
- dbg plugin, support basic send receive debug operation
- basic send/receive data (ascii and hex)
- send and receive data count
- clear received data area
- auto linefeed
- scheduled auto send
- send history and select send again
- custom most usage data items and one click to send
- CR LF(\r\n) or LF(\n) support
- key shortcuts like Ctrl+Enter to send etc. More see help
- receive and send record support add timestamp and save log to file
- send file
- unix terminal style color support(e.g.
\x1b[33;42mhello\x1b[0mhello2
) - escape character support, like
\r \n \t \x
etc.
- protocol plugin, customize your own protocol
- customize encoding and decoding method
- customize shortcut key
- escape character support, like
\r \n \t \x
etc.
- terminal plugin, basic terminal interaction
- graph plugin
- support dynamicly add graph widgets, add graph widgets you need
- display line chart in realtime, support customize protocol header(support escape characters)
- customable button to send data, support shortcut key
- dbg plugin, support basic send receive debug operation
Installation
There are two ways to install COMTool:
- Download binary files and run : For Windows or macOS, and simple usage users
- Install as python package(source code) : For Linux, or need to use plugins' user, or users who know about python
Install binary
Windows
- Download the latest bin file at the release page or sourceforge
- Unzip
.zip
file, and clickcomtool.exe
to run
And you can install by scoop, maintained by StudentWeis
scoop bucket add Nightly https://github.com/StudentWeis/Nightly scoop install comtool
Linux
Linux has too much version, so we only compile binary for ubuntu. Other distribution please install from pypi or source code. If you have any idea to pack cross platform binary like flatpak or appimage, you can contribute a pull request or add an issue to tell me how to
Arch Linux and its derivative distributions can install from AUR(maintained by taotieren):
# Release version yay -S python-comtool # Development version yay -S python-comtool-git
-
Download release at release page, and extract files from
.zip
file, and clickcomtool
to run -
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
Rasberry Pi
just open terminal, type the command below:
sudo apt install git
git clone https://github.com/Neutree/COMTool.git --depth=1
cd COMTool
pip3 install .
# or
# python setup.py bdist_wheel
# sudo pip3 install dist/COMTool-*.*.*-py3-none-any.whl
- 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
then enjoy by command
comtool
macOS
- Download release at release page or sourceforge
- Install dmg package
If you want to open multiple comtool, just right click dock icon, then click New Window
.
or you can open terminal and type
open -n /Application/comtool.app
or
cd /Applicatioin/comtool.app/Contents/MacOS
./comtool
Because the program is not signed by the developer, it will warn when you open it for the first time. You need to go to
Settings -> Security and Privacy -> General
to see the promptcomtool
and clickOpen anyway
.
Windows defender shows comtool binary is malware?
If your program is download from here, it's ok, the error caused by pack issue, all the source code and pack script is here, even the pack progress is totally automated with github action, no one manually pack.
If you remain have concern, just download source code to run with python or pack yourself.
Of course, if you find a better pack way, please open issue to tell us.
Install python package
For developers or the binary not support your platform's, use this way to install
-
Install Python3 first
- If windows or macOS: dowload python3
- If linux: ubuntu for example
sudo apt install python3 python3-pip
, macOSbrew install python3 python3-pip
-
Ensure you have
pip
pip3 --version
# or
pip --version
If no this command, install by
python3 -m ensurepip
- Then install from pypi:
pip3 install comtool
comtool
for Chinese, you can use tuna mirrors to download faster by:
pip install -i https://pypi.tuna.tsinghua.edu.cn/simple comtool
- Or you can directly install from github
pip3 install git+https://github.com/Neutree/COMTool
- Or you can download source code, then install from source code
- download source code, download in web page or
git clone https://github.com/Neutree/COMTool.git
- install
- download source code, download in web page or
cd COMTool
pip install .
or build your own wheel binary
pip3 install wheel
python setup.py bdist_wheel
pip install dist/COMTool-*.*.*-py3-none-any.whl
comtool
- By the way, you 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
Manually add app to start menu on Linux
- Copy tool/comtool.desktop to
/usr/share/applications
folder(may needroot
user to do this) - Edit
/usr/share/applications/comtool.desktop
, change icon pathIcon=/usr/local/COMTool/assets/logo.ico
to actual icon path, you can also use your love icon - Then you can find comtool app in start menu(or app center)
Pack binary
pip3 install pyinstaller
python pack.py
cd dist
ls
It's better to create a virtual environment before pack to decrease the size of binary
Development
- Install python(>=3.8) and pip3
Linux:
sudo apt install python3 python3-pip
Windows: dowload python3
- install packages like
pyserial
andPyQt5
etc.(list in requirements.txt)
cd COMTool
pip3 install -r requirements.txt
On Raspberry, python3-pyqt5
can be install by apt
command:
sudo pip3 install --upgrade pyserial
sudo apt install python3-pyqt5
- clone project
git clone https://github.com/Neutree/COMTool.git
- code, resolve bugs or add new reatures
Recommended PyCharm
IDE or vscode
to get start
How to run:
Generate translate binary files first(.mo
)
python COMTool/i18n.py finish
Then execute main program
python COMTool/Main.py
- pull request
Write your own plugins in minutes
see docs/plugins.md
Add translate
- Install environment first(python pip packages in the requirments.txt)
apt install python3 python3-pip
pip3 install -r requirements.txt
- If you need to add a new lanuage, or skip
Add locale in i18n.py
locales=["en", "zh_CN", "zh_TW", "ja"]
append your language to this list, locales can be found here or wikipedia, zh_CN
for example means China Mainland, corresponding language is simplified Chinese characters, zh_TW
means China Taiwan, and language is traditional Chinese characters, you can also only use zh
to use simplified Chinese characters.
- Generate translate files
python i18n.py prepare
This command will generate .po
files in locales folder
- Translate mannually
Then translate .po
files, this is a standard translate file format which named gettext
- Generate binary translate files
to make program read faster, the text files .po
should be convert to binary file .mo
, just run command:
python i18n.py finish
and then you can see locales/<locale>/LC_MESSAGES/messages.mo
file
- Test
Run application, you will see the new translation
- Pull request
Create a PR to merge your changes to this repo
Issue and improvement
Create issue here
License
And used these open source projects as libraries:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.