Configuration File
The configuration file is in YAML format (.yaml
).
To run a configuration, see the Usage section.
callsigns:
- W3EAX-9
- W3EAX-11
- W3EAX-12
time:
start: 2022-03-05 00:00:00
end: 2022-03-06 00:00:00
interval: 120
connections:
sondehub: {}
text:
- port: /dev/ttyUSB0
baud_rate: 9600
- path: ~/packets.txt
prediction:
start:
coord:
x: -78.4987
y: 40.0157
time: 2022-03-05 10:36:00
profile:
ascent_rate: 6.5
burst_altitude: 25000
sea_level_descent_rate: 9
output_file: example_3_prediction.geojson
output_file: example_3.geojson
Units are meters, seconds, and meters per second.
More examples can be found at the Configuration Examples page.
Callsigns (callsigns
, optional)
a list of callsigns as strings, including SSIDs
callsigns:
- KC3SKW-9
- KC3ZRB
if present, only telemetry with callsigns in this list will be displayed
Time (time
, optional)
time:
start: 2022-03-05 00:00:00
end: 2022-03-06 00:00:00
interval: 120
start
and end
(optional)
start and end times by which to filter received telemetry, as either yyyy-mm-dd
or yyyy-mm-dd HH:MM:SS
interval
(default 60
)
frequency in seconds that PacketRaven will fetch new telemetry
Connections (connections
)
connections from which to retrieve telemetry
connections:
sondehub: {}
aprs_fi:
api_key: 123456.abcdefhijklmnop
text:
- port: /dev/ttyUSB0
baud_rate: 9600
- path: ~/packets.txt
Note
To define a connection with no options (i.e. the sondehub
entry, above), use YAML’s empty flow mapping syntax sondehub: {}
.
The empty block mapping syntax (sondehub: ``) is equivalent to ``sondehub: null
and will not initiate the connection.
Text connection (text
)
text entries can be
a text file containing one raw APRS frame per line, optionally prepended by the datetime (separated by a colon)
a GeoJSON file of points with packet information in the
properties
a serial port, from which raw APRS frames can be retrieved as strings
connections:
text:
- path: http://bpp.umd.edu/archives/Launches/NS-100_2022_04_09/APRS/NS-100%20normal%20aprs.txt
callsigns:
- W3EAX-8
- path: ~/packets.geojson
- port: /dev/ttyUSB0
callsigns:
- KC3SKW-8
- port: COM3
baud_rate: 9600
File
path
path to a file (can be a URL)
callsigns
(optional)
see the Callsigns section
Serial
port
serial port to connect to, i.e. COM4 or /dev/ttyUSB1
baud_rate
baud rate with which to connect to serial port
callsigns
(optional)
see the Callsigns section
SondeHub connection (sondehub
)
if present, query the database at https://amateur.sondehub.org for telemetry from the given callsigns
callsigns
(optional if already defined globally)
see the Callsigns section
APRSfi Connection (aprs_fi
)
if present, query the database at https://aprs.fi for telemetry from the given callsigns
api_key
get an API key from https://aprs.fi/page/api
callsigns
(optional if already defined globally)
see the Callsigns section
PostGres Database connection (postgres
, requires the postgres
feature)
Warning
requires compiling with the postgres
feature:
..code-block:: shell
cargo build –release –features postgres
connections:
postgres:
hostname: "database_hostname"
port: 5432
database: "nearspace"
table: "packets"
username: "user1"
password: "password1"
tunnel:
hostname: "ssh_tunnel_hostname"
port: 22
username: "ssh_user1"
password: "ssh_password1"
Flight Prediction (prediction
, optional)
if present, queries https://predict.sondehub.org for a balloon flight prediction
prediction:
start:
coord:
x: -78.4987
y: 40.0157
time: 2022-03-05 10:36:00
profile:
ascent_rate: 6.5
burst_altitude: 25000
sea_level_descent_rate: 9
output_file: example_3_prediction.geojson
Launch / starting location and time (start
)
prediction:
start:
coord:
x: -78.4987
y: 40.0157
time: 2022-03-05 10:36:00
coord
x
and y
in WGS84 coordinates
altitude
(optional)
altitude in meters
time
time of prediction start, as yyyy-mm-dd
or yyyy-mm-dd HH:MM:SS
Standard Profile (profile
)
prediction:
profile:
ascent_rate: 6.5
burst_altitude: 25000
sea_level_descent_rate: 9
Note
During a flight, the prediction profile for each track will differ from this default configuration; for instance, on ascent the profile will use the actual ascent rate from telemetry, and during descent the prediction will only include the descent stage.
ascent_rate
expected average ascent rate of the balloon
burst_altitude
expected burst altitude
sea_level_descent_rate
expected descent rate of the balloon at sea level
Float Profile (float
, optional)
prediction:
float:
duration: 3600
altitude: 25000
uncertainty: 500
duration
expected duration of the float
altitude
expected altitude of the float
uncertainty
(default 500
)
leeway that the balloon can be considered “at float altitude”
Prediction Output File (output_file
, optional)
path to a GeoJSON file to which to output a predicted flight path
prediction:
output_file: example_3_prediction.geojson
Telemetry Output File (output_file
, optional)
path to a GeoJSON file to which to output received telemetry
output_file: example_3.geojson