mostly documentation updates

Author: ampledata

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2021 Greg Albrecht
+Copyright 2022 Greg Albrecht
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

Makefile

@@ -2,7 +2,7 @@
 #
 # Source:: https://github.com/ampledata/aprscot
 # Author:: Greg Albrecht W2GMD <oss@undef.net>
-# Copyright:: Copyright 2021 Greg Albrecht
+# Copyright:: Copyright 2022 Greg Albrecht
 # License:: Apache License, Version 2.0
 #
 

README.rst

@@ -7,10 +7,10 @@ IF YOU HAVE AN URGENT OPERATIONAL NEED: Email ops@undef.net or call/sms +1-415-5
    :alt: Screenshot of APRS PLI in ATAK..
    :target: https://raw.githubusercontent.com/ampledata/aprscot/main/docs/screenshot_1637083240_16797.png
 
-The ``aprscot`` "APRS to Cursor On Target (COT) Gateway" transforms APRS Frames
-into COT Position Location Information (PLI) Points, compatible with
-Situational Awareness (SA) and Common Operating Picture (COP) applications such
-as Android Team Awareness Kit (ATAK), WinTAK, RaptorX, COPERS, et al.
+The ``aprscot`` "APRS to Cursor On Target (COT) Gateway" transforms APRS 
+Frames into COT Position Location Information (PLI) Points, compatible with
+Situational Awareness (SA) and Common Operating Picture (COP) applications 
+such as Android Team Awareness Kit (ATAK), WinTAK, RaptorX, COPERS, et al.
 
 Features of ``aprscot``:
 
@@ -19,13 +19,16 @@ Features of ``aprscot``:
 * 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 Alan Barrow's aprstak: https://github.com/pinztrek/aprstak
+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
 
 Support aprscot Development
 ============================
 
-aprscot has been developed for the Disaster Response, Public Safety and
-Frontline community at-large. This software is currently provided at no-cost to
+aprscot has been developed for the Disaster Response, Public Safety, and
+Frontline community. This software is currently provided at no-cost to
 our end-users. All development is self-funded and all time-spent is entirely
 voluntary. Any contribution you can make to further these software development
 efforts, and the mission of aprscot to provide ongoing SA capabilities to our
@@ -38,9 +41,11 @@ end-users, is greatly appreciated:
 Installation
 ============
 
-The APRS to COT gateway is provided by a command-line tool called `aprscot`:
+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:
 
-Installing as a Debian/Ubuntu Package::
+**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
@@ -50,12 +55,12 @@ Installing as a Debian/Ubuntu Package::
     $ sudo apt install -f ./python3-aprscot_latest_all.deb
 
 
-Install from the Python Package Index (PyPI)::
+Option II: Install from the Python Package Index (PyPI)::
 
     $ pip install aprscot
 
 
-Install from this source tree::
+Option III: Install from this source tree::
 
     $ git clone https://github.com/ampledata/aprscot.git
     $ cd aprscot/
@@ -77,19 +82,21 @@ The `aprscot` program has one command-line argument::
 You must create a configuration file, see `example-config.ini` in the source
 repository.
 
-An example config::
+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::
+`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::
+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
@@ -115,9 +122,9 @@ https://ampledata.org/
 
 Copyright
 =========
-Copyright 2021 Greg Albrecht
+Copyright 2022 Greg Albrecht
 
-`Automatic Packet Reporting System (APRS) <http://www.aprs.org/>`_ is Copyright Bob Bruninga WB4APR wb4apr@amsat.org
+`Automatic Packet Reporting System (APRS) <http://www.aprs.org/>`_ is Copyright Bob Bruninga WB4APR (SK) wb4apr@amsat.org
 
 License
 =======

aprscot/__init__.py

@@ -9,7 +9,7 @@
 
 
 :author: Greg Albrecht W2GMD <oss@undef.net>
-:copyright: Copyright 2021 Greg Albrecht
+:copyright: Copyright 2022 Greg Albrecht
 :license: Apache License, Version 2.0
 :source: <https://github.com/ampledata/aprscot>
 
@@ -25,6 +25,6 @@
 from .classes import APRSWorker  # NOQA
 
 __author__ = "Greg Albrecht W2GMD <oss@undef.net>"
-__copyright__ = "Copyright 2021 Greg Albrecht"
+__copyright__ = "Copyright 2022 Greg Albrecht"
 __license__ = "Apache License, Version 2.0"
 __source__ = "https://github.com/ampledata/aprscot"

aprscot/classes.py

@@ -11,7 +11,7 @@
 import aprscot
 
 __author__ = "Greg Albrecht W2GMD <oss@undef.net>"
-__copyright__ = "Copyright 2021 Greg Albrecht"
+__copyright__ = "Copyright 2022 Greg Albrecht"
 __license__ = "Apache License, Version 2.0"
 __source__ = "https://github.com/ampledata/aprscot"
 

aprscot/commands.py

@@ -22,7 +22,7 @@
 
 
 __author__ = 'Greg Albrecht W2GMD <oss@undef.net>'
-__copyright__ = 'Copyright 2021 Greg Albrecht'
+__copyright__ = 'Copyright 2022 Greg Albrecht'
 __license__ = 'Apache License, Version 2.0'
 __source__ = 'https://github.com/ampledata/aprscot'
 

aprscot/constants.py

@@ -1,14 +1,14 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-"""APRS Cursor-on-Target Constants."""
+"""APRS Cursor-on-Target Gatway: Constants."""
 
 import logging
 import os
 import re
 
 __author__ = 'Greg Albrecht W2GMD <oss@undef.net>'
-__copyright__ = 'Copyright 2021 Greg Albrecht'
+__copyright__ = 'Copyright 2022 Greg Albrecht'
 __license__ = 'Apache License, Version 2.0'
 __source__ = 'https://github.com/ampledata/aprscot'
 
