Skip to content

Commit

Permalink
readmefixes
Browse files Browse the repository at this point in the history
  • Loading branch information
xMasterX committed Jan 31, 2024
1 parent f76165d commit fe62eab
Showing 1 changed file with 16 additions and 35 deletions.
51 changes: 16 additions & 35 deletions base_pack/gps_nmea_uart/README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,17 @@
# GPS for Flipper Zero

[![FAP Build](https://github.com/ezod/flipperzero-gps/actions/workflows/build.yml/badge.svg)](https://github.com/ezod/flipperzero-gps/actions/workflows/build.yml)
A simple Flipper Zero application for NMEA 0183 serial GPS modules, such as the
- Adafruit Ultimate GPS Breakout.

A simple Flipper Zero application for NMEA 0183 serial GPS modules.

![ui](ui.png)

Heavy lifting (NMEA parsing) provided by [minmea].

## Installation

1. Navigate to the [FAP Build](https://github.com/ezod/flipperzero-gps/actions/workflows/build.yml)
GitHub action workflow, and select the most recent run.
2. The FAP is built for both the `dev` and `release` channels of the official
firmware. Download the artifact corresponding to your firmware version.
3. Extract `gps_nmea.fap` from the ZIP file to `apps/GPIO` on your Flipper
Zero SD card.
Heavy lifting (NMEA parsing) provided by minmea.

## Usage

This is a single-screen app, and a few interactions are provided via the
hardware buttons:

- Long press the up button to change the **baud rate**. The default baud rate
is 9600, but 4800, 19200, 38400, 57600, and 115200 baud are also supported.
is 9600, but 19200, 38400, 57600, and 115200 baud are also supported.
- Long press the right button to change **speed units** from knots to
kilometers per hour.
- Press the OK button to set the **backlight** to always on mode. Press it
Expand All @@ -35,15 +23,14 @@ hardware buttons:
Connect the GPS module to power and the USART using GPIO pins 9 (3.3V), 11
(GND), 13 (TX), and 14 (RX), as appropriate.

![wiring](wiring.png)

See the [tutorial video](https://www.youtube.com/watch?v=5vSGFzEBp-k) from
Lab401 by [RocketGod](https://github.com/RocketGod-git) for a visual guide to
See the tutorial video - https://www.youtube.com/watch?v=5vSGFzEBp-k from
Lab401 by RocketGod - https://github.com/RocketGod-git for a visual guide to
the hardware setup.

### Confirmed Compatible Modules
## Confirmed Compatible Modules

* [Adafruit Ultimate GPS Breakout]
* Adafruit Ultimate GPS Breakout
* ATGM336H
* Beitian BN-180
* Beitian BN-220
Expand All @@ -56,22 +43,16 @@ the hardware setup.
* Beitian BN-280ZF
* Beitian BN-357ZF
* Royaltek RBT-2100LP
* [u-blox NEO-6M]
* [u-blox NEO-7M]
* [Uputronics u-blox MAX-M8C Pico]
* u-blox NEO-6M
* u-blox NEO-7M
* Uputronics u-blox MAX-M8C Pico

If you have verified this application working with a module not listed here,
please submit a PR adding it to the list.

## Building

This application can be compiled using [uFBT]. Run `ufbt` in the root directory
of the repository.
## Links

[Adafruit Ultimate GPS Breakout]: https://www.adafruit.com/product/746
[minmea]: https://github.com/kosma/minmea
[qFlipper]: https://flipperzero.one/update
[u-blox NEO-6M]: https://www.u-blox.com/en/product/neo-6-series
[u-blox NEO-7M]: https://www.u-blox.com/en/product/neo-7-series
[uFBT]: https://github.com/flipperdevices/flipperzero-ufbt
[Uputronics u-blox MAX-M8C Pico]: https://store.uputronics.com/index.php?route=product/product&product_id=72
Original repo link - https://github.com/ezod/flipperzero-gps
Adafruit Ultimate GPS Breakout: https://www.adafruit.com/product/746
minmea: https://github.com/kosma/minmea
u-blox NEO-6M: https://www.u-blox.com/en/product/neo-6-series

0 comments on commit fe62eab

Please sign in to comment.