<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- nfc-index.qdoc -->
<title>Qt NFC 5.12.6</title>
<link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
<script type="text/javascript">
document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
// loading style sheet breaks anchors that were jumped to before
// so force jumping to anchor again
setTimeout(function() {
var anchor = location.hash;
// need to jump to different anchor first (e.g. none)
location.hash = "#";
setTimeout(function() {
location.hash = anchor;
}, 0);
}, 0);
</script>
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<table><tr>
<td >Qt 5.12</td><td >Qt NFC</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right">Qt 5.12.6 Reference Documentation</td>
</tr></table>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#overview">Overview</a></li>
<li class="level1"><a href="#getting-started">Getting Started</a></li>
<li class="level1"><a href="#licenses">Licenses</a></li>
<li class="level1"><a href="#related-information">Related Information</a></li>
<li class="level2"><a href="#guides">Guides</a></li>
<li class="level2"><a href="#reference">Reference</a></li>
<li class="level2"><a href="#logging-categories">Logging Categories</a></li>
<li class="level2"><a href="#examples">Examples</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Qt NFC</h1>
<span class="subtitle"></span>
<!-- $$$qtnfc-index.html-description -->
<div class="descr"> <a name="details"></a>
<p>The NFC API provides connectivity between NFC enabled devices.</p>
<p>Currently the API is supported on Android, and Linux using <a href="https://01.org/linux-nfc">Neard</a> v0.14 or later.</p>
<a name="overview"></a>
<h2 id="overview">Overview</h2>
<p>NFC is an extremely short-range (less than 20 centimeters) wireless technology and has a maximum transfer rate of 424 kbit/s. NFC is ideal for transferring small packets of data when two devices are touched together.</p>
<p>The NFC API provides APIs for interacting with NFC Forum Tags and NFC Forum Devices, including target detection and loss, registering NDEF message handlers, reading and writing NDEF messages on NFC Forum Tags and sending tag specific commands.</p>
<a name="getting-started"></a>
<h2 id="getting-started">Getting Started</h2>
<p>To use the C++ library in your application, add the following configuration option to your <code>.pro</code> file:</p>
<pre class="cpp">
QT += nfc
</pre>
<p>To use the classes of the module in your application you need the following import statement in your <code>.qml</code> file:</p>
<pre class="qml">
import QtNfc 5.12
</pre>
<a name="licenses"></a>
<h2 id="licenses">Licenses</h2>
<p>Qt NFC is available under commercial licenses from The Qt Company. In addition, it is available under free software licenses. Since Qt 5.4, these free software licenses are GNU Lesser General Public License, version 3, or the GNU General Public License, version 2. See Qt Licensing for further details.</p>
<a name="related-information"></a>
<h2 id="related-information">Related Information</h2>
<a name="guides"></a>
<h3 id="guides">Guides</h3>
<ul>
<li><a href="qtnfc-overview.html">Qt NFC Overview</a></li>
</ul>
<a name="reference"></a>
<h3 id="reference">Reference</h3>
<ul>
<li><a href="qtnfc-qmlmodule.html">QML Types</a></li>
<li><a href="qtnfc-module.html">C++ Classes</a></li>
</ul>
<a name="logging-categories"></a>
<h3 id="logging-categories">Logging Categories</h3>
<p>The <a href="qtnfc-module.html">QtNfc</a> module exports the following logging categories:</p>
<div class="table"><table class="generic">
<thead><tr class="qt-style"><th >Logging Category</th><th >Description</th></tr></thead>
<tr valign="top" class="odd"><td >qt.nfc.neard</td><td >Enables logging of the Neard/Linux implementation</td></tr>
</table></div>
<a name="examples"></a>
<h3 id="examples">Examples</h3>
<ul>
<li>QML<ul>
<li><a href="qtnfc-corkboard-example.html">CorkBoard</a></li>
<li><a href="qtnfc-poster-example.html">QML Poster</a></li>
</ul>
</li>
<li>C++<ul>
<li><a href="qtnfc-annotatedurl-example.html">Annotated URL</a></li>
<li><a href="qtnfc-ndefeditor-example.html">NDEF Editor</a></li>
</ul>
</li>
</ul>
</div>
<!-- @@@qtnfc-index.html -->
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2019 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.<br/> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br/> Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
