Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme #124

Merged
merged 3 commits into from
Jan 22, 2024
Merged

readme #124

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2fbb4ca
readme
zacharyburnett Jan 21, 2024
2b592b1
Merge branch 'main' into readme
zacharyburnett Jan 22, 2024
1786e3c
Update README.md
zacharyburnett Jan 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ The program is designed to be run during a flight and display information in a t

## Features

- retrieve location telemetry from a variety of sources, including
- retrieves location telemetry from a variety of sources, including
- https://amateur.sondehub.org
- https://aprs.fi
- a TNC-equipped radio connected via USB
- a text file containing raw APRS frames
- a GeoJSON file with point geometries and telemetry
- retrieve balloon flight predictions from https://predict.sondehub.org
- plot variables such as altitude and ascent rate over time
- estimate landing time and location
- retrieves balloon flight predictions from https://predict.sondehub.org
- plots variables such as altitude and ascent rate over time
- estimates landing time (and, if doing a prediction, shows preficted landing location)

## Instructions

Expand All @@ -35,11 +35,11 @@ The program is designed to be run during a flight and display information in a t
baud_rate: 9600
```

2. Download an executable from the [Releases page](https://github.com/UMDBPP/PacketRaven/releases).
2. Download an executable from [the Releases page](https://github.com/UMDBPP/PacketRaven/releases).

3. Open a terminal window.

4. Run the executable you downloaded with the `start` subcommand, and give it the path to your configuration file:
4. Run the executable you downloaded with `start` and a path to your configuration file:
```shell
packetraven.exe start example.yaml
```
Expand All @@ -53,18 +53,22 @@ The program is designed to be run during a flight and display information in a t
> chmod +x packetraven
> ```

5. You should now see the user interface. Resize your terminal window or decrease the font size as needed.
![starting screen](https://github.com/UMDBPP/PacketRaven/blob/main/docs/images/example1_log.png)
5. You should now see the user interface. The program starts on the `Log` tab, which displays log messages. Use the **up and down arrow keys** to scroll.
![log messages tab](https://github.com/UMDBPP/PacketRaven/blob/main/docs/images/example1_log.png)

6. The left and right arrow keys (or `Tab` and `Shift+Tab`) cycle through active tabs, and the up and down arrow keys change the current plot (or scroll through log messages).
> [!NOTE]
> Resize your terminal window, or zoom out / decrease the font size, as needed.

6. Upon receiving new packet(s) from a callsign, a new tab will be created (shown in the top bar) for that callsign. Use the **left and right arrow keys** to switch between tabs.

7. While on a callsign tab, use the **up and down arrow keys** to switch between plots.
![altitude telemetry plotted over time](https://github.com/UMDBPP/PacketRaven/blob/main/docs/images/example1_altitude.png)

7. To quit, press `q` or `Esc`.
8. To quit, press `q` or `Esc`.

## retrieve predictions

Use `predict` to retrieve a balloon flight prediction:

Run the executable with `predict` to retrieve a balloon flight prediction:
```shell
packetraven.exe predict "2023-08-16T10:00:00" -- -79 39 5 30000 9
```
Expand Down