pyham_kiss 1.0.0

KISS TNC Protocol Client for TCP/IP

PyHam KISS

Overview

This package provides a client implementation for the KISS TNC protocol, providing send and receive capability via a TCP/IP connection. All commands are supported in sending to the TNC; per the spec, only data frames are supported when receiving from the TNC. Multi-port TNCs are supported.

This implementation has been tested with Direwolf as the server.

It is expected that developers working with this package will have some level of knowledge of the KISS protocol. Those less familiar with the protocol may wish to refer to the KISS protocol specification in conjunction with the documentation for this package.

Author: Martin F N Cooper, KD6YAM
License: MIT License

Limitations

• This package supports only TCP/IP connection to a KISS server. It does not support serial connection, nor are there plans to add such support.

Installation

Important: This package requires Python 3.7 or later.

The PyHam KISS package is distributed on PyPI, and should be installed with pip as follows:

$ pip install pyham_kiss

Then import the module in your code using:

   import kiss

The source code is available from the GitHub repository:

$ git clone https://github.com/mfncooper/pyham_kiss

Documentation

Full documentation is available online and includes the following:

User Guide

The User Guide walks through some use cases for the package, starting from the basics and adding capability as it progresses.

Examples

Complete example applications are included, in order that a developer can observe the usage of the package in a real-world scenario.

API Reference

If you are looking for information on a specific function, class, or method, this part of the documentation is for you.

References

KISS protocol reference:

http://www.ka9q.net/papers/kiss.html

Direwolf:

https://github.com/wb2osz/direwolf

About PyHam

PyHam is a collection of Python packages targeted at ham radio enthusiasts who are also software developers. The name was born out of a need to find unique names for these packages when the most obvious names were already taken.

PyHam packages aim to provide the kind of functionality that makes it much simpler to build sophisticated ham radio applications without having to start from scratch. In addition to the packages, PyHam aims to provide useful real-world ham radio applications for all hams.

See the PyHam home page for more information, and a list of currently available libraries and applications.