<?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-overview.qdoc -->
<title>Qt NFC Overview | 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 ><a href="qtnfc-index.html">Qt NFC</a></td><td >Qt NFC Overview</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qtnfc-index.html">Qt 5.12.6 Reference Documentation</a></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="#c-overview">C++ Overview</a></li>
<li class="level2"><a href="#detecting-nfc-tags">Detecting NFC Tags</a></li>
<li class="level2"><a href="#reading-and-writing-ndef-messages">Reading and Writing NDEF Messages</a></li>
<li class="level2"><a href="#registering-ndef-message-handlers">Registering NDEF Message Handlers</a></li>
<li class="level2"><a href="#sharing-files-and-messages">Sharing Files and Messages</a></li>
<li class="level1"><a href="#qml-overview">QML Overview</a></li>
<li class="level2"><a href="#reading-ndef-messages">Reading NDEF Messages</a></li>
</ul>
</div>
<div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">Qt NFC Overview</h1>
<span class="subtitle"></span>
<!-- $$$qtnfc-overview.html-description -->
<div class="descr"> <a name="details"></a>
<p>With the Qt NFC API typical use cases are:</p>
<ul>
<li>Detecting NFC tags.</li>
<li>Reading and writing NDEF messages.</li>
<li>Registering NDEF message handlers.</li>
<li>Sharing files and messages.</li>
</ul>
<p>The following sections describe how to use Qt NFC C++ classes and QML types for the above use cases.</p>
<p><b>Note: </b>On Android, Qt Nfc only works in foreground applications. Android services are not supported which is due to API limitations on the Android side.</p><a name="c-overview"></a>
<h2 id="c-overview">C++ Overview</h2>
<p>The C++ API provides access to the full feature set of the Qt NFC API. This section introduces the major features available to developers.</p>
<a name="detecting-nfc-tags"></a>
<h3 id="detecting-nfc-tags">Detecting NFC Tags</h3>
<p>The <a href="qnearfieldmanager.html">QNearFieldManager</a> class is responsible for the detection of new NFC tags coming into range of the device. The <a href="qnearfieldmanager.html#targetDetected">QNearFieldManager::targetDetected</a>() and <a href="qnearfieldmanager.html#targetLost">QNearFieldManager::targetLost</a>() signals are emitted when a tag comes into or leaves the range. The passed <a href="qnearfieldtarget.html">QNearFieldTarget</a> parameter acts as primary interaction point for each detected tag. The detection does not actually start though until <a href="qnearfieldmanager.html#startTargetDetection">QNearFieldManager::startTargetDetection</a>() has been called.</p>
<pre class="cpp">
m_manager <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qnearfieldmanager.html">QNearFieldManager</a></span>(<span class="keyword">this</span>);
connect(m_manager<span class="operator">,</span> <span class="operator">&</span><span class="type"><a href="qnearfieldmanager.html">QNearFieldManager</a></span><span class="operator">::</span>targetDetected<span class="operator">,</span>
<span class="keyword">this</span><span class="operator">,</span> <span class="operator">&</span>MainWindow<span class="operator">::</span>targetDetected);
connect(m_manager<span class="operator">,</span> <span class="operator">&</span><span class="type"><a href="qnearfieldmanager.html">QNearFieldManager</a></span><span class="operator">::</span>targetLost<span class="operator">,</span>
<span class="keyword">this</span><span class="operator">,</span> <span class="operator">&</span>MainWindow<span class="operator">::</span>targetLost);
m_manager<span class="operator">-</span><span class="operator">></span>startTargetDetection();
</pre>
<p>Finally the detection can be stopped:</p>
<pre class="cpp">
m_manager<span class="operator">-</span><span class="operator">></span>stopTargetDetection();
</pre>
<p>Although each <a href="qnearfieldtarget.html">QNearFieldTarget</a> instance is owned by its related <a href="qnearfieldmanager.html">QNearFieldManager</a> instance it can be beneficial to manually delete each instance. Otherwise they would continue to exist until the <a href="qnearfieldmanager.html">QNearFieldManager</a> instance is deleted. The best way to do that would be in response to the <a href="qnearfieldmanager.html#targetLost">QNearFieldManager::targetLost</a>() signal:</p>
<pre class="cpp">
<span class="type">void</span> MainWindow<span class="operator">::</span>targetLost(<span class="type"><a href="qnearfieldtarget.html">QNearFieldTarget</a></span> <span class="operator">*</span>target)
{
target<span class="operator">-</span><span class="operator">></span>deleteLater();
}
</pre>
<p><b>Note: </b>The target object should only be deleted via deleteLater() if it is deleted inside the slot.</p><a name="reading-and-writing-ndef-messages"></a>
<h3 id="reading-and-writing-ndef-messages">Reading and Writing NDEF Messages</h3>
<p>The <a href="qnearfieldtarget.html">QNearFieldTarget</a> instance returned by <a href="qnearfieldmanager.html#targetDetected">QNearFieldManager::targetDetected</a>() signal is used to interact with the tag. Reading and writing a message is an asynchronous operation. The <a href="qnearfieldtarget-requestid.html">QNearFieldTarget::RequestId</a> class associates individual operations and their results.</p>
<pre class="cpp">
<span class="type">void</span> MainWindow<span class="operator">::</span>targetDetected(<span class="type"><a href="qnearfieldtarget.html">QNearFieldTarget</a></span> <span class="operator">*</span>target)
{
<span class="keyword">switch</span> (m_touchAction) {
<span class="keyword">case</span> NoAction:
<span class="keyword">break</span>;
<span class="keyword">case</span> ReadNdef:
connect(target<span class="operator">,</span> <span class="operator">&</span><span class="type"><a href="qnearfieldtarget.html">QNearFieldTarget</a></span><span class="operator">::</span>ndefMessageRead<span class="operator">,</span> <span class="keyword">this</span><span class="operator">,</span> <span class="operator">&</span>MainWindow<span class="operator">::</span>ndefMessageRead);
connect(target<span class="operator">,</span> <span class="operator">&</span><span class="type"><a href="qnearfieldtarget.html">QNearFieldTarget</a></span><span class="operator">::</span>error<span class="operator">,</span> <span class="keyword">this</span><span class="operator">,</span> <span class="operator">&</span>MainWindow<span class="operator">::</span>targetError);
m_request <span class="operator">=</span> target<span class="operator">-</span><span class="operator">></span>readNdefMessages();
<span class="keyword">if</span> (<span class="operator">!</span>m_request<span class="operator">.</span>isValid()) <span class="comment">// cannot read messages</span>
targetError(<span class="type"><a href="qnearfieldtarget.html">QNearFieldTarget</a></span><span class="operator">::</span>NdefReadError<span class="operator">,</span> m_request);
<span class="keyword">break</span>;
<span class="keyword">case</span> WriteNdef:
connect(target<span class="operator">,</span> <span class="operator">&</span><span class="type"><a href="qnearfieldtarget.html">QNearFieldTarget</a></span><span class="operator">::</span>ndefMessagesWritten<span class="operator">,</span> <span class="keyword">this</span><span class="operator">,</span> <span class="operator">&</span>MainWindow<span class="operator">::</span>ndefMessageWritten);
connect(target<span class="operator">,</span> <span class="operator">&</span><span class="type"><a href="qnearfieldtarget.html">QNearFieldTarget</a></span><span class="operator">::</span>error<span class="operator">,</span> <span class="keyword">this</span><span class="operator">,</span> <span class="operator">&</span>MainWindow<span class="operator">::</span>targetError);
m_request <span class="operator">=</span> target<span class="operator">-</span><span class="operator">></span>writeNdefMessages(<span class="type">QList</span><span class="operator"><</span><span class="type"><a href="qndefmessage.html">QNdefMessage</a></span><span class="operator">></span>() <span class="operator"><</span><span class="operator"><</span> ndefMessage());
<span class="keyword">if</span> (<span class="operator">!</span>m_request<span class="operator">.</span>isValid()) <span class="comment">// cannot write messages</span>
targetError(<span class="type"><a href="qnearfieldtarget.html">QNearFieldTarget</a></span><span class="operator">::</span>NdefWriteError<span class="operator">,</span> m_request);
<span class="keyword">break</span>;
}
}
</pre>
<p>Once the <a href="qnearfieldtarget.html#readNdefMessages">QNearFieldTarget::readNdefMessages</a>() request was successfully processed, the <a href="qnearfieldtarget.html#ndefMessageRead">QNearFieldTarget::ndefMessageRead</a>() signal is emitted. Each returned <a href="qndefmessage.html">QNdefMessage</a> may consist of zero or more <a href="qndefrecord.html">QNdefRecord</a> entries, which can be identified by their type. For more information about processing of records, see the <a href="qndefrecord.html">QNdefRecord</a> class documentation. As the above code demonstrates, writing of NDEF messages is triggered via <a href="qnearfieldtarget.html#writeNdefMessages">QNearFieldTarget::writeNdefMessages</a>(). The successful completion of the write operation is indicated by the emission of the <a href="qnearfieldtarget.html#ndefMessagesWritten">QNearFieldTarget::ndefMessagesWritten</a>() signal. Any type of error during read or write is indicated via <a href="qnearfieldtarget.html#error">QNearFieldTarget::error</a>().</p>
<a name="registering-ndef-message-handlers"></a>
<h3 id="registering-ndef-message-handlers">Registering NDEF Message Handlers</h3>
<p>The above described method (of reading NDEF messages) directly connects to the platform's NFC infrastructure. However on some platforms (in particular mobile platforms) this may not actually trigger the target slot if the application is currently running in the background. This is not desirable in cases where an application wants to be activated if the platform detects a tag of particular type. For this purpose the Qt NFC API provides the possibility to register an NDEF message handler. The handler is called by the operating system, when the detected NDEF message matches the given filter criteria. Depending on the platform it may even be possible to start the application that registered the handler.</p>
<p><b>Note: </b>This feature is not available on all platforms and, in addition to the code snippets below, may require further platform specific setup.</p><pre class="cpp">
manager <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qnearfieldmanager.html">QNearFieldManager</a></span>(<span class="keyword">this</span>);
<span class="keyword">if</span> (<span class="operator">!</span>manager<span class="operator">-</span><span class="operator">></span>isAvailable()) {
qWarning() <span class="operator"><</span><span class="operator"><</span> <span class="string">"NFC not available"</span>;
<span class="keyword">return</span>;
}
<span class="type"><a href="qndeffilter.html">QNdefFilter</a></span> filter;
filter<span class="operator">.</span>setOrderMatch(<span class="keyword">false</span>);
filter<span class="operator">.</span>appendRecord<span class="operator"><</span><span class="type"><a href="qndefnfctextrecord.html">QNdefNfcTextRecord</a></span><span class="operator">></span>(<span class="number">1</span><span class="operator">,</span> UINT_MAX);
filter<span class="operator">.</span>appendRecord<span class="operator"><</span><span class="type"><a href="qndefnfcurirecord.html">QNdefNfcUriRecord</a></span><span class="operator">></span>();
<span class="comment">// type parameter cannot specify substring so filter for "image/" below</span>
filter<span class="operator">.</span>appendRecord(<span class="type"><a href="qndefrecord.html">QNdefRecord</a></span><span class="operator">::</span>Mime<span class="operator">,</span> <span class="type">QByteArray</span>()<span class="operator">,</span> <span class="number">0</span><span class="operator">,</span> <span class="number">1</span>);
<span class="type">int</span> result <span class="operator">=</span> manager<span class="operator">-</span><span class="operator">></span>registerNdefMessageHandler(filter<span class="operator">,</span> <span class="keyword">this</span><span class="operator">,</span>
SLOT(handleMessage(<span class="type"><a href="qndefmessage.html">QNdefMessage</a></span><span class="operator">,</span><span class="type"><a href="qnearfieldtarget.html">QNearFieldTarget</a></span><span class="operator">*</span>)));
</pre>
<p>For comparison an application that uses an empty NDEF filter (match all behavior) in combination with <a href="qnearfieldmanager.html#registerNdefMessageHandler">QNearFieldManager::registerNdefMessageHandler</a>() would behave similarly to another application that uses <a href="qnearfieldtarget.html#readNdefMessages">QNearFieldTarget::readNdefMessages</a>() while being in the forground. For more information about registration details of NDEF message handlers, see the <a href="qnearfieldmanager.html#automatically-launching-ndef-message-handlers">QNearFieldManager</a> class description.</p>
<p>The content of <code>handleMessage()</code> may look like the snippet below. Any incoming NDEF message of type <code>text</code> or <code>uri</code> will be processed:</p>
<pre class="cpp">
<span class="type">void</span> AnnotatedUrl<span class="operator">::</span>handleMessage(<span class="keyword">const</span> <span class="type"><a href="qndefmessage.html">QNdefMessage</a></span> <span class="operator">&</span>message<span class="operator">,</span> <span class="type"><a href="qnearfieldtarget.html">QNearFieldTarget</a></span> <span class="operator">*</span>target)
{
<span class="keyword">for</span> (<span class="keyword">const</span> <span class="type"><a href="qndefrecord.html">QNdefRecord</a></span> <span class="operator">&</span>record : message) {
<span class="keyword">if</span> (record<span class="operator">.</span>isRecordType<span class="operator"><</span><span class="type"><a href="qndefnfctextrecord.html">QNdefNfcTextRecord</a></span><span class="operator">></span>()) {
<span class="type"><a href="qndefnfctextrecord.html">QNdefNfcTextRecord</a></span> textRecord(record);
title <span class="operator">=</span> textRecord<span class="operator">.</span>text();
<span class="type">QLocale</span> locale(textRecord<span class="operator">.</span>locale());
} <span class="keyword">else</span> <span class="keyword">if</span> (record<span class="operator">.</span>isRecordType<span class="operator"><</span><span class="type"><a href="qndefnfcurirecord.html">QNdefNfcUriRecord</a></span><span class="operator">></span>()) {
<span class="type"><a href="qndefnfcurirecord.html">QNdefNfcUriRecord</a></span> uriRecord(record);
url <span class="operator">=</span> uriRecord<span class="operator">.</span>uri();
} <span class="keyword">else</span> <span class="keyword">if</span> (record<span class="operator">.</span>typeNameFormat() <span class="operator">=</span><span class="operator">=</span> <span class="type"><a href="qndefrecord.html">QNdefRecord</a></span><span class="operator">::</span>Mime <span class="operator">&</span><span class="operator">&</span>
record<span class="operator">.</span>type()<span class="operator">.</span>startsWith(<span class="string">"image/"</span>)) {
pixmap <span class="operator">=</span> <span class="type">QPixmap</span><span class="operator">::</span>fromImage(<span class="type">QImage</span><span class="operator">::</span>fromData(record<span class="operator">.</span>payload()));
}
}
<span class="keyword">emit</span> annotatedUrl(url<span class="operator">,</span> title<span class="operator">,</span> pixmap);
}
</pre>
<a name="sharing-files-and-messages"></a>
<h3 id="sharing-files-and-messages">Sharing Files and Messages</h3>
<p>Since Qt 5.3, Qt NFC provides a generic NFC share feature. If both devices support the same protocol, the feature can be used to share files or NDEF messages. The advantage is that the two involved partners can quickly establish a connection via NFC but transfer the data through, for example, Bluetooth or Wifi. Effectively, this combines the low configuration effort of NFC with high data rate communication bearers which usually require a much more complex setup.</p>
<p><b>Note: </b>The API does not make any guarantees about the actual communication bearer used during the transfer. The bearer is chosen based on the device's capabilities and the properties of the to-be-shared data.</p><p><a href="qnearfieldsharemanager.html">QNearFieldShareManager</a> and <a href="qnearfieldsharetarget.html">QNearFieldShareTarget</a> are responsible for accessing the NFC share feature.</p>
<a name="qml-overview"></a>
<h2 id="qml-overview">QML Overview</h2>
<p>The QML API only supports a very small subset of the Qt NFC feature set. This section outlines the available QML features.</p>
<a name="reading-ndef-messages"></a>
<h3 id="reading-ndef-messages">Reading NDEF Messages</h3>
<p>The user can specify NDEF filters and use those filters to register for the automatic reception of NDEF messages which match those filters. The <a href="qml-qtnfc-nearfield.html#messageRecords-prop">NearField::messageRecords</a> property contains the list of NDEF records of the last NDEF message read matching the given filters.</p>
<pre class="qml">
NearField {
filter: [ NdefFilter { type: "U"; typeNameFormat: NdefRecord.NfcRtd; minimum: 1; maximum: 1 } ]
orderMatch: false
onMessageRecordsChanged: displayMessage()
}
</pre>
<p>If no filter is set, the message handler will match all incoming NDEF messages.</p>
</div>
<!-- @@@qtnfc-overview.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>