@@ -32,7 +32,7 @@
 DEFAULT_APRSIS_PORT: int = 14580
 DEFAULT_APRSIS_HOST: str = "rotate.aprs.net"
 DEFAULT_APRSIS_CALLSIGN: str = "APRSCOT"
-DEFAULT_APRSIS_FILTER: str = "f/SUNSET/50"
+DEFAULT_APRSIS_FILTER: str = "m/50"
 
 DEFAULT_COT_TYPE: str = "a-f-G-I-U-T-r"
 DEFAULT_COT_STALE: str = 3600

aprscot/functions.py

@@ -5,20 +5,23 @@
 
 import datetime
 
-import xml.etree.ElementTree
+from typing import List
+
+import xml.etree.ElementTree as ET
 
 import pytak
 
 import aprscot
 
+
 __author__ = "Greg Albrecht W2GMD <oss@undef.net>"
-__copyright__ = "Copyright 2021 Greg Albrecht"
+__copyright__ = "Copyright 2022 Greg Albrecht"
 __license__ = "Apache License, Version 2.0"
 __source__ = "https://github.com/ampledata/aprscot"
 
 
 def aprs_to_cot_xml(aprs_frame: dict, config: dict) -> \
-        [xml.etree.ElementTree, None]:  # NOQA pylint: disable=too-many-locals,too-many-statements
+                    List[ET.Element, None]:  # NOQA pylint: disable=too-many-locals,too-many-statements
     """Converts an APRS Frame to a Cursor-on-Target Event."""
     time = datetime.datetime.now(datetime.timezone.utc)
 
@@ -50,7 +53,7 @@ def aprs_to_cot_xml(aprs_frame: dict, config: dict) -> \
                  datetime.timedelta(
                      seconds=int(_cot_stale))).strftime(pytak.ISO_8601_UTC)
 
-    point = xml.etree.ElementTree.Element("point")
+    point = ET.Element("point")
     point.set("lat", str(lat))
     point.set("lon", str(lon))
 
@@ -67,22 +70,22 @@ def aprs_to_cot_xml(aprs_frame: dict, config: dict) -> \
     # Height above Ellipsoid based on WGS-84 ellipsoid (measured in meters)
     point.set("hae", "9999999.0")
 
-    uid = xml.etree.ElementTree.Element("UID")
+    uid = ET.Element("UID")
     uid.set("Droid", f"{name} (APRS)")
 
-    contact = xml.etree.ElementTree.Element("contact")
+    contact = ET.Element("contact")
     contact.set("callsign", f"{callsign} (APRS)")
 
-    track = xml.etree.ElementTree.Element("track")
+    track = E.Element("track")
     track.set("course", "9999999.0")
 
-    detail = xml.etree.ElementTree.Element("detail")
+    detail = ET.Element("detail")
     detail.set("uid", name)
     detail.append(uid)
     detail.append(contact)
     detail.append(track)
 
-    remarks = xml.etree.ElementTree.Element("remarks")
+    remarks = ET.Element("remarks")
 
     comment = aprs_frame.get("comment")
     if comment:
@@ -91,7 +94,7 @@ def aprs_to_cot_xml(aprs_frame: dict, config: dict) -> \
 
 #    event.stale = time + datetime.timedelta(seconds=stale)
 
-    root = xml.etree.ElementTree.Element("event")
+    root = ET.Element("event")
     root.set("version", "2.0")
     root.set("type", cot_type)
     root.set("uid", f"APRS.{callsign}".replace(" ", ""))
@@ -110,7 +113,7 @@ def aprs_to_cot(aprs_frame: dict, config: dict) -> str:
     Converts an APRS Frame to a Cursor-on-Target Event, as a String.
     """
     cot_str: str = ""
-    cot_xml: xml.etree.ElementTree = aprs_to_cot_xml(aprs_frame, config)
+    cot_xml: ET.Element = aprs_to_cot_xml(aprs_frame, config)
     if cot_xml:
-        cot_str = xml.etree.ElementTree.tostring(cot_xml)
+        cot_str = ET.tostring(cot_xml)
     return cot_str

requirements_test.txt

@@ -2,7 +2,7 @@
 #
 # Source:: https://github.com/ampledata/aprscot
 # Author:: Greg Albrecht W2GMD <oss@undef.net>
-# Copyright:: Copyright 2020 Orion Labs, Inc.
+# Copyright:: Copyright 2022 Greg Albrecht
 # License:: Apache License, Version 2.0
 
 

setup.cfg

@@ -2,7 +2,7 @@
 #
 # Source:: https://github.com/ampledata/aprscot
 # Author:: Greg Albrecht W2GMD <oss@undef.net>
-# Copyright:: Copyright 2020 Orion Labs, Inc.
+# Copyright:: Copyright 2022 Greg Albrecht
 # License:: Apache License, Version 2.0
 #
 

setup.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
 """
@@ -13,9 +13,9 @@
 import setuptools
 
 __title__ = "aprscot"
-__version__ = "5.0.2"
+__version__ = "5.0.3"
 __author__ = "Greg Albrecht W2GMD <oss@undef.net>"
-__copyright__ = "Copyright 2021 Greg Albrecht"
+__copyright__ = "Copyright 2022 Greg Albrecht"
 __license__ = "Apache License, Version 2.0"
 
 

tests/test_functions.py

@@ -8,7 +8,7 @@
 ~~~~
 
 :author: Greg Albrecht W2GMD <oss@undef.net>
-:copyright: Copyright 2021 Greg Albrecht
+:copyright: Copyright 2022 Greg Albrecht
 :license: Apache License, Version 2.0
 :source: <https://github.com/ampledata/aprscot>
 """