https://github.com/0xjeremy/serial.engine

A universal serial communication engine
https://github.com/0xjeremy/serial.engine

arduino raspberry-pi robotics serial-communication

Last synced: 20 days ago
JSON representation

A universal serial communication engine

• Host: GitHub
• URL: https://github.com/0xjeremy/serial.engine
• Owner: 0xJeremy
• License: mit
• Created: 2020-06-16T18:39:41.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-03-27T00:39:41.000Z (almost 3 years ago)
• Last Synced: 2024-12-15T04:35:38.275Z (26 days ago)
• Topics: arduino, raspberry-pi, robotics, serial-communication
• Language: Python
• Homepage: https://pypi.org/project/serial.engine/
• Size: 198 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



## Installation

[Python](https://pypi.org/project/serial.engine/):

```

pip install serial.engine

```

[Node.js](https://www.npmjs.com/package/serial.engine):

```

npm install serial.engine

```

This library requires Python3 or Node.js (>= v10). It was tested extensively on Python 3.7.5 and Node.js v10.15.2 with Ubuntu 19.04.

## Features

Serial.engine enables real-time bidirectional communication between serial devices. It is implemented in Python and Node.js, with support for C++ based embedded processors (i.e., Arduino). The interface between each language is extremely similar, allowing plug and play communication, and easy swapping between languages. It is optimized for high-speed, reliable information transfer.

Its main features are:

#### Speed

Very litte overhead is used to serialize and send the messages, with the priority being speed and reliability. Serial.engine operates using JSON serialization, and verifies all incoming and outgoing messages meet the proper specification before being sent.

#### Easy to use

This library was designed to lower the barrier to entry as much as possible. As such, it was built as a wrapper for serial device interfaces to send large amount of information quickly and reliably.

## Documentation

[Python Documentation](https://github.com/0xJeremy/serial.engine/blob/master/python/README.md)

[Node.js Documentation](https://github.com/0xJeremy/serial.engine/blob/master/nodejs/README.md)