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/
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

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

This version

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

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

Uploaded Apr 5, 2022 Source

Built Distribution

packetraven-2.0.0-py3-none-any.whl (49.4 kB view details)

Uploaded Apr 5, 2022 Python 3

File details

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

File metadata

Download URL: packetraven-2.0.0.tar.gz
Upload date: Apr 5, 2022
Size: 41.6 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.0.tar.gz
Algorithm	Hash digest
SHA256	`4d21ef442a47726d0b9739a5e5897c0778ccddfc1a9159f8c4f02fbf438ab640`
MD5	`7ac4acf1101cca23b0d48710a7131b43`
BLAKE2b-256	`7709d3832d31aa7158ddcf8aec17d5ed58d7658285ccfd74931bcedf4099fc67`

See more details on using hashes here.

Provenance

File details

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

File metadata

Download URL: packetraven-2.0.0-py3-none-any.whl
Upload date: Apr 5, 2022
Size: 49.4 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.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`8aca63aebb23213c10d04721d1d91fbc72bf2cd817ab5f159e9b462f3e4dffaf`
MD5	`1ebc9f17b16c518470dc7e18fe7cd178`
BLAKE2b-256	`c4fb669a7f0839c4886a098b3c2f9b6bd93af8ce9694ebea6fb6af624d5fa530`