com-server 0.0

A simple Python library and a REST API server that interacts with COM ports

COM-Server

Note: This is still in beta. If you want to help contribute/test, please read the contributing page.

COM-Server is a Python library and a local web server that hosts an API locally and interacts with serial or COM ports. The Python library provides a different way of sending and receiving data from the serial port using a thread, and it also gives a set of tools that simplifies the task of manipulating data to and from the port. Additionally, the server makes it easier for other processes to communicate with the serial port.

The serial communication uses pyserial as its back-end and the server uses flask-restful and Flask. Reading their documentations may help with developing with COM-Server.

NOTE: COM-Server has only been tested on:
Operating systems:

• Ubuntu 20.04 (Focal Fossa)
• Raspberry Pi OS 10 (Buster)
• Mac OS 10.15.x (Catalina)
• Mac OS 11.6 (Big Sur)

Python versions:

• Python 3.7.2
• Python 3.7.3
• Python 3.8.10

Serial ports:

• Arduino UNO
• Arduino Nano

Installation

NOTE: COM-Server only works on Python >= 3.6.

Using pip:

> pip install -U com-server

Quickstart

# launches a development server on http://0.0.0.0:8080

import com_server

conn = com_server.Connection("<port>", <baud>) 
handler = com_server.RestApiHandler(conn) 
com_server.Builtins(handler) 

handler.run_dev(host="0.0.0.0", port=8080) 

conn.disconnect()

Replace "<port>" and "<baud>" with the serial port and baud rate.

Alternatively, you can use the command line:

> com_server -p <port> -b <baud> run

Again, replace "<port>" and "<baud>" with the serial port and baud rate.

Links:

• Documentation: https://com-server.readthedocs.io/en/latest/
• Source code: https://github.com/jonyboi396825/COM-Server
• Issue tracker: https://github.com/jonyboi396825/COM-Server/issues
• Contributing: https://github.com/jonyboi396825/COM-Server/blob/master/CONTRIBUTING.md