dotMorten/NmeaParser
1
0
Fork 0
mirror of https://github.com/dotMorten/NmeaParser.git synced 2026-02-01 05:14:13 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added links to doc site

Browse source
This commit is contained in:
Morten Nielsen 2020-01-19 18:57:58 -08:00
parent 27cb333b16
commit 1d1c12267a
2 changed files with 21 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
README.md
View file

@ -4,41 +4,33 @@ Nmea Parser
Library for reading and parsing NMEA data message streams.
It makes it easy to connect and listen for NMEA messages coming from various devices in Windows Universal, Windows Desktop/.NET and Windows Universal apps as well as Xamarin for iOS and Android.
## Sponsoring
If you like this library and use it a lot, consider sponsoring me. Anything helps and encourages me to keep going.
See here for details: https://github.com/sponsors/dotMorten
### Documentation
Read the full documentation here: https://dotmorten.github.io/NmeaParser/
### Features
The following inputs are supported:
- System.IO.Stream (all platforms)
- Emulation from NMEA log file (all platforms)
- Bluetooth: Windows Universal and Android. Desktop is supported using the bluetooth device via the SerialPortDevice.
- Serial Device: Windows Desktop and Windows Universal.
Currently supported NMEA messages:
- GNSS: BOD, GGA, GLL, GNS, GSA, GST, GSV, RMB, RMA, RMB, RMC, RTE, VTG, ZDA
- Garmin Proprietary: PGRME, PGRMZ
- Trimble Laser Range Finder: PTNLA, PTNLB
- TruePulse Laser Range Finder: PLTIT
The API is easily extensible with more NMEA messages. Simply create a new class inheriting from "NmeaMessage" and use the NmeaMessageType Attribute to tag it with the NMEA Message Token it supports.
Example:
```csharp
[NmeaMessageType("--RMC")]
public class Rmc : NmeaMessage
{
protected override void LoadMessage(string[] message)
{
//TODO: Process message parts
}
}
```
If you add new messages, please fork, provide a simple unit test for the message and submit a pull request.
- Most common NMEA messages fully supported
- GNSS: BOD, GGA, GLL, GNS, GSA, GST, GSV, RMB, RMA, RMB, RMC, RTE, VTG, ZDA
- Garmin Proprietary: PGRME, PGRMZ
- Trimble Laser Range Finder: PTNLA, PTNLB
- TruePulse Laser Range Finder: PLTIT
- Automatic merging of multi-sentence messages for simplified usage.
- Extensible with custom NMEA messages [see here](concepts/CustomMessages.html)
- Multiple input devices out of the box
- System.IO.Stream (all platforms)
- Emulation from NMEA log file (all platforms)
- Serial Device: .NET Framework, .NET Core (Windows, Linux, Mac) and Windows Universal.
- Bluetooth: Windows Universal and Android. .NET Core/.NET Framework is supported using the bluetooth device via the SerialPortDevice.
### NuGet
@ -52,7 +44,7 @@ You can get the library via [NuGet](http://www.nuget.org) if you have the extens
Usage
=====================
Please see the [WIKI](http://www.github.com/dotMorten/NmeaParser/wiki) how to use it on the various platforms
Please see the [Documentation](https://dotmorten.github.io/NmeaParser/concepts/index.html) on how to use it on the various platforms.
Screenshots
=====================

2
src/NmeaParser/NmeaParser.csproj
View file

@ -14,7 +14,7 @@
<Version>2.0-beta1</Version>
<Product>NMEA Parser</Product>
<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
<PackageProjectUrl>https://github.com/dotMorten/NmeaParser</PackageProjectUrl>
<PackageProjectUrl>https://dotmorten.github.io/NmeaParser/</PackageProjectUrl>
<RepositoryUrl>https://github.com/dotMorten/NmeaParser</RepositoryUrl>
<NeutralLanguage>en-US</NeutralLanguage>
<Copyright>Copyright © Morten Nielsen 2015-2020</Copyright>