pyngham 1.0.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.

Dependencies

• crc

Installing

This library is available in the PyPI repository, and can be installed with the following command:

• pip install pyngham

Or, directly from the source files:

• python setup.py install

Documentation

The documentation page is available here. Instructions to build the documentation page are described below.

Dependencies

• Sphinx
• sphinx-rtd-theme

Building the Documentation

The documentation pages can be built with Sphinx by running the following command inside the docs folder:

• make html

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

pngh = PyNGHam()

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

pkt = pngh.encode(data)

print("Encoded packet:", pkt)

pl, errors, errors_pos = pngh.decode(pkt)

print("Decoded data:", pl)
print("Number of errors:", errors)
print("Errors positions:", errors_pos)

More usage examples can be found in the documentation page.

License

This project is licensed under LGPLv3 license.