elviseshikena/sermon

:pager: QT Serial communication interface

Sermon

Cross platform serial communication desktop interface

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

git clone https://github.com/eeshiken/Sermon.git

Prerequisites

What things you need to install the software and how to install them

• Python == 3.6.7
• PyQt5 == 5.11.3
• pyserial == 3.4

Installing

A step by step series of examples that tell you how to get a development env running

Tested on Ubuntu 18.04

Make sure python3 is installed on your system

sudo apt install python3 python3-pip

Navigate into the cloned repository and install the requirements

cd Sermon
python3 -m pip install -r requirements.txt

Run program to ensure no errors (while in the Sermon directory)

# Sermon/
python3 -m sermon

Test system by connecting a serial device (e.g Arduino). Clicking refresh should display the name of the connected device in the drop-down.

Built With

• Qt - The base framework used
• PyQt - Development framework used
• PySerial - Used to communicate with serial devices

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License - see the LICENSE file for details