Telemetry dashboard for APRS packets from TNC, https://aprs.fi, and PostGIS

Project description

PacketRaven

PacketRaven is a front-end data aggregator / dashboard, designed to track the progress of high-altitude balloon payload flights via location telemetry.

pip install packetraven

Examples:

listen to a TNC sending raw APRS strings over USB port COM4:

packetraven --tnc COM4

listen to APRS.fi, watching specific callsigns:

you need an API key to connect to APRS.fi; you can get one from https://aprs.fi/page/api

packetraven --apikey <api_key> --callsigns W3EAX-8,W3EAX-14

listen to a PostGIS database table:

packetraven --database <username>@<hostname>:5432/<database_name>/<table_name>

watch a text file for new lines containing raw APRS strings:

packetraven --tnc ~\Desktop\aprs_packets.txt

listen to a TNC on COM3, watching specific callsigns, and synchronize new packets with a database table via SSH tunnel:

packetraven --tnc COM3 --callsigns W3EAX-8,W3EAX-14 --database <username>@<hostname>:5432/<database_name>/<table_name> --tunnel <ssh_username>@<hostname>:22

Graphical User Interface

to start the GUI, add --gui to any packetraven command

packetraven --gui

packetraven --callsigns W3EAX-8,W3EAX-14 --apikey <api_key> --gui

Usage:

usage: packetraven [-h] [--callsigns CALLSIGNS] [--apikey APIKEY] [--tnc TNC] [--database DATABASE]
                   [--tunnel TUNNEL] [--igate] [--start START] [--end END] [--log LOG] [--output OUTPUT]
                   [--interval INTERVAL] [--gui]

