pyngham 0.1.0

PyNGHam library

PyNGHam

Overview

The PyNGHAm library is a Python version of the original NGHam protocol library written in C by Jon Petter Skagmo (LA3JPA).

The original implementation and a further description of the protocol can be found here.

NOTE: For now, this implementation uses a different Reed Solomon configuration from the original library.

Dependencies

• crc
• reedsolo

Installing

• pip3 install pyngham

Or, from the source files:

• python setup.py install

Documentation

Dependencies

• sphinx-rtd-theme

Building the Documentation

• python setup.py build_sphinx

Usage Example

The usage of the library is pretty straightforward, after the initialization, there are two methods: one to encode a list of bytes, and other to decode a packet. Below there is a basic usage example:

from pyngham import PyNGHam

data = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]

pkt = PyNGHam().encode(data)

pl, errors = PyNGHam().decode(pkt)

print(pl)

License

This project is licensed under LGPLv3 license.