1// Copyright (C) 2013 Aaron McCarthy <mccarthy.aaron@gmail.com>
2// Copyright (C) 2021 The Qt Company Ltd.
3// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
8\brief Enables connectivity between NFC enabled devices.
9\ingroup technology-apis
11The NFC API provides connectivity between NFC enabled devices.
13Currently, the API is supported on \l{Qt for Android}{Android}, \l{Qt for
14iOS}{iOS} and \l{Qt for Linux}{Linux} using
15\l {https://github.com/linux-nfc/neard}{Neard} v0.14 or later.
16This module also provides limited access to readers supporting
17\l{PC/SC in Qt NFC}{PC/SC} specification on Linux, macOS, and Windows.
19NFC is a short-range (less than 20 centimeters) wireless technology
20with a maximum transfer rate of 424 Kbps. NFC is ideal for transferring
21small packets of data when two devices are placed together.
23The NFC module provides APIs for interacting with NFC Forum Tags and NFC Forum
24Devices. It can detect targets and losses, register NDEF message handlers, read
25and write NDEF messages on NFC Forum Tags, and send tag-specific commands.
27\section1 Using the Module
29\include {module-use.qdocinc} {using the c++ api} {NFC}
31\section2 Building with CMake
33\include {module-use.qdocinc} {building with cmake} {Nfc}
35\section2 Building with qmake
37\include {module-use.qdocinc} {building_with_qmake} {nfc}
39\section1 Articles and Guides
42 \li \l {Qt NFC Overview}
43 \li \l {Supported NFC Features}
44 \li \l {Qt NFC on Android}
45 \li \l {PC/SC in Qt NFC}
48\section1 Logging Categories
50The \l QtNfc module exports the following
51\l {Configuring Categories}{logging categories}:
59 \li Enables logging of the Neard/Linux implementation
65 \li \l {annotatedurl}{Annotated URL}
66 \li \l {ndefeditor}{NDEF Editor}
72 \li \l {Qt NFC C++ Classes}{C++ Classes}
75\section1 Module Evolution
77\l {Changes to Qt NFC} lists important changes in the module API and
78functionality that were done for the Qt 6 series of Qt.
82Qt NFC is available under commercial licenses from \l{The Qt Company}.
83In addition, it is available under free software licenses. Since Qt 5.4,
84these free software licenses are
85\l{GNU Lesser General Public License, version 3}, or
86the \l{GNU General Public License, version 2}.
87See \l{Qt Licensing} for further details.