kiss3 - Python KISS Module
**************************
.. image:: https://github.com/python-aprs/kiss3/actions/workflows/pytest.yml/badge.svg
:target: https://github.com/python-aprs/kiss3/actions
kiss3 is a Python Module that implements the
`KISS Protocol <https://en.wikipedia.org/wiki/KISS_(TNC)>`_ for
communicating with KISS-enabled devices (such as Serial or TCP TNCs)
and provides support for encoding and decoding AX.25 frames.
Versions
========
- 8.x branch from ``python-aprs`` as ``kiss3``, supports python 3.6+
Previous versions were released by ``ampledata`` as ``kiss``:
- 7.x.x branch and-on will be Python 3.x ONLY.
- 6.5.x branch will be the last version of this Module that supports Python 2.7.x
Installation
============
Install from pypi using pip: ``pip install kiss3``
Usage Examples
==============
Read & print frames from a TNC connected to '/dev/ttyUSB0' at 1200 baud::
import kiss
def p(x): print(x) # prints whatever is passed in.
k = kiss.SerialKISS('/dev/ttyUSB0', 1200)
k.start() # inits the TNC, optionally passes KISS config flags.
k.read(callback=p) # reads frames and passes them to `p`.
See also: examples/ directory.
Testing
=======
Run tox::
tox
See Also
========
* `Python APRS Module <https://github.com/python-aprs/aprs3>`_ Library for sending, receiving and parsing APRS Frames to and from multiple Interfaces
* `Python KISS Module <https://github.com/python-aprs/kiss3>`_ Handles interfacing-to and encoding-for various KISS Interfaces.
* `Python APRS Gateway <https://github.com/ampledata/aprsgate>`_ Uses Redis PubSub to run a multi-interface APRS Gateway.
* `Python APRS Tracker <https://github.com/ampledata/aprstracker>`_ TK.
* `dirus <https://github.com/ampledata/dirus>`_ Dirus is a daemon for managing a SDR to Dire Wolf interface. Manifests that interface as a KISS TCP port.
Similar Projects
================
* `apex <https://github.com/Syncleus/apex>`_ by Jeffrey Phillips Freeman (WI2ARD). Next-Gen APRS Protocol. (based on this Module! :)
* `aprslib <https://github.com/rossengeorgiev/aprs-python>`_ by Rossen Georgiev. A Python APRS Library with build-in parsers for several Frame types.
* `aprx <http://thelifeofkenneth.com/aprx/>`_ by Matti & Kenneth. A C-based Digi/IGate Software for POSIX platforms.
* `dixprs <https://sites.google.com/site/dixprs/>`_ by HA5DI. A Python APRS project with KISS, digipeater, et al., support.
* `APRSDroid <http://aprsdroid.org/>`_ by GE0RG. A Java/Scala Android APRS App.
* `YAAC <http://www.ka2ddo.org/ka2ddo/YAAC.html>`_ by KA2DDO. A Java APRS Client.
* `Ham-APRS-FAP <http://search.cpan.org/dist/Ham-APRS-FAP/>`_ by aprs.fi: A Perl APRS Parser.
* `Dire Wolf <https://github.com/wb2osz/direwolf>`_ by WB2OSZ. A C-Based Soft-TNC for interfacing with sound cards. Can present as a KISS interface!
Source
======
Github: https://github.com/ampledata/kiss
Authors
=======
Greg Albrecht W2GMD oss@undef.net
http://ampledata.org/
Masen Furer KF7HVM kf7hvm@0x26.net
Copyright
=========
Copyright 2022 Masen Furer and Contributors
Copyright 2017 Greg Albrecht and Contributors
`Automatic Packet Reporting System (APRS) <http://www.aprs.org/>`_ is Copyright Bob Bruninga WB4APR wb4apr@amsat.org
License
=======
Apache License, Version 2.0. See LICENSE for details.
Raw data
{
"_id": null,
"home_page": "",
"name": "kiss3",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Ham Radio,APRS,KISS",
"author": "",
"author_email": "Masen Furer KF7HVM <kf7hvm@0x26.net>, Greg Albrecht W2GMD <oss@undef.net>",
"download_url": "https://files.pythonhosted.org/packages/8b/66/f2a20256f697ca1e55fe25778bfcdd884e0135af687f32d43001e47146ea/kiss3-8.0.0.tar.gz",
"platform": null,
"description": "kiss3 - Python KISS Module\n**************************\n\n.. image:: https://github.com/python-aprs/kiss3/actions/workflows/pytest.yml/badge.svg\n :target: https://github.com/python-aprs/kiss3/actions\n\nkiss3 is a Python Module that implements the\n`KISS Protocol <https://en.wikipedia.org/wiki/KISS_(TNC)>`_ for\ncommunicating with KISS-enabled devices (such as Serial or TCP TNCs)\nand provides support for encoding and decoding AX.25 frames.\n\nVersions\n========\n\n- 8.x branch from ``python-aprs`` as ``kiss3``, supports python 3.6+\n\nPrevious versions were released by ``ampledata`` as ``kiss``:\n\n- 7.x.x branch and-on will be Python 3.x ONLY.\n- 6.5.x branch will be the last version of this Module that supports Python 2.7.x\n\nInstallation\n============\nInstall from pypi using pip: ``pip install kiss3``\n\n\nUsage Examples\n==============\nRead & print frames from a TNC connected to '/dev/ttyUSB0' at 1200 baud::\n\n import kiss\n\n def p(x): print(x) # prints whatever is passed in.\n\n k = kiss.SerialKISS('/dev/ttyUSB0', 1200)\n k.start() # inits the TNC, optionally passes KISS config flags.\n k.read(callback=p) # reads frames and passes them to `p`.\n\n\nSee also: examples/ directory.\n\n\nTesting\n=======\nRun tox::\n\n tox\n\n\nSee Also\n========\n\n* `Python APRS Module <https://github.com/python-aprs/aprs3>`_ Library for sending, receiving and parsing APRS Frames to and from multiple Interfaces\n* `Python KISS Module <https://github.com/python-aprs/kiss3>`_ Handles interfacing-to and encoding-for various KISS Interfaces.\n* `Python APRS Gateway <https://github.com/ampledata/aprsgate>`_ Uses Redis PubSub to run a multi-interface APRS Gateway.\n* `Python APRS Tracker <https://github.com/ampledata/aprstracker>`_ TK.\n* `dirus <https://github.com/ampledata/dirus>`_ Dirus is a daemon for managing a SDR to Dire Wolf interface. Manifests that interface as a KISS TCP port.\n\n\nSimilar Projects\n================\n\n* `apex <https://github.com/Syncleus/apex>`_ by Jeffrey Phillips Freeman (WI2ARD). Next-Gen APRS Protocol. (based on this Module! :)\n* `aprslib <https://github.com/rossengeorgiev/aprs-python>`_ by Rossen Georgiev. A Python APRS Library with build-in parsers for several Frame types.\n* `aprx <http://thelifeofkenneth.com/aprx/>`_ by Matti & Kenneth. A C-based Digi/IGate Software for POSIX platforms.\n* `dixprs <https://sites.google.com/site/dixprs/>`_ by HA5DI. A Python APRS project with KISS, digipeater, et al., support.\n* `APRSDroid <http://aprsdroid.org/>`_ by GE0RG. A Java/Scala Android APRS App.\n* `YAAC <http://www.ka2ddo.org/ka2ddo/YAAC.html>`_ by KA2DDO. A Java APRS Client.\n* `Ham-APRS-FAP <http://search.cpan.org/dist/Ham-APRS-FAP/>`_ by aprs.fi: A Perl APRS Parser.\n* `Dire Wolf <https://github.com/wb2osz/direwolf>`_ by WB2OSZ. A C-Based Soft-TNC for interfacing with sound cards. Can present as a KISS interface!\n\nSource\n======\nGithub: https://github.com/ampledata/kiss\n\nAuthors\n=======\nGreg Albrecht W2GMD oss@undef.net\n\nhttp://ampledata.org/\n\nMasen Furer KF7HVM kf7hvm@0x26.net\n\nCopyright\n=========\nCopyright 2022 Masen Furer and Contributors\n\nCopyright 2017 Greg Albrecht and Contributors\n\n`Automatic Packet Reporting System (APRS) <http://www.aprs.org/>`_ is Copyright Bob Bruninga WB4APR wb4apr@amsat.org\n\nLicense\n=======\nApache License, Version 2.0. See LICENSE for details.\n",
"bugtrack_url": null,
"license": "Copyright 2017 Greg Albrecht and Contributors Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.",
"summary": "A pure-Python implementation of serial KISS and KISS-over-TCP protocols for communicating with TNC devices",
"version": "8.0.0",
"project_urls": {
"Homepage": "https://github.com/python-aprs/kiss3"
},
"split_keywords": [
"ham radio",
"aprs",
"kiss"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2b8f8aa885553dc126a5fa5277cf2879c5bff85cf3cb200ba2f9a6b26b53d37e",
"md5": "9dad5ff260950eef2fc6a9d5ac3c51f1",
"sha256": "374cbd86ac817c811dbddab12053e13563f34bcfa43eca7aed49a94d91083bba"
},
"downloads": -1,
"filename": "kiss3-8.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9dad5ff260950eef2fc6a9d5ac3c51f1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11261,
"upload_time": "2022-06-13T02:57:39",
"upload_time_iso_8601": "2022-06-13T02:57:39.481083Z",
"url": "https://files.pythonhosted.org/packages/2b/8f/8aa885553dc126a5fa5277cf2879c5bff85cf3cb200ba2f9a6b26b53d37e/kiss3-8.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8b66f2a20256f697ca1e55fe25778bfcdd884e0135af687f32d43001e47146ea",
"md5": "837460676f29e86515ba0f150ee63360",
"sha256": "076006a0d7a36157533196d1e41787b217cbd5a4e348b20322c2ab6dae238425"
},
"downloads": -1,
"filename": "kiss3-8.0.0.tar.gz",
"has_sig": false,
"md5_digest": "837460676f29e86515ba0f150ee63360",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 17123,
"upload_time": "2022-06-13T02:57:42",
"upload_time_iso_8601": "2022-06-13T02:57:42.332877Z",
"url": "https://files.pythonhosted.org/packages/8b/66/f2a20256f697ca1e55fe25778bfcdd884e0135af687f32d43001e47146ea/kiss3-8.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-06-13 02:57:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "python-aprs",
"github_project": "kiss3",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "kiss3"
}
JSON
