mirror of
https://github.com/dotMorten/NmeaParser.git
synced 2026-01-30 04:14:22 +01:00
279 lines
12 KiB
HTML
279 lines
12 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<!--[if IE]><![endif]-->
|
||
|
|
<html>
|
||
|
|
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||
|
|
<title>Class EAAccessoryDevice </title>
|
||
|
|
<meta name="viewport" content="width=device-width">
|
||
|
|
<meta name="title" content="Class EAAccessoryDevice ">
|
||
|
|
|
||
|
|
<meta name="description" content="Creates an object to read from an iOS accessory like a Bluetooth device.">
|
||
|
|
<link rel="shortcut icon" href="../../favicon.ico">
|
||
|
|
<link rel="stylesheet" href="../../styles/docfx.vendor.min.css">
|
||
|
|
<link rel="stylesheet" href="../../styles/docfx.css">
|
||
|
|
<link rel="stylesheet" href="../../styles/main.css">
|
||
|
|
<meta property="docfx:navrel" content="../../toc.html">
|
||
|
|
<meta property="docfx:tocrel" content="toc.html">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</head>
|
||
|
|
<body data-spy="scroll" data-target="#affix" data-offset="120">
|
||
|
|
<div id="wrapper">
|
||
|
|
<header>
|
||
|
|
|
||
|
|
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
|
||
|
|
<div class="container">
|
||
|
|
<div class="navbar-header">
|
||
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
|
||
|
|
<span class="sr-only">Toggle navigation</span>
|
||
|
|
<span class="icon-bar"></span>
|
||
|
|
<span class="icon-bar"></span>
|
||
|
|
<span class="icon-bar"></span>
|
||
|
|
</button>
|
||
|
|
|
||
|
|
<a class="navbar-brand" href="../../index.html">
|
||
|
|
<img id="logo" class="svg" src="../../images/logo.png" alt="">
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
<div class="collapse navbar-collapse" id="navbar">
|
||
|
|
<form class="navbar-form navbar-right" role="search" id="search">
|
||
|
|
<div class="form-group">
|
||
|
|
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
|
||
|
|
</div>
|
||
|
|
</form>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<div class="subnav navbar navbar-default">
|
||
|
|
<div class="container hide-when-search" id="breadcrumb">
|
||
|
|
<ul class="breadcrumb">
|
||
|
|
<li></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</header>
|
||
|
|
<div role="main" class="container body-content hide-when-search">
|
||
|
|
|
||
|
|
<div class="sidenav hide-when-search">
|
||
|
|
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
|
||
|
|
<div class="sidetoggle collapse" id="sidetoggle">
|
||
|
|
<div id="sidetoc"></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div class="article row grid-right">
|
||
|
|
<div class="col-md-10">
|
||
|
|
<article class="content wrap" id="_content" data-uid="NmeaParser.EAAccessoryDevice">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h1 id="NmeaParser_EAAccessoryDevice" data-uid="NmeaParser.EAAccessoryDevice" class="text-break">Class EAAccessoryDevice</h1>
|
||
|
|
<div class="markdown level0 summary"><p>Creates an object to read from an iOS accessory like a Bluetooth device.</p>
|
||
|
|
</div>
|
||
|
|
<div class="markdown level0 conceptual"></div>
|
||
|
|
<div class="inheritance">
|
||
|
|
<h5>Inheritance</h5>
|
||
|
|
<div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||
|
|
<div class="level1"><a class="xref" href="NmeaParser.NmeaDevice.html">NmeaDevice</a></div>
|
||
|
|
<div class="level2"><span class="xref">EAAccessoryDevice</span></div>
|
||
|
|
</div>
|
||
|
|
<div class="implements">
|
||
|
|
<h5>Implements</h5>
|
||
|
|
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div>
|
||
|
|
</div>
|
||
|
|
<div class="inheritedMembers">
|
||
|
|
<h5>Inherited Members</h5>
|
||
|
|
<div>
|
||
|
|
<a class="xref" href="NmeaParser.NmeaDevice.OpenAsync.html#NmeaParser_NmeaDevice_OpenAsync">NmeaDevice.OpenAsync()</a>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<a class="xref" href="NmeaParser.NmeaDevice.ReadAsync.html#NmeaParser_NmeaDevice_ReadAsync_System_Byte___System_Int32_System_Int32_System_Threading_CancellationToken_">NmeaDevice.ReadAsync(byte[], int, int, CancellationToken)</a>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<a class="xref" href="NmeaParser.NmeaDevice.CloseAsync.html#NmeaParser_NmeaDevice_CloseAsync">NmeaDevice.CloseAsync()</a>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<a class="xref" href="NmeaParser.NmeaDevice.MessageReceived.html">NmeaDevice.MessageReceived</a>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<a class="xref" href="NmeaParser.NmeaDevice.DeviceDisconnected.html">NmeaDevice.DeviceDisconnected</a>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<a class="xref" href="NmeaParser.NmeaDevice.Dispose.html#NmeaParser_NmeaDevice_Dispose">NmeaDevice.Dispose()</a>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<a class="xref" href="NmeaParser.NmeaDevice.Dispose.html#NmeaParser_NmeaDevice_Dispose_System_Boolean_">NmeaDevice.Dispose(bool)</a>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<a class="xref" href="NmeaParser.NmeaDevice.IsOpen.html#NmeaParser_NmeaDevice_IsOpen">NmeaDevice.IsOpen</a>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<a class="xref" href="NmeaParser.NmeaDevice.CanWrite.html#NmeaParser_NmeaDevice_CanWrite">NmeaDevice.CanWrite</a>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<a class="xref" href="NmeaParser.NmeaDevice.WriteAsync.html#NmeaParser_NmeaDevice_WriteAsync_System_Byte___System_Int32_System_Int32_">NmeaDevice.WriteAsync(byte[], int, int)</a>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h6><strong>Namespace</strong>: <a class="xref" href="NmeaParser.html">NmeaParser</a></h6>
|
||
|
|
<h6><strong>Assembly</strong>: NmeaParser.dll</h6>
|
||
|
|
<h5 id="NmeaParser_EAAccessoryDevice_syntax">Syntax</h5>
|
||
|
|
<div class="codewrapper">
|
||
|
|
<pre><code class="lang-csharp hljs">public class EAAccessoryDevice : NmeaDevice, IDisposable</code></pre>
|
||
|
|
</div>
|
||
|
|
<h5 id="NmeaParser_EAAccessoryDevice_remarks"><strong>Remarks</strong></h5>
|
||
|
|
<div class="markdown level0 remarks"><p>It's worth nothing that iOS is very limited to what devices it can connect to, and generally
|
||
|
|
needs to be MFI certified devices.</p>
|
||
|
|
<p>
|
||
|
|
To connect to a device in an iOS app, the device must be supported by iOS and enabled in <code>Info.plist</code>.
|
||
|
|
As an example you can declare a Bad Elf GPS receiver like this in the plist:
|
||
|
|
</p>
|
||
|
|
<pre><code class="lang-csharp"><key>UISupportedExternalAccessoryProtocols</key>
|
||
|
|
<array>
|
||
|
|
<string>com.bad-elf.gps</string>
|
||
|
|
</array></code></pre>
|
||
|
|
<p>
|
||
|
|
If using a bad-elf GPS, make sure you send the configuration to enable sending NMEA data.
|
||
|
|
Example:
|
||
|
|
<pre><code class="lang-csharp">var device = new EAAccessoryDevice(accessory, "com.bad-elf.gps");
|
||
|
|
await device.OpenAsync();
|
||
|
|
// BadElf start packet.
|
||
|
|
// See https://github.com/BadElf/gps-sdk/blob/master/README.md#extended-nmea-sentences-with-gsa-and-gsv-satellite-data-and-dop-values
|
||
|
|
byte[] startPacket = new byte[] { 0x24, 0xbe, 0x00, 0x11, 0x16, 0x01, 0x02, 0xf4, 0x31, 0x0a, 0x32, 0x04, 0x33, 0x02, 0x5a, 0x0d, 0x0a };
|
||
|
|
await device.WriteAsync(startPacket, 0, startPacket.Length);</code></pre>
|
||
|
|
</div>
|
||
|
|
<h3 id="constructors">Constructors
|
||
|
|
</h3>
|
||
|
|
<table class="table table-bordered table-condensed">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td id="NmeaParser_EAAccessoryDevice__ctor_ExternalAccessory_EAAccessory_System_String_" data-uid="NmeaParser.EAAccessoryDevice.#ctor(ExternalAccessory.EAAccessory,System.String)">
|
||
|
|
<a class="xref" href="NmeaParser.EAAccessoryDevice.-ctor.html#NmeaParser_EAAccessoryDevice__ctor_ExternalAccessory_EAAccessory_System_String_">EAAccessoryDevice(EAAccessory, string)</a>
|
||
|
|
</td>
|
||
|
|
<td class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="NmeaParser.EAAccessoryDevice.html">EAAccessoryDevice</a> class.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
<h3 id="methods">Methods
|
||
|
|
</h3>
|
||
|
|
<table class="table table-bordered table-condensed">
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Name</th>
|
||
|
|
<th>Description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td id="NmeaParser_EAAccessoryDevice_CloseStreamAsync_System_IO_Stream_" data-uid="NmeaParser.EAAccessoryDevice.CloseStreamAsync(System.IO.Stream)">
|
||
|
|
<a class="xref" href="NmeaParser.EAAccessoryDevice.CloseStreamAsync.html#NmeaParser_EAAccessoryDevice_CloseStreamAsync_System_IO_Stream_">CloseStreamAsync(Stream)</a>
|
||
|
|
</td>
|
||
|
|
<td class="markdown level1 summary"><p>Closes the stream the NmeaDevice is working on top off.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td id="NmeaParser_EAAccessoryDevice_GetDevices" data-uid="NmeaParser.EAAccessoryDevice.GetDevices">
|
||
|
|
<a class="xref" href="NmeaParser.EAAccessoryDevice.GetDevices.html#NmeaParser_EAAccessoryDevice_GetDevices">GetDevices()</a>
|
||
|
|
</td>
|
||
|
|
<td class="markdown level1 summary"><p>Gets a list of supported known EAAccessories that support NMEA</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td id="NmeaParser_EAAccessoryDevice_OpenStreamAsync" data-uid="NmeaParser.EAAccessoryDevice.OpenStreamAsync">
|
||
|
|
<a class="xref" href="NmeaParser.EAAccessoryDevice.OpenStreamAsync.html#NmeaParser_EAAccessoryDevice_OpenStreamAsync">OpenStreamAsync()</a>
|
||
|
|
</td>
|
||
|
|
<td class="markdown level1 summary"><p>Creates and opens the stream the NmeaDevice is working on top off.</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h3 id="appliesTo">Applies</h3>
|
||
|
|
|
||
|
|
<div class="appliesto">
|
||
|
|
<div>
|
||
|
|
<table>
|
||
|
|
<thead><th>Target</th><th>Versions</th></thead>
|
||
|
|
<tbody>
|
||
|
|
<tr><td><b>.NET iOS</b></td><td>main, v3.0</td></tr>
|
||
|
|
<tr><td><b>Xamarin.iOS</b></td><td>v2.2</td></tr>
|
||
|
|
</tbody>
|
||
|
|
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</article>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
||
|
|
<div class="sideaffix">
|
||
|
|
<div class="contribution">
|
||
|
|
<ul class="nav">
|
||
|
|
<li>
|
||
|
|
<a href="https://github.com/dotMorten/NmeaParser/blob/main/artifacts/docs/api_overwrites/applies-to-overwrite.md/#L11382" class="contribution-link">Edit this page</a>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<a href="https://github.com/dotMorten/NmeaParser/blob/main/src/NmeaParser/EAAccessoryDevice.iOS.cs/#L54" class="contribution-link">View Source</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
||
|
|
<h5>In this article</h5>
|
||
|
|
<div></div>
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<footer>
|
||
|
|
<div class="grad-bottom"></div>
|
||
|
|
<div class="footer">
|
||
|
|
<div class="container">
|
||
|
|
<span class="pull-right">
|
||
|
|
<a href="#top">Back to top</a>
|
||
|
|
</span>
|
||
|
|
|
||
|
|
<span>Generated by <strong>DocFX</strong></span>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</footer>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<script type="text/javascript" src="../../styles/docfx.vendor.min.js"></script>
|
||
|
|
<script type="text/javascript" src="../../styles/docfx.js"></script>
|
||
|
|
<script type="text/javascript" src="../../styles/main.js"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|