Skip to main content

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

Project description

PacketRaven

tests codecov build version license style

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

pip install packetraven

Installation

  1. install Python - https://www.python.org/downloads/

  2. install packetraven with pip:

    pip install packetraven
    

NOTE

Alternatively, you may download the source code and build from source:

git clone https://github.com/UMDBPP/PacketRaven.git
cd packetraven
pip install .

Usage

PacketRaven reads a configuration file to determine which connections to set up, how to parse your packets, which callsigns to filter, etc.

packetraven /path/to/config.yaml

The configuration is in YAML format. Here is an example configuration:

# config.yaml

callsigns:
    - W3EAX-9
    - W3EAX-11
    - W3EAX-12

time:
    start: 2022-03-05
    end: 2022-03-06
    interval: 30

output:
    filename: ns110.geojson

log:
    filename: ns110.log

packets:
    aprs_fi:
        api_key: 123456.abcdefhijklmnop
    text:
        locations:
            - /dev/ttyUSB0
            - ~/packets.txt
    database:
        hostname: localhost
        port: 5432
        database: nearspace
        table: ns110
        username: user1
        password: password1
        tunnel:
            hostname: bpp.umd.edu
            port: 22
            username: user1
            password: password2

prediction:
    start:
        location:
            - -78.4987
            - 40.0157
        time: 2022-03-05 10:36:00
    profile:
        ascent_rate: 6.5
        burst_altitude: 25000
        sea_level_descent_rate: 9
    output:
        filename: ns110_prediction.geojson

start the graphical user interface (GUI)

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

packetraven --gui
packetraven config.yaml --gui

Examples

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

# config.yaml

packets:
    text:
        locations:
            - COM4

you can also set the location to auto to try the first open USB port

# config.yaml

packets:
    text:
        locations:
            - auto

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

# config.yaml

callsigns:
    - W3EAX-8
    - W3EAX-14

packets:
    aprs_fi:
        api_key: 123456.abcdefhijklmnop

listen to a PostGIS database table

# config.yaml

callsigns:
    - W3EAX-8
    - W3EAX-14

packets:
    database:
        hostname: bpp.umd.edu
        port: 5432
        database: nearspace
        table: ns110
        username: user1
        password: password1

watch text file(s) for new lines containing raw APRS strings

# config.yaml

packets:
    text:
        locations:
            - http://bpp.umd.edu/archives/Launches/NS-95_2020-11-07/APRS/W3EAX-10/W3EAX-10_raw_NS95.txt
            - 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

# config.yaml

callsigns:
    - W3EAX-8
    - W3EAX-14

packets:
    text:
        locations:
            - COM3
    database:
        hostname: localhost
        port: 5432
        database: nearspace
        table: ns110
        username: user1
        password: password1
        tunnel:
            hostname: bpp.umd.edu
            port: 22
            username: user1
            password: password2

Project details


Download files

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

Source Distribution

packetraven-2.0.1.tar.gz (41.9 kB view details)

Uploaded Source

Built Distribution

packetraven-2.0.1-py3-none-any.whl (49.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: packetraven-2.0.1.tar.gz
  • Upload date:
  • Size: 41.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for packetraven-2.0.1.tar.gz
Algorithm Hash digest
SHA256 9f80fc80128ba2480ec6444829b3547145d4a1297b2914e7385d27570c998083
MD5 2913bd970d6ff483dca1b85508906b8a
BLAKE2b-256 96b6977a49ef052eb9b551172bc00f9ca1317d88b9ab60bc18671bb7de591be6

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: packetraven-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 49.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.9.12

File hashes

Hashes for packetraven-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d947ff27eba09c291230fdb99ac02e8ba3d2f569e6d0c8daad73f1efe8eabadd
MD5 afc1c4e7494f259a18dd13a5fce9905d
BLAKE2b-256 43da4bb8853814a8eef6d13ab7026718d6928043dab6a0381a4c7e625fdbbdd6

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page