Skip to content

Commit 0c811d6

Browse files
committed
README readability improvements
1 parent d13bca6 commit 0c811d6

File tree

1 file changed

+10
-16
lines changed

1 file changed

+10
-16
lines changed

README.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
This library makes use of [pynmea2](https://github.com/Knio/pynmea2) to parse through input NMEA 0183 data, organize it, and output it to CSV files or to a PostgreSQL database.
22

33
## Terminology
4-
**`sentence`**:
4+
* **`sentence`**:
55
A line from your data file from a particular `talker` and of a particular `sentence_type` E.g.:
66
`$GNRMC,,V,,,,,,,,,,N*4D`
77
`$GNGGA,045824.00,3944.54025,N,10511.64604,W,1,03,4.93,1784.2,M,-21.5,M,,*49`
88

9-
**`talker`**:
9+
* **`talker`**:
1010
The type of the transmitting unit. For the purposes of satellite navigation, this is the constellation from which data is being received.
1111
E.g.: `GA`: Galileo Positioning System; `GB`: BDS (BeiDou System); `GL`: GLONASS Receiver; `GN`: Global Navigation Satellite System (GNSS); `GP`: Global Positioning System (GPS)
1212
See: https://gpsd.gitlab.io/gpsd/NMEA.html#_talker_ids, or https://www.nmea.org/Assets/20190303%20nmea%200183%20talker%20identifier%20mnemonics.pdf
1313

14-
**`sentence_type`**:
14+
* **`sentence_type`**:
1515
One of several types of NMEA sentences that can be received from the talker.
1616
E.g.: `RMC`, `VTG`, `GGA`, `GSA`, `GSV`, `GLL`
1717
See: https://gpsd.gitlab.io/gpsd/NMEA.html#_nmea_standard_sentences
@@ -161,19 +161,13 @@ $ python nmea_data_convert.py test_data/test_data_GNGSA.nmea db --spc 2
161161

162162

163163
## Helpful References
164-
https://github.com/Knio/pynmea2/blob/master/README.md
165-
166-
https://www.u-blox.com/sites/default/files/products/documents/u-blox8-M8_ReceiverDescrProtSpec_%28UBX-13003221%29.pdf (section 31 'NMEA Protocol')
167-
168-
https://www.sparkfun.com/datasheets/GPS/NMEA%20Reference%20Manual1.pdf
169-
170-
https://www.trimble.com/OEM_ReceiverHelp/V4.44/en/NMEA-0183messages_MessageOverview.html
171-
172-
Talker Identifiers : https://www.nmea.org/Assets/20190303%20nmea%200183%20talker%20identifier%20mnemonics.pdf
173-
174-
Glossary : https://www.unavco.org/help/glossary/glossary.html
175-
176-
https://gpsd.gitlab.io/gpsd/NMEA.html#_nmea_standard_sentences
164+
* https://github.com/Knio/pynmea2/blob/master/README.md
165+
* https://www.u-blox.com/sites/default/files/products/documents/u-blox8-M8_ReceiverDescrProtSpec_%28UBX-13003221%29.pdf (section 31 'NMEA Protocol')
166+
* https://www.sparkfun.com/datasheets/GPS/NMEA%20Reference%20Manual1.pdf
167+
* https://www.trimble.com/OEM_ReceiverHelp/V4.44/en/NMEA-0183messages_MessageOverview.html
168+
* Talker Identifiers : https://www.nmea.org/Assets/20190303%20nmea%200183%20talker%20identifier%20mnemonics.pdf
169+
* Glossary : https://www.unavco.org/help/glossary/glossary.html
170+
* https://gpsd.gitlab.io/gpsd/NMEA.html#_nmea_standard_sentences
177171

178172
## Support
179173
If you find this tool useful, please consider supporting development of this tool and other tools like it. You can do so using the `Sponsor` button at the top of the [GitHub page](https://github.com/Petrichor-Labs/nmea_data_convert).

0 commit comments

Comments
 (0)