optional arguments:
  -h, --help            show this help message and exit
  --callsigns CALLSIGNS
                        comma-separated list of callsigns to track
  --apikey APIKEY       APRS.fi API key (from https://aprs.fi/page/api)
  --tnc TNC             serial port or text file of TNC parsing APRS packets from analog audio to ASCII (set to
                        `auto` to use the first open serial port)
  --database DATABASE   PostGres database table `user@hostname:port/database/table`
  --tunnel TUNNEL       SSH tunnel `user@hostname:port`
  --igate               send new packets to APRS-IS
  --start START         start date / time, in any common date format
  --end END             end date / time, in any common date format
  --log LOG             path to log file to save log messages
  --output OUTPUT       path to output file to save packets
  --interval INTERVAL   seconds between each main loop (default: 5)
  --gui                 start the graphical interface

Python API:

to retrieve packets directly from https://aprs.fi:

from packetraven import APRSfi

callsigns = ['W3EAX-8', 'W3EAX-12', 'KC3FXX', 'KC3ZRB']
api_key = '<api_key>' # enter your APRS.fi API key here - you can get one from https://aprs.fi/page/api

aprs_fi = APRSfi(callsigns, api_key)
aprs_fi_packets = aprs_fi.packets

print(aprs_fi_packets)

or parse packets from a TNC sending parsed APRS over a USB connection:

from packetraven import SerialTNC

serial_port = 'COM5' # set to `'auto'` to connect to the first open serial port  

tnc = SerialTNC(serial_port)
tnc_packets = tnc.packets

print(tnc_packets)

or connect to a PostGreSQL database running PostGIS:

from packetraven import APRSDatabaseTable

callsigns = ['W3EAX-8', 'W3EAX-12', 'KC3FXX', 'KC3ZRB']

hostname = '<hostname>:5432'
database = '<database_name>'
table = 'packets'

username = '<username>'
password = '<password>'

# parameters for an SSH tunnel
ssh_hostname = None
ssh_username = None
ssh_password = None

table = APRSDatabaseTable(hostname, database, table, callsigns, 
                          username=username, password=password, 
                          ssh_hostname=ssh_hostname, ssh_username=ssh_hostname, ssh_password=ssh_password)
table_packets = table.packets

print(table_packets)

Project details

Release history Release notifications | RSS feed

2.1.0

Jun 30, 2022

2.0.5

Apr 8, 2022

2.0.4

Apr 8, 2022

2.0.3

Apr 8, 2022

2.0.1

Apr 7, 2022

2.0.0

Apr 5, 2022

1.7.17

Aug 6, 2021

1.7.16

Jul 24, 2021

1.7.15

Jul 24, 2021

1.7.14

Jul 10, 2021

1.7.13

Jul 10, 2021

1.7.12

Jul 8, 2021

1.7.11

Jun 13, 2021

1.7.10

Jun 12, 2021

1.7.9

Jun 6, 2021

1.7.8

Jun 5, 2021

1.7.7

May 6, 2021

1.7.6

Apr 17, 2021

1.7.5

Apr 17, 2021

1.7.4

Apr 17, 2021

1.7.3

Apr 10, 2021

1.7.2

Apr 9, 2021

1.7.1

Mar 22, 2021

1.7.0

Mar 21, 2021

1.6.6

Mar 21, 2021

1.6.5

Mar 10, 2021

1.6.4

Mar 10, 2021

1.6.3

Mar 10, 2021

1.6.2

Mar 10, 2021

1.6.1

Mar 9, 2021

1.6.0

Mar 6, 2021

1.5.3

Jan 31, 2021

1.5.2

Nov 16, 2020

1.5.1 yanked

Nov 16, 2020

Reason this release was yanked:

bug in GUI

1.5.0

Nov 16, 2020

1.4.2

Nov 10, 2020

1.4.1

Nov 10, 2020

1.4.0

Nov 7, 2020

1.3.8

Nov 7, 2020

This version

1.3.7

Nov 6, 2020

1.3.5

Nov 5, 2020

1.3.4

Nov 5, 2020

1.3.3

Nov 2, 2020

1.3.2

Nov 2, 2020

1.3.1

Oct 27, 2020

1.3.0

Oct 27, 2020

1.2.15

Oct 23, 2020

1.2.14

Oct 10, 2020

1.2.13

Oct 8, 2020

1.2.12

Oct 7, 2020

1.2.11

Oct 7, 2020

1.2.10

Oct 7, 2020

1.2.9

Oct 7, 2020

1.2.8

Oct 6, 2020

1.2.7

Oct 5, 2020

1.2.6

Oct 4, 2020

1.2.5

Oct 4, 2020

1.2.4

Oct 2, 2020

1.2.3

Oct 1, 2020

1.2.2

Oct 1, 2020

1.2.1

Oct 1, 2020

1.2.0

Sep 29, 2020

1.1.1

Sep 22, 2020

1.1.0

Sep 21, 2020

1.0.3

Sep 17, 2020

1.0.2

Sep 17, 2020

1.0.1

Sep 17, 2020

1.0.0

Sep 17, 2020

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

packetraven-1.3.7.tar.gz (26.0 kB view details)

Uploaded Nov 6, 2020 Source

Built Distribution

packetraven-1.3.7-py3-none-any.whl (29.7 kB view details)

Uploaded Nov 6, 2020 Python 3

File details

Details for the file packetraven-1.3.7.tar.gz.

File metadata

Download URL: packetraven-1.3.7.tar.gz
Upload date: Nov 6, 2020
Size: 26.0 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.6

File hashes

Hashes for packetraven-1.3.7.tar.gz
Algorithm	Hash digest
SHA256	`c7809cb449f5bdcc414faf783328126e745b6f999f757931fa072d50f2d23fa6`
MD5	`559e08c1ca348c2b7e92c7cba6ba9eb4`
BLAKE2b-256	`88027a7d2511a4d24d93e821c074d9f7a052715758ef8cf24e3cda040946ed9b`

See more details on using hashes here.

Provenance

File details

Details for the file packetraven-1.3.7-py3-none-any.whl.

File metadata

Download URL: packetraven-1.3.7-py3-none-any.whl
Upload date: Nov 6, 2020
Size: 29.7 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.6

File hashes

Hashes for packetraven-1.3.7-py3-none-any.whl
Algorithm	Hash digest
SHA256	`68d7fab799b4a238ef10fbcce4ca589061ca82d9b9b5a3d08715b8e1eafb80e9`
MD5	`34fcecf0c0734f1c72fa228251da7b55`
BLAKE2b-256	`61aa6c2e5526cceed57f74b8b7216cd95985fa62aa1e80d9a79e9336e5a8405d`