|
1 | 1 | # qCommTest |
2 | 2 |
|
3 | | -[](https://github.com/diffstorm/ViterbiTrellis/blob/main/LICENSE) |
4 | | -[](https://github.com/diffstorm/ViterbiTrellis) |
| 3 | +[](https://github.com/diffstorm/qCommTest/blob/main/LICENSE) |
| 4 | +[](https://github.com/diffstorm/qCommTest) |
5 | 5 |
|
6 | | -Serial Communication Test Tool |
7 | | -- Serial COM Port / RS232 |
8 | | -- TCP |
| 6 | +A simple tool for testing serial (RS232) and TCP communication. |
| 7 | + |
| 8 | +## Features |
| 9 | + |
| 10 | +- **Serial Port Communication:** Test communication with devices connected to serial ports. |
| 11 | +- **TCP Server:** Create a TCP server to test network communication. |
| 12 | +- **Cross-Platform:** Build and run on Windows, macOS, and Linux. |
| 13 | +- **Qt5 and Qt6 Support:** Compatible with both Qt5 and Qt6 versions. |
9 | 14 |
|
10 | 15 | ## Usage |
| 16 | + |
11 | 17 |  |
12 | 18 |
|
13 | | -## :snowman: Author |
14 | | -Eray Öztürk ([@diffstorm](https://github.com/diffstorm)) |
| 19 | +1. **Configure and start the communication port:** |
| 20 | + - For serial communication, select the port, baud rate, and other settings. |
| 21 | + - For TCP communication, set the port and start the server. |
| 22 | +2. **Run the test code on the device:** The device should send and receive data according to the test protocol. |
| 23 | +3. **Observe the log section:** The log section will show the test results and any errors that occur. |
| 24 | + |
| 25 | +## Installation |
| 26 | + |
| 27 | +### Prerequisites |
| 28 | + |
| 29 | +- **CMake:** A cross-platform build system generator. |
| 30 | +- **Qt:** A cross-platform application framework. You can use either Qt5 or Qt6. |
| 31 | +- **C++ Compiler:** A C++ compiler that is compatible with the Qt version you are using. |
| 32 | + |
| 33 | +### Windows |
| 34 | + |
| 35 | +1. **Install Chocolatey:** If you don't have Chocolatey, install it by following the instructions on the [Chocolatey website](https://chocolatey.org/install). |
| 36 | +2. **Install CMake, Qt, and a compiler:** |
| 37 | + ```bash |
| 38 | + choco install cmake qt-creator-ide qt6-base qt6-serialport |
| 39 | + ``` |
| 40 | +3. **Build the project:** |
| 41 | + ```bash |
| 42 | + mkdir build |
| 43 | + cd build |
| 44 | + cmake .. |
| 45 | + cmake --build . |
| 46 | + ``` |
| 47 | + |
| 48 | +### macOS |
| 49 | + |
| 50 | +1. **Install Homebrew:** If you don't have Homebrew, install it by following the instructions on the [Homebrew website](https://brew.sh/). |
| 51 | +2. **Install CMake and Qt:** |
| 52 | + ```bash |
| 53 | + brew install cmake qt5 |
| 54 | + ``` |
| 55 | + *Note: You can also use `qt6` instead of `qt5`.* |
| 56 | +3. **Build the project:** |
| 57 | + ```bash |
| 58 | + mkdir build |
| 59 | + cd build |
| 60 | + cmake .. |
| 61 | + cmake --build . |
| 62 | + ``` |
| 63 | +
|
| 64 | +### Linux (Ubuntu) |
| 65 | +
|
| 66 | +1. **Install dependencies:** |
| 67 | + ```bash |
| 68 | + sudo apt-get update |
| 69 | + sudo apt-get install build-essential cmake qtcreator qtbase5-dev qtserialport5-dev |
| 70 | + ``` |
| 71 | + *Note: For Qt6, you can use `qt6-base-dev` and `qt6-serialport-dev`.* |
| 72 | +2. **Build the project:** |
| 73 | + ```bash |
| 74 | + mkdir build |
| 75 | + cd build |
| 76 | + cmake .. |
| 77 | + cmake --build . |
| 78 | + ``` |
| 79 | +
|
| 80 | +## Author |
| 81 | +
|
| 82 | +Eray Öztürk ([@diffstorm](https://github.com/diffstorm)) |
| 83 | +
|
| 84 | +## License |
15 | 85 |
|
16 | | -## LICENSE |
17 | | -This project is licensed under the [GPL-3 License](LICENSE) - see the LICENSE file for details. |
| 86 | +This project is licensed under the [GPL-3.0-only License](LICENSE). |
0 commit comments