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

Project description

PacketRaven

PacketRaven is a dashboard built to track high-altitude balloon flights from their location telemetry.

pip install packetraven

Installation

install Python https://www.python.org/downloads/
create a virtual environment so you don't pollute your system Python installation (or skip to step 3 if you don't care)
```
pip install virtualenv
virtualenv packetraven_env
```

activate your new virtual environment

On Linux:

source packetraven_env/bin/activate

On Windows native command prompt (cmd):

.\packetraven_env\Scripts\activate.bat

On Windows PowerShell:

.\packetraven_env\Scripts\activate.ps1

install packetraven
```
pip install packetraven
```

Usage

Command-line Options

usage: packetraven [-h] [--callsigns CALLSIGNS] [--aprsfi-key APRSFI_KEY] [--tnc TNC] [--database DATABASE] [--tunnel TUNNEL]
                   [--igate] [--start START] [--end END] [--log LOG] [--output OUTPUT] [--prediction-output PREDICTION_OUTPUT]
                   [--prediction-ascent-rate PREDICTION_ASCENT_RATE] [--prediction-burst-altitude PREDICTION_BURST_ALTITUDE]
                   [--prediction-descent-rate PREDICTION_DESCENT_RATE] [--prediction-float-altitude PREDICTION_FLOAT_ALTITUDE]
                   [--prediction-float-duration PREDICTION_FLOAT_DURATION] [--prediction-api PREDICTION_API] [--interval INTERVAL]
                   [--gui]

optional arguments:
  -h, --help            show this help message and exit
  --callsigns CALLSIGNS
                        comma-separated list of callsigns to track
  --aprsfi-key APRSFI_KEY
                        APRS.fi API key (from https://aprs.fi/page/api)
  --tnc TNC             comma-separated list of serial ports / text files of a 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
  --prediction-output PREDICTION_OUTPUT
                        path to output file to save most up-to-date predicted trajectory
  --prediction-ascent-rate PREDICTION_ASCENT_RATE
                        ascent rate to use for prediction (m/s)
  --prediction-burst-altitude PREDICTION_BURST_ALTITUDE
                        burst altitude to use for prediction (m)
  --prediction-descent-rate PREDICTION_DESCENT_RATE
                        descent rate to use for prediction (m/s)
  --prediction-float-altitude PREDICTION_FLOAT_ALTITUDE
                        float altitude to use for prediction (m)
  --prediction-float-duration PREDICTION_FLOAT_DURATION
                        duration of float (s)
  --prediction-api PREDICTION_API
                        API URL to use for prediction (one of ['https://predict.cusf.co.uk/api/v1/',
                        'https://predict.lukerenegar.com/api/v1.1/'])
  --interval INTERVAL   seconds between each main loop (default: 20)
  --gui                 start the graphical interface

Command-line 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 http://bpp.umd.edu/archives/Launches/NS-95_2020-11-07/APRS/W3EAX-11/W3EAX-11_raw_NS95.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

GUI Examples

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

packetraven --gui

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

Python API Examples

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

from packetraven import APRSfi

aprs_fi = 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
)

print(aprs_fi.packets)

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

from packetraven import SerialTNC

tnc = SerialTNC(
    serial_port='COM5',  # set to `'auto'` to connect to the first open serial port
)

print(tnc.packets)

or connect to a PostGreSQL database running PostGIS:

from packetraven import APRSDatabaseTable

table = APRSDatabaseTable(
    hostname='<hostname>:5432',
    database='<database_name>',
    table='packets',
    callsigns=['W3EAX-8', 'W3EAX-12', 'KC3FXX', 'KC3ZRB'],
    username='<username>',
    password='<password>',
    ssh_hostname=None,
    ssh_username=None,
    ssh_password=None,
)

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

This version

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

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.7.13.tar.gz (39.6 kB view details)

Uploaded Jul 10, 2021 Source

Built Distribution

packetraven-1.7.13-py3-none-any.whl (43.4 kB view details)

Uploaded Jul 10, 2021 Python 3

File details

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

File metadata

Download URL: packetraven-1.7.13.tar.gz
Upload date: Jul 10, 2021
Size: 39.6 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for packetraven-1.7.13.tar.gz
Algorithm	Hash digest
SHA256	`543372d9fb59270ef5ab55cc06e1611770d8afa02309c1b1b6aaa4501dbbdff6`
MD5	`255c77e6beccc716f1b8f9016b836a55`
BLAKE2b-256	`2525763a0a887d16c6c2bd8d73605ffab8b9b8bae7ff21a0354a13c470cf97aa`

See more details on using hashes here.

Provenance

File details

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

File metadata

Download URL: packetraven-1.7.13-py3-none-any.whl
Upload date: Jul 10, 2021
Size: 43.4 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for packetraven-1.7.13-py3-none-any.whl
Algorithm	Hash digest
SHA256	`45e8958c44d816ae6c59d527f6f23cfc45c35a84b716b93db2f5cb5be5a2e68a`
MD5	`4fe5f13e9bf1d7489687ab0d67f364ca`
BLAKE2b-256	`a9b1d11237ac0589764911ae84aed11207abfcb597a284af5d82d55dfcc8afa8`