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

Added DocFX documentation

Browse source
This commit is contained in:
Morten Nielsen 2020-01-19 18:30:43 -08:00
parent 9a32f41edf
commit 3571fdec12
25 changed files with 563 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

30
docs/concepts/index.md Normal file
View file

@ -0,0 +1,30 @@
# Getting started:
### 1. Install from 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).
<table border="4px">
<tr><td>
<code>PM&gt; Install-Package SharpGIS.NmeaParser</code>
</td></tr></table>
### 2. Create a new device:
```cs
// Create one of the NMEA devices
var device = new NmeaFileDevice("PathToNmeaLogFile.txt", 1000);
// Listen to messages from the device:
device.MessageReceived += device_NmeaMessageReceived;
// Open the device and start receiving:
device.OpenAsync();
// Create event handler for receiving messages:
private void device_NmeaMessageReceived(NmeaDevice sender, NmeaMessageReceivedEventArgs args)
{
// called when a message is received
}
```
See the Platform specific device creation section in the menu for more specifics on device creation.
### 3. [Browse the API Reference](api/index.html)