kawoogie / serial_monitor

Code to monitor serial output. It gives the option to change the serial port, baud rate, and save the file. Written for Windows machines.

Serial Monitor and Logger Tool

This code monitors the serial ports of a Windows machine for serial communication over the COM ports. It gives a list of available ports and allows you to change the baud rate. It also provides the option to save the code while choosing the save location.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

This project is just a simple serial monitor that I wrote to meet my needs. I found that I needed to record the output of a serial monitor repeatedly, saving in a date time stamped file.

Note: This code is only tested on Windows machines. It has not been tested on Mac OS or Linux.

(back to top)

Getting Started

This code can be run from your favorite IDE with a serial monitor, or turned into an .exe file and run that way.

Prerequisites

The code only needs standard Python packages: os, serial, datetime

### Installation

The code needs to be copied to your machine and run in your favorite IDE

(back to top)

Usage

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/Kawoogie/Serial_Monitor

(back to top)