Giter VIP home page Giter VIP logo

happyserial's Introduction

HappySerial

Implementing a serial protocol is hard. happyserial deals with all the hard parts so you don't need to. Drop it in your project, both on the C and Python side.

Scope

happyserial is useful when you have a Python program running on a computer that needs to send/receive data reliably over a serial port to an embedded device. happyserial is a set of two libraries, one for the Python side, one for the C side. Your code ends up sending and receiving serial frames through those library, never having to worry about bytes, retries, framing, etc.

+----------+           +-----------+
|  Python  |   serial  |    C      |
| software |===========| firmware  |
|          |           |           |
|(computer)|           | (devices) |
+----------+           +-----------+
       
       scope of happyserial
       <------------------>

Features

  • framing of the serial stream
  • detect and drop corrupted frames

wishlist

  • retransmission when a frame is corrupted
  • uses the DMA on the nRF so your firmware routines aren't interrupted by every byte received

using happyserial

On the Python side:

from happyserial import HappySerial

def _happyserial_rx_cb(buf):
    print('rx: {}'.format(buf))
    
happy = HappySerial.HappySerial(
    serialport = 'COM41',
    rx_cb      = _happyserial_rx_cb,
)

happy.tx([0x01,0x02,0x03])

On the C side:

...
#include "happyserial.h"

int main(void) {
    uint8_t buf = {0x00,0x01,0x03};
    
    happyserial_init(_happyserial_rx_cb);
    ...
    happyserial_tx(buf,sizeof(buf));
}

void _happyserial_rx_cb(uint8_t* buf, uint8_t bufLen) {
    ...
}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.