Skip to main content

Cross platform serial debug assistant

Project description

COMTool
========

[![PyPI](https://img.shields.io/pypi/v/comtool.svg)](https://pypi.python.org/pypi/comtool/)

A cross platform serial debug tools written by python
![screenshot](./COMToolData/assets/screenshot_V1.3.png)
> screenshot shows the version 1.0, the latest may not the same totally! But better performance、more easy to use and more elegant

## Features

- [x] cross platform
- [x] port baudrate bytesize parity stopbits settings
- [x] basic send data (ascii and hex)
- [x] basic receive data (ascii and hex)
- [x] send and receive data count
- [x] clear received data area
- [x] auto linefeed on every once receive
- [x] scheduled auto send
- [x] send history and select send again
- [x] serial auto detect
- [x] CR LF / LF select support
- [x] auto save settings
- [x] <kbd>Ctrl+Enter</kbd> to send
- [ ] escape character support, like \x \r \n etc.
- [ ] multiple character encode support
- [ ] multiple auto send (order and disorder)
- [ ] unix style terminal color support
- [x] night theme and White theme
- [ ] real time data graphic display

## Install

### Windows

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](https://github.com/Neutree/COMTool/releases)
* unzip, and run comtool.exe
2. Install Python3 first then install from pypi:
* [dowload python3](https://www.python.org/downloads/)
* Install by pip,
```
pip install comtool
comtool
```
3. 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

* download and install
```
sudo apt install python3
sudo apt install python3-pip
sudo pip3 install comtool
sudo comtool
```
or
```
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.



Or you can download source code, then install from source code
* download sourcecode
```
python setup.py bdist_wheel
sudo pip3 install dist/COMTool-*.*.*-py3-none-any.whl
```


### macOS

```
brew install python3 python3-pip
pip install COMTool
```

## Development

1. Install python3.6 and pip
Linux:
```
sudo apt install python3 python3-pip
```

Windows:
[dowload python3](https://www.python.org/downloads/)

2. install pyserial and PyQt5
```
pip install pyserail pyqt5
```

3. clone project
```
git clone https://github.com/Neutree/COMTool.git
```

4. code, resolve bugs or add new reatures


5. pull request




Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

COMTool-1.4.0-py3-none-any.whl (48.3 kB view details)

Uploaded Python 3

File details

Details for the file COMTool-1.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for COMTool-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2100a9e5ea488545fed730cf7ea60f9f35a4dcd3c868e7c9f3ef631ec7e8e495
MD5 ad56e6a95ab44c146d51d50a5317051a
BLAKE2b-256 f977a1c96d852f09d09cb6119390c530bdb006acd74d0c91d24e492fd16158b1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page