aprscot - APRS Cursor-on-Target Gateway.
****************************************
.. image:: https://raw.githubusercontent.com/ampledata/aprscot/main/docs/screenshot_1637083240_16797-50p.png
:alt: Screenshot of APRS PLI in ATAK.
:target: https://raw.githubusercontent.com/ampledata/aprscot/main/docs/screenshot_1637083240_16797.png
The APRS to Cursor On Target Gateway (APRSCOT) provides beyond line-of-sight
blue force tracking capabilities using commercial off the shelf components.
This gateway uses the Automatic Packet Reporting System (APRS) and APRS-IS
network to forward APRS position reports to Cursor On Target (COT) clients
such as the Android Team Awareness Kit (ATAK), WinTAK, et al. Other
situational awareness & common operating picture platforms are supported
through use of COT, such as TAKX & COPERS.
APRS Frames can also be transformed or callsigns normalized before forwarding
as COT. Almost any network destination is available, including TCP & UDP
Mulitcast.
Features of ``aprscot``:
* Handles APRS-IS transported APRS Frames from over-the-air or Internet-based stations.
* Can transform APRS station callsign, COT Type and COT Icon for display in TAK systems.
* Can run as a service ('daemon') on any Linux system.
* Can send COT Events to any destination supported by `PyTAK <https://github.com/ampledata/pytak>`_: TLS/SSL, TCP, UDP, UDP Multicast.
See also:
* Hayt's `APRS-TAK ATAK Plugin <https://drive.google.com/drive/folders/1o8tsalgxUGxdg2HiDw5xVu_-bnr63F3d>`_
* Alan Barrow's aprstak: https://github.com/pinztrek/aprstak
Concept:
.. image:: https://raw.githubusercontent.com/ampledata/aprscot/main/docs/aprscot-concept.png
:alt: APRSCOT concept diagram.
:target: https://raw.githubusercontent.com/ampledata/aprscot/main/docs/aprscot-concept.png
Support Development
===================
**Tech Support**: Email support@undef.net or Signal/WhatsApp: +1-310-621-9598
This tool has been developed for the Disaster Response, Public Safety and
Frontline Healthcare community. This software is currently provided at no-cost
to users. Any contribution you can make to further this project's development
efforts is greatly appreciated.
.. image:: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png
:target: https://www.buymeacoffee.com/ampledata
:alt: Support Development: Buy me a coffee!
Installation
============
The APRS to COT gateway is service started with a command-line tool
called ``aprscot``. There are three options for installing ``aprscot``, in order
preferred option they are:
**Option I: Install as a Debian / Ubuntu Package**::
$ wget https://github.com/ampledata/pytak/releases/latest/download/python3-pytak_latest_all.deb
$ sudo apt install -f ./python3-pytak_latest_all.deb
$ wget https://github.com/ampledata/aprs-python/releases/latest/download/python3-aprslib_latest_all.deb
$ sudo apt install -f ./python3-aprslib_latest_all.deb
$ wget https://github.com/ampledata/aprscot/releases/latest/download/python3-aprscot_latest_all.deb
$ sudo apt install -f ./python3-aprscot_latest_all.deb
Option II: Install from the Python Package Index (PyPI)::
$ python3 -m pip install aprscot
Option III: Install from this source tree::
$ git clone https://github.com/ampledata/aprscot.git
$ cd aprscot/
$ python3 setup.py install
Usage
=====
The ``aprscot`` program has one command-line argument::
$ aprscot -h
usage: aprscot [-h] [-c CONFIG_FILE]
optional arguments:
-h, --help show this help message and exit
-c CONFIG_FILE, --CONFIG_FILE CONFIG_FILE
You must create a configuration file, see ``example-config.ini`` in the source
repository.
An example config, ``COT_URL`` is our COT destination server or client::
[aprscot]
COT_URL = tcp://takserver.example.com:8088
`APRS-IS Server-side Filter Commands <http://www.aprs-is.net/javAPRSFilter.aspx>`_
can be used to filter incoming APRS Frames::
[aprscot]
COT_URL = tcp:takserver.example.com:8088
APRSIS_FILTER = f/W6PW-10/50
PLI Transforms can be created using per-station sections. In this example,
we're overriding ``W2GMD-9``'s COT Type & Callsign, and ``NB6F-2``'s Callsign::
[aprscot]
COT_URL = tcp:takserver.example.com:8088
[W2GMD-9]
COT_TYPE = a-f-G-U-C
COT_STALE = 600
COT_NAME = Medic 52
[NB6F-2]
COT_NAME = Transport 2
Source
======
Github: https://github.com/ampledata/aprscot
Author
======
Greg Albrecht W2GMD oss@undef.net
https://ampledata.org/
Copyright
=========
* APRSCOT is Copyright 2022 Greg Albrecht <oss@undef.net>
* `Automatic Packet Reporting System (APRS) <http://www.aprs.org/>`_ is Copyright Bob Bruninga WB4APR (SK) wb4apr@amsat.org
License
=======
Copyright 2022 Greg Albrecht <oss@undef.net>
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/ampledata/aprscot",
"name": "aprscot",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Ham Radio,APRS,Cursor on Target,ATAK,TAK,CoT",
"author": "Greg Albrecht",
"author_email": "oss@undef.net",
"download_url": "https://files.pythonhosted.org/packages/83/70/ec94528f806ad4db5504efa895896f50a0a89e5409f4e05bfcb6c55899fb/aprscot-6.1.0.tar.gz",
"platform": null,
"description": "aprscot - APRS Cursor-on-Target Gateway.\n****************************************\n\n.. image:: https://raw.githubusercontent.com/ampledata/aprscot/main/docs/screenshot_1637083240_16797-50p.png\n :alt: Screenshot of APRS PLI in ATAK.\n :target: https://raw.githubusercontent.com/ampledata/aprscot/main/docs/screenshot_1637083240_16797.png\n\nThe APRS to Cursor On Target Gateway (APRSCOT) provides beyond line-of-sight \nblue force tracking capabilities using commercial off the shelf components. \nThis gateway uses the Automatic Packet Reporting System (APRS) and APRS-IS \nnetwork to forward APRS position reports to Cursor On Target (COT) clients \nsuch as the Android Team Awareness Kit (ATAK), WinTAK, et al. Other \nsituational awareness & common operating picture platforms are supported \nthrough use of COT, such as TAKX & COPERS.\n\nAPRS Frames can also be transformed or callsigns normalized before forwarding \nas COT. Almost any network destination is available, including TCP & UDP \nMulitcast.\n\nFeatures of ``aprscot``:\n\n* Handles APRS-IS transported APRS Frames from over-the-air or Internet-based stations.\n* Can transform APRS station callsign, COT Type and COT Icon for display in TAK systems.\n* Can run as a service ('daemon') on any Linux system.\n* Can send COT Events to any destination supported by `PyTAK <https://github.com/ampledata/pytak>`_: TLS/SSL, TCP, UDP, UDP Multicast.\n\nSee also:\n\n* Hayt's `APRS-TAK ATAK Plugin <https://drive.google.com/drive/folders/1o8tsalgxUGxdg2HiDw5xVu_-bnr63F3d>`_\n* Alan Barrow's aprstak: https://github.com/pinztrek/aprstak\n\nConcept:\n\n.. image:: https://raw.githubusercontent.com/ampledata/aprscot/main/docs/aprscot-concept.png\n :alt: APRSCOT concept diagram.\n :target: https://raw.githubusercontent.com/ampledata/aprscot/main/docs/aprscot-concept.png\n\n\nSupport Development\n===================\n\n**Tech Support**: Email support@undef.net or Signal/WhatsApp: +1-310-621-9598\n\nThis tool has been developed for the Disaster Response, Public Safety and\nFrontline Healthcare community. This software is currently provided at no-cost\nto users. Any contribution you can make to further this project's development\nefforts is greatly appreciated.\n\n.. image:: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png\n :target: https://www.buymeacoffee.com/ampledata\n :alt: Support Development: Buy me a coffee!\n\n\nInstallation\n============\n\nThe APRS to COT gateway is service started with a command-line tool \ncalled ``aprscot``. There are three options for installing ``aprscot``, in order \npreferred option they are:\n\n**Option I: Install as a Debian / Ubuntu Package**::\n\n $ wget https://github.com/ampledata/pytak/releases/latest/download/python3-pytak_latest_all.deb\n $ sudo apt install -f ./python3-pytak_latest_all.deb\n $ wget https://github.com/ampledata/aprs-python/releases/latest/download/python3-aprslib_latest_all.deb\n $ sudo apt install -f ./python3-aprslib_latest_all.deb\n $ wget https://github.com/ampledata/aprscot/releases/latest/download/python3-aprscot_latest_all.deb\n $ sudo apt install -f ./python3-aprscot_latest_all.deb\n\n\nOption II: Install from the Python Package Index (PyPI)::\n\n $ python3 -m pip install aprscot\n\n\nOption III: Install from this source tree::\n\n $ git clone https://github.com/ampledata/aprscot.git\n $ cd aprscot/\n $ python3 setup.py install\n\n\nUsage\n=====\n\nThe ``aprscot`` program has one command-line argument::\n\n $ aprscot -h\n usage: aprscot [-h] [-c CONFIG_FILE]\n\n optional arguments:\n -h, --help show this help message and exit\n -c CONFIG_FILE, --CONFIG_FILE CONFIG_FILE\n\nYou must create a configuration file, see ``example-config.ini`` in the source\nrepository.\n\nAn example config, ``COT_URL`` is our COT destination server or client::\n\n [aprscot]\n COT_URL = tcp://takserver.example.com:8088\n\n\n`APRS-IS Server-side Filter Commands <http://www.aprs-is.net/javAPRSFilter.aspx>`_ \ncan be used to filter incoming APRS Frames::\n\n [aprscot]\n COT_URL = tcp:takserver.example.com:8088\n APRSIS_FILTER = f/W6PW-10/50\n\nPLI Transforms can be created using per-station sections. In this example, \nwe're overriding ``W2GMD-9``'s COT Type & Callsign, and ``NB6F-2``'s Callsign::\n\n [aprscot]\n COT_URL = tcp:takserver.example.com:8088\n\n [W2GMD-9]\n COT_TYPE = a-f-G-U-C\n COT_STALE = 600\n COT_NAME = Medic 52\n\n [NB6F-2]\n COT_NAME = Transport 2\n\n\nSource\n======\nGithub: https://github.com/ampledata/aprscot\n\n\nAuthor\n======\nGreg Albrecht W2GMD oss@undef.net\n\nhttps://ampledata.org/\n\n\nCopyright\n=========\n\n* APRSCOT is Copyright 2022 Greg Albrecht <oss@undef.net>\n* `Automatic Packet Reporting System (APRS) <http://www.aprs.org/>`_ is Copyright Bob Bruninga WB4APR (SK) wb4apr@amsat.org\n\n\nLicense\n=======\n\nCopyright 2022 Greg Albrecht <oss@undef.net>\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "APRS Cursor-on-Target Gateway.",
"version": "6.1.0",
"project_urls": {
"Homepage": "https://github.com/ampledata/aprscot"
},
"split_keywords": [
"ham radio",
"aprs",
"cursor on target",
"atak",
"tak",
"cot"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "27e4fc5aff17f87f8a81aac68c8df6a609ffcb875e8857267f969e08ebafdf3a",
"md5": "9bd046f93b9f14fbe0447bfc2a63dfb3",
"sha256": "5336bd3857f3daf3497f7be69aca28bcbc2f7137b04010279b9514221165dc54"
},
"downloads": -1,
"filename": "aprscot-6.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9bd046f93b9f14fbe0447bfc2a63dfb3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10352,
"upload_time": "2022-10-06T05:21:25",
"upload_time_iso_8601": "2022-10-06T05:21:25.859885Z",
"url": "https://files.pythonhosted.org/packages/27/e4/fc5aff17f87f8a81aac68c8df6a609ffcb875e8857267f969e08ebafdf3a/aprscot-6.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8370ec94528f806ad4db5504efa895896f50a0a89e5409f4e05bfcb6c55899fb",
"md5": "776d4f84629a38151e2210ab317ecc20",
"sha256": "fb13a122a7a1487b25f5c32b4220f281f62430dd65cb4076440ac0979a6bd0d8"
},
"downloads": -1,
"filename": "aprscot-6.1.0.tar.gz",
"has_sig": false,
"md5_digest": "776d4f84629a38151e2210ab317ecc20",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7305,
"upload_time": "2022-10-06T05:21:27",
"upload_time_iso_8601": "2022-10-06T05:21:27.334989Z",
"url": "https://files.pythonhosted.org/packages/83/70/ec94528f806ad4db5504efa895896f50a0a89e5409f4e05bfcb6c55899fb/aprscot-6.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-10-06 05:21:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ampledata",
"github_project": "aprscot",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aprscot"
}
JSON
