openwebrx-clone/owrx/aprs.py

365 lines
14 KiB
Python
Raw Normal View History

from owrx.kiss import KissDeframer
from owrx.map import Map, LatLngLocation
from owrx.bands import Bandplan
from datetime import datetime, timezone
2019-08-17 18:35:32 +00:00
import re
import logging
logger = logging.getLogger(__name__)
2019-08-15 20:10:58 +00:00
# speed is in knots... convert to metric (km/h)
2019-08-17 18:35:32 +00:00
knotsToKilometers = 1.852
feetToMeters = 0.3048
2019-08-17 20:04:45 +00:00
milesToKilometers = 1.609344
2019-08-15 20:10:58 +00:00
2019-08-16 05:29:31 +00:00
# not sure what the correct encoding is. it seems TAPR has set utf-8 as a standard, but not everybody is following it.
encoding = "utf-8"
2019-08-17 18:35:32 +00:00
# regex for altitute in comment field
altitudeRegex = re.compile("(^.*)\\/A=([0-9]{6})(.*$)")
def decodeBase91(input):
base = decodeBase91(input[:-1]) * 91 if len(input) > 1 else 0
return base + (ord(input[-1]) - 33)
2019-08-15 16:08:20 +00:00
class Ax25Parser(object):
def parse(self, ax25frame):
2019-08-15 17:56:59 +00:00
control_pid = ax25frame.find(bytes([0x03, 0xF0]))
if control_pid % 7 > 0:
logger.warning("aprs packet framing error: control/pid position not aligned with 7-octet callsign data")
def chunks(l, n):
"""Yield successive n-sized chunks from l."""
for i in range(0, len(l), n):
2019-08-15 17:56:59 +00:00
yield l[i : i + n]
return {
"destination": self.extractCallsign(ax25frame[0:7]),
"source": self.extractCallsign(ax25frame[7:14]),
"path": [self.extractCallsign(c) for c in chunks(ax25frame[14:control_pid], 7)],
2019-08-15 17:56:59 +00:00
"data": ax25frame[control_pid + 2 :],
}
def extractCallsign(self, input):
cs = bytes([b >> 1 for b in input[0:6]]).decode(encoding, "replace").strip()
ssid = (input[6] & 0b00011110) >> 1
if ssid > 0:
return "{callsign}-{ssid}".format(callsign=cs, ssid=ssid)
else:
return cs
class AprsParser(object):
def __init__(self, handler):
self.ax25parser = Ax25Parser()
self.deframer = KissDeframer()
self.dial_freq = None
self.band = None
self.handler = handler
def setDialFrequency(self, freq):
self.dial_freq = freq
self.band = Bandplan.getSharedInstance().findBand(freq)
def parse(self, raw):
for frame in self.deframer.parse(raw):
2019-08-15 16:08:20 +00:00
try:
data = self.ax25parser.parse(frame)
2019-08-15 16:08:20 +00:00
# TODO how can we tell if this is an APRS frame at all?
aprsData = self.parseAprsData(data)
2019-08-15 21:33:02 +00:00
logger.debug("decoded APRS data: %s", aprsData)
2019-08-15 16:08:20 +00:00
if "lat" in aprsData and "lon" in aprsData:
2019-08-15 17:56:59 +00:00
loc = LatLngLocation(
aprsData["lat"], aprsData["lon"], aprsData["comment"] if "comment" in aprsData else None
)
2019-08-15 16:08:20 +00:00
Map.getSharedInstance().updateLocation(data["source"], loc, "APRS", self.band)
2019-08-15 16:08:20 +00:00
self.handler.write_aprs_data(aprsData)
except Exception:
logger.exception("exception while parsing aprs data")
def hasCompressedCoordinates(self, raw):
return raw[0] == "/" or raw[0] == "\\"
def parseUncompressedCoordinates(self, raw):
lat = int(raw[0:2]) + float(raw[2:7]) / 60
if raw[7] == "S":
lat *= -1
lon = int(raw[9:12]) + float(raw[12:17]) / 60
if raw[17] == "W":
lon *= -1
2019-08-15 18:28:24 +00:00
return {"lat": lat, "lon": lon, "symboltable": raw[8], "symbol": raw[18]}
def parseCompressedCoordinates(self, raw):
return {
"lat": 90 - decodeBase91(raw[1:5]) / 380926,
"lon": -180 + decodeBase91(raw[5:9]) / 190463,
2019-08-15 18:28:24 +00:00
"symboltable": raw[0],
2019-08-15 17:56:59 +00:00
"symbol": raw[9],
}
def parseTimestamp(self, raw):
now = datetime.now()
if raw[6] == "h":
ts = datetime.strptime(raw[0:6], "%H%M%S")
ts = ts.replace(year=now.year, month=now.month, day=now.month, tzinfo=timezone.utc)
else:
ts = datetime.strptime(raw[0:6], "%d%H%M")
ts = ts.replace(year=now.year, month=now.month)
if raw[6] == "z":
ts = ts.replace(tzinfo=timezone.utc)
elif raw[6] == "/":
ts = ts.replace(tzinfo=now.tzinfo)
else:
logger.warning("invalid timezone info byte: %s", raw[6])
logger.debug(ts)
return int(ts.timestamp() * 1000)
def parseStatusUpate(self, raw):
res = {"type": "status"}
if raw[6] == "z":
res["timestamp"] = self.parseTimestamp(raw[0:7])
res["comment"] = raw[7:]
else:
res["comment"] = raw
return res
def parseAprsData(self, data):
information = data["data"]
# forward some of the ax25 data
2019-08-15 17:56:59 +00:00
aprsData = {"source": data["source"], "destination": data["destination"], "path": data["path"]}
if information[0] == 0x1C or information[0] == ord("`") or information[0] == ord("'"):
aprsData.update(MicEParser().parse(data))
return aprsData
information = information.decode(encoding, "replace")
2019-08-17 18:20:28 +00:00
# APRS data type identifier
dti = information[0]
if dti == "!" or dti == "=":
# position without timestamp
2019-08-15 13:53:55 +00:00
aprsData.update(self.parseRegularAprsData(information[1:]))
2019-08-17 18:20:28 +00:00
elif dti == "/" or dti == "@":
# position with timestamp
aprsData["timestamp"] = self.parseTimestamp(information[1:8])
2019-08-15 13:53:55 +00:00
aprsData.update(self.parseRegularAprsData(information[8:]))
2019-08-17 18:20:28 +00:00
elif dti == ">":
# status update
aprsData.update(self.parseStatusUpate(information[1:]))
2019-08-17 18:20:28 +00:00
elif dti == "}":
# third party
aprsData["type"] = "thirdparty"
2019-08-15 13:53:55 +00:00
return aprsData
2019-08-15 13:53:55 +00:00
def parseRegularAprsData(self, information):
if self.hasCompressedCoordinates(information):
2019-08-15 13:53:55 +00:00
aprsData = self.parseCompressedCoordinates(information[0:10])
aprsData["type"] = "compressed"
if information[10] != " ":
if information[10] == "{":
# pre-calculated radio range
2019-08-17 20:04:45 +00:00
aprsData["range"] = 2 * 1.08 ** (ord(information[11]) - 33) * milesToKilometers
else:
2019-08-16 14:43:16 +00:00
aprsData["course"] = (ord(information[10]) - 33) * 4
2019-08-15 20:10:58 +00:00
# speed is in knots... convert to metric (km/h)
2019-08-17 18:35:32 +00:00
aprsData["speed"] = (1.08 ** (ord(information[11]) - 33) - 1) * knotsToKilometers
# compression type
2019-08-16 14:43:16 +00:00
t = ord(information[12])
aprsData["fix"] = (t & 0b00100000) > 0
sources = ["other", "GLL", "GGA", "RMC"]
aprsData["nmeasource"] = sources[(t & 0b00011000) >> 3]
origins = [
"Compressed",
"TNC BText",
"Software",
"[tbd]",
"KPC3",
"Pico",
"Other tracker",
"Digipeater conversion",
]
aprsData["compressionorigin"] = origins[t & 0b00000111]
2019-08-17 20:04:45 +00:00
comment = information[13:]
else:
2019-08-15 13:53:55 +00:00
aprsData = self.parseUncompressedCoordinates(information[0:19])
aprsData["type"] = "regular"
2019-08-17 20:04:45 +00:00
comment = information[19:]
def decodeHeightGainDirectivity(comment):
2019-08-17 22:16:08 +00:00
res = {"height": 2 ** int(comment[4]) * 10 * feetToMeters, "gain": int(comment[5])}
2019-08-17 20:04:45 +00:00
directivity = int(comment[6])
if directivity == 0:
res["directivity"] = "omni"
elif 0 < directivity < 9:
res["directivity"] = directivity * 45
return res
# aprs data extensions
if len(comment) > 6:
if comment[3] == "/":
# course and speed
# for a weather report, this would be wind direction and speed
aprsData["course"] = int(comment[0:3])
aprsData["speed"] = int(comment[4:7]) * knotsToKilometers
comment = comment[7:]
elif comment[0:3] == "PHG":
# station power and effective antenna height/gain/directivity
powerCodes = [0, 1, 4, 9, 16, 25, 36, 49, 64, 81]
aprsData["power"] = powerCodes[int(comment[3])]
aprsData.update(decodeHeightGainDirectivity(comment))
comment = comment[7:]
elif comment[0:3] == "RNG":
# pre-calculated radio range
aprsData["range"] = int(comment[3:7]) * milesToKilometers
comment = comment[7:]
elif comment[0:3] == "DFS":
# direction finding signal strength and antenna height/gain
aprsData["strength"] = int(comment[3])
aprsData.update(decodeHeightGainDirectivity(comment))
comment = comment[7:]
matches = altitudeRegex.match(comment)
2019-08-17 18:35:32 +00:00
if matches:
aprsData["altitude"] = int(matches[2]) * feetToMeters
2019-08-17 20:04:45 +00:00
comment = matches[1] + matches[3]
aprsData["comment"] = comment
2019-08-17 18:35:32 +00:00
return aprsData
2019-08-15 16:08:20 +00:00
class MicEParser(object):
def extractNumber(self, input):
n = ord(input)
if n >= ord("P"):
return n - ord("P")
if n >= ord("A"):
return n - ord("A")
return n - ord("0")
def listToNumber(self, input):
base = self.listToNumber(input[:-1]) * 10 if len(input) > 1 else 0
return base + input[-1]
def extractAltitude(self, comment):
if len(comment) < 4 or comment[3] != "}":
return (comment, None)
return comment[4:], decodeBase91(comment[:3]) - 10000
def extractDevice(self, comment):
if len(comment) > 0:
if comment[0] == ">":
if len(comment) > 1:
if comment[-1] == "=":
return comment[1:-1], {"manufacturer": "Kenwood", "device": "TH-D72"}
if comment[-1] == "^":
return comment[1:-1], {"manufacturer": "Kenwood", "device": "TH-D74"}
return comment[1:], {"manufacturer": "Kenwood", "device": "TH-D7A"}
if comment[0] == "]":
if len(comment) > 1 and comment[-1] == "=":
return comment[1:-1], {"manufacturer": "Kenwood", "device": "TM-D710"}
return comment[1:], {"manufacturer": "Kenwood", "device": "TM-D700"}
if len(comment) > 2 and (comment[0] == "`" or comment[0] == "'"):
if comment[-2] == "_":
devices = {
2019-08-15 17:56:59 +00:00
"b": "VX-8",
'"': "FTM-350",
"#": "VX-8G",
"$": "FT1D",
"%": "FTM-400DR",
")": "FTM-100D",
"(": "FT2D",
"0": "FT3D",
}
return comment[1:-2], {"manufacturer": "Yaesu", "device": devices.get(comment[-1], "Unknown")}
if comment[-2:] == " X":
return comment[1:-2], {"manufacturer": "SainSonic", "device": "AP510"}
if comment[-2] == "(":
2019-08-15 17:56:59 +00:00
devices = {"5": "D578UV", "8": "D878UV"}
return comment[1:-2], {"manufacturer": "Anytone", "device": devices.get(comment[-1], "Unknown")}
if comment[-2] == "|":
2019-08-15 17:56:59 +00:00
devices = {"3": "TinyTrack3", "4": "TinyTrack4"}
return comment[1:-2], {"manufacturer": "Byonics", "device": devices.get(comment[-1], "Unknown")}
if comment[-2:] == "^v":
return comment[1:-2], {"manufacturer": "HinzTec", "device": "anyfrog"}
if comment[-2] == ":":
2019-08-15 17:56:59 +00:00
devices = {"4": "P4dragon DR-7400 modem", "8": "P4dragon DR-7800 modem"}
return (
comment[1:-2],
{"manufacturer": "SCS GmbH & Co.", "device": devices.get(comment[-1], "Unknown")},
)
if comment[-2:] == "~v":
return comment[1:-2], {"manufacturer": "Other", "device": "Other"}
return comment[1:-2], None
2019-08-15 16:08:20 +00:00
return comment, None
def parse(self, data):
information = data["data"]
destination = data["destination"]
rawLatitude = [self.extractNumber(c) for c in destination[0:6]]
lat = self.listToNumber(rawLatitude[0:2]) + self.listToNumber(rawLatitude[2:6]) / 6000
if ord(destination[3]) <= ord("9"):
lat *= -1
lon = information[1] - 28
if ord(destination[4]) >= ord("P"):
lon += 100
if 180 <= lon <= 189:
lon -= 80
if 190 <= lon <= 199:
lon -= 190
minutes = information[2] - 28
if minutes >= 60:
minutes -= 60
lon += minutes / 60 + (information[3] - 28) / 6000
if ord(destination[5]) >= ord("P"):
lon *= -1
speed = (information[4] - 28) * 10
dc28 = information[5] - 28
speed += int(dc28 / 10)
course = (dc28 % 10) * 100
course += information[6] - 28
if speed >= 800:
speed -= 800
if course >= 400:
course -= 400
2019-08-15 20:10:58 +00:00
# speed is in knots... convert to metric (km/h)
2019-08-17 18:35:32 +00:00
speed *= knotsToKilometers
comment = information[9:].decode(encoding, "replace").strip()
2019-08-15 16:08:20 +00:00
(comment, altitude) = self.extractAltitude(comment)
(comment, device) = self.extractDevice(comment)
# altitude might be inside the device string, so repeat and choose one
(comment, insideAltitude) = self.extractAltitude(comment)
altitude = next((a for a in [altitude, insideAltitude] if a is not None), None)
2019-08-15 18:28:24 +00:00
return {
2019-08-17 22:16:08 +00:00
"fix": information[0] == ord("`") or information[0] == 0x1C,
2019-08-15 18:28:24 +00:00
"lat": lat,
"lon": lon,
"comment": comment,
"altitude": altitude,
"speed": speed,
"course": course,
2019-08-15 18:28:24 +00:00
"device": device,
"type": "Mic-E",
"symboltable": chr(information[8]),
"symbol": chr(information[7]),
}