NmeaParser/README.md

41 lines
1.6 KiB
Markdown
Raw Normal View History

2014-07-25 19:25:10 +02:00
Nmea Parser
2014-02-11 06:57:05 +01:00
=========
2014-11-15 06:21:45 +01:00
Library for handling data NMEA streams coming in from Bluetooth devices in Windows Store and Windows Phone, and Serial ports in Windows Desktop apps. Stream and File support is available for Xamarin Android and iOS devices.
2014-07-25 21:58:49 +02:00
There's also generic support for NMEA files (for simulation/playback) and raw streams.
2014-02-11 07:33:55 +01:00
2014-07-25 22:01:36 +02:00
This library makes it easy to connect and listen for NMEA messages from various Devices in Windows Store, Windows Phone and Windows Desktop apps.
2014-02-11 07:33:55 +01:00
2014-07-31 23:09:39 +02:00
Currently supported NMEA messages:
2014-07-31 23:09:12 +02:00
- Generic GPS NMEA (GPRMC, GPGGA, GPGLL, GPGSA, GPGSCV, GPRMB, GPRMC, GPBOD, GPRTE)
- Garmin GPS NMEA (PGRME, PGRMZ)
2014-07-31 08:18:31 +02:00
- Trimble Laser Range Finder (PTNLA, PTNLB)
- TruePulse Laser Range Finder (PLTIT)
2014-02-11 07:38:13 +01:00
2014-07-31 08:20:17 +02:00
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.
2014-02-11 07:38:13 +01:00
Example:
2014-07-31 23:09:12 +02:00
```csharp
2014-02-11 07:38:13 +01:00
[NmeaMessageType(Type = "GPRMC")]
public class Gprmc : NmeaMessage
{
protected override void LoadMessage(string[] message)
{
2014-07-25 22:01:36 +02:00
//TODO: Process message parts
2014-02-11 07:38:13 +01:00
}
}
```
2014-02-11 07:41:13 +01:00
If you add new messages, please fork, provide a simple unit test for the message and submit a pull request.
2014-02-11 07:33:55 +01:00
2014-07-31 08:16:16 +02:00
### NuGet
You can get the library via [NuGet](http://www.nuget.org) if you have the extension installed for Visual Studio or via the PowerShell package manager. This control is published via NuGet at [SharpGIS.NmeaParser](https://nuget.org/packages/SharpGIS.NmeaParser).
2014-07-25 21:58:49 +02:00
Usage
2014-02-11 07:33:55 +01:00
=====================
2014-07-25 21:26:16 +02:00
2014-07-25 22:00:29 +02:00
Please see the [WIKI](http://www.github.com/dotMorten/NmeaParser/wiki) how to use it on the various platforms