QNearFieldManager#

The QNearFieldManager class provides access to notifications for NFC events. More

Synopsis#

Functions#

Signals#

Detailed Description#

NFC Forum devices support two modes of communications. The first mode, peer-to-peer communications, is used to communicate between two NFC Forum devices. The second mode, master/slave communications, is used to communicate between an NFC Forum device and an NFC Forum Tag or Contactless Card. The targetDetected() signal is emitted when a target device enters communications range. Communications can be initiated from the slot connected to this signal.

NFC Forum devices generally operate as the master in master/slave communications. Some devices are also capable of operating as the slave, so called Card Emulation mode. In this mode the local NFC device emulates a NFC Forum Tag or Contactless Card.

Applications can connect to the targetDetected() and targetLost() signals to get notified when an NFC Forum Tag enters or leaves proximity. Before these signals are emitted target detection must be started with the startTargetDetection() function. Target detection can be stopped with the stopTargetDetection() function. When the target is no longer required the target should be deleted as other applications may be blocked from accessing the target.

class PySide6.QtNfc.QNearFieldManager([parent=None])#
Parameters

parentPySide6.QtCore.QObject

Constructs a new near field manager with parent.

PySide6.QtNfc.QNearFieldManager.AdapterState#

This enum describes the different states a NFC adapter can have.

Constant

Description

QNearFieldManager.AdapterState.Offline

The nfc adapter is offline.

QNearFieldManager.AdapterState.TurningOn

The nfc adapter is turning on.

QNearFieldManager.AdapterState.Online

The nfc adapter is online.

QNearFieldManager.AdapterState.TurningOff

The nfc adapter is turning off.

PySide6.QtNfc.QNearFieldManager.adapterStateChanged(state)#
Parameters

stateAdapterState

PySide6.QtNfc.QNearFieldManager.isEnabled()#
Return type

bool

Returns true if the device has a NFC adapter and it is turned on; otherwise returns false.

See also

isSupported()

PySide6.QtNfc.QNearFieldManager.isSupported([accessMethod=QNearFieldTarget.AnyAccess])#
Parameters

accessMethodAccessMethod

Return type

bool

Returns true if the underlying device has a NFC adapter; otherwise returns false. If an accessMethod is given, the function returns true only if the NFC adapter supports the given accessMethod.

See also

isEnabled()

PySide6.QtNfc.QNearFieldManager.setUserInformation(message)#
Parameters

message – str

Sets the message shown to the user by the system. If the target detection is running the message will be updated immediately and can be used as a progress message. The last message set before a call to startTargetDetection() without an error message is used as a success message. If the target detection is not running the message will be used as the initial message when the next detection is started. By default no message is shown to the user.

Note

Currently, this function only has an effect on iOS because a popup is shown by the system during the scan. On iOS, this message is mapped to the alert message which is shown upon successful completion of the scan. Other platforms will ignore message.

PySide6.QtNfc.QNearFieldManager.startTargetDetection(accessMethod)#
Parameters

accessMethodAccessMethod

Return type

bool

Starts detecting targets and returns true if target detection is successfully started; otherwise returns false. Causes the targetDetected() signal to be emitted when a target is within proximity. Only tags with the given accessMethod will be delivered. Active detection continues until stopTargetDetection() has been called.

To detect targets with a different accessMethod, stopTargetDetection() must be called first.

PySide6.QtNfc.QNearFieldManager.stopTargetDetection([errorMessage=""])#
Parameters

errorMessage – str

Stops detecting targets. The targetDetected() signal will no longer be emitted until another call to startTargetDetection() is made. Targets detected before are still valid.

If an errorMessage is provided, this is a hint to the system that the goal, the application had, was not reached. The errorMessage and a matching error icon are shown to the user. Calling this function with an empty errorMessage, implies a successful operation end; otherwise an errorMessage should be passed to this function.

Note

Currently, errorMessage only has an effect on iOS because a popup is shown by the system during the scan where the errorMessage is visible. Other platforms will ignore this parameter.

PySide6.QtNfc.QNearFieldManager.targetDetected(target)#
Parameters

targetPySide6.QtNfc.QNearFieldTarget

PySide6.QtNfc.QNearFieldManager.targetDetectionStopped()#
PySide6.QtNfc.QNearFieldManager.targetLost(target)#
Parameters

targetPySide6.QtNfc.QNearFieldTarget