Skip to content

Commit fe62eab

Browse files
committed
readmefixes
1 parent f76165d commit fe62eab

File tree

1 file changed

+16
-35
lines changed

1 file changed

+16
-35
lines changed

base_pack/gps_nmea_uart/README.md

Lines changed: 16 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,17 @@
11
# GPS for Flipper Zero
22

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

5-
A simple Flipper Zero application for NMEA 0183 serial GPS modules.
6-
7-
![ui](ui.png)
8-
9-
Heavy lifting (NMEA parsing) provided by [minmea].
10-
11-
## Installation
12-
13-
1. Navigate to the [FAP Build](https://github.com/ezod/flipperzero-gps/actions/workflows/build.yml)
14-
GitHub action workflow, and select the most recent run.
15-
2. The FAP is built for both the `dev` and `release` channels of the official
16-
firmware. Download the artifact corresponding to your firmware version.
17-
3. Extract `gps_nmea.fap` from the ZIP file to `apps/GPIO` on your Flipper
18-
Zero SD card.
6+
Heavy lifting (NMEA parsing) provided by minmea.
197

208
## Usage
219

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

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

38-
![wiring](wiring.png)
3926

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

44-
### Confirmed Compatible Modules
31+
## Confirmed Compatible Modules
4532

46-
* [Adafruit Ultimate GPS Breakout]
33+
* Adafruit Ultimate GPS Breakout
4734
* ATGM336H
4835
* Beitian BN-180
4936
* Beitian BN-220
@@ -56,22 +43,16 @@ the hardware setup.
5643
* Beitian BN-280ZF
5744
* Beitian BN-357ZF
5845
* Royaltek RBT-2100LP
59-
* [u-blox NEO-6M]
60-
* [u-blox NEO-7M]
61-
* [Uputronics u-blox MAX-M8C Pico]
46+
* u-blox NEO-6M
47+
* u-blox NEO-7M
48+
* Uputronics u-blox MAX-M8C Pico
6249

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

66-
## Building
67-
68-
This application can be compiled using [uFBT]. Run `ufbt` in the root directory
69-
of the repository.
53+
## Links
7054

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

0 commit comments

Comments
 (0)