How to install libnfc on Ubuntu?

Install dependencies like libusb and pcsc-lite, then run autoreconf -vis if from git, or use a release tarball with ./configure, make, and make install. For device permissions, copy contrib/udev/93-pn53x.rules to /lib/udev/rules.d/ as per the README.

libnfc vs nfcpy: which should I use?

Libnfc is a C library for low-level, cross-platform NFC access with broad hardware support, ideal for embedded systems. Nfcpy is a Python library focused on ease of use for scripting; choose libnfc for performance and depth, nfcpy for rapid prototyping in Python.

How to configure libnfc for multiple NFC devices?

Create per-device configuration files in /etc/nfc/devices.d/ with name and connstring entries, as shown in the README's Configuration section, allowing fine-grained control over each device.

Does libnfc work with Raspberry Pi?

Yes, libnfc supports POSIX systems like Linux on Raspberry Pi, but ensure your NFC reader is compatible and install required dependencies such as libusb and pcsc-lite, following the README's building instructions.

How to troubleshoot ACR122 not being detected by libnfc?

Ensure pcscd is running and edit libccid_Info.plist to allow bogus devices or CCID exchange by changing ifdDriverOptions, as detailed in the Troubleshooting section for ACR122.

Can I use libnfc for Android app development?

No, libnfc is designed for userspace applications on desktop or embedded systems; for Android, use the built-in NFC APIs or libraries specifically tailored for mobile platforms.

What are the common issues with PN533 USB devices on Linux?

On Linux kernels >= 3.1, you must blacklist nfc, pn533, and pn533_usb modules to prevent conflicts; copy contrib/linux/blacklist-libnfc.conf to /etc/modprobe.d/, as noted in the Troubleshooting section.

Open-Awesome

libnfc

LGPL-3.0Clibnfc-1.8.0

A free, platform-independent library for accessing Near Field Communication (NFC) devices from userspace applications.

Visit Website GitHub

2.0k stars471 forks0 contributors

What is libnfc?

libnfc is a free, platform-independent library that enables userspace applications to communicate with Near Field Communication (NFC) devices. It provides a standardized interface for interacting with various NFC readers and tags, solving the problem of fragmented, vendor-specific NFC SDKs by offering a unified, open-source solution.

Target Audience

Developers and researchers working on NFC-enabled applications, embedded systems, or hardware projects that require low-level access to NFC devices across different platforms.

Value Proposition

Developers choose libnfc because it is a mature, libre alternative to proprietary NFC SDKs, offering broad hardware compatibility, cross-platform support, and the flexibility to work with multiple drivers and configurations without vendor lock-in.

Overview

Platform independent Near Field Communication (NFC) library

Use Cases

Best For

Building cross-platform NFC applications on Linux, macOS, or Windows
Developing embedded systems that require NFC reader integration
Research and prototyping with various NFC hardware devices
Creating tools for NFC tag reading, writing, and emulation
Integrating NFC functionality into existing software without proprietary dependencies
Educational projects exploring contactless communication protocols

Not Ideal For

Mobile app development for iOS or Android that requires native NFC SDKs
Projects needing out-of-the-box GUI tools or pre-built applications for NFC tasks
Environments where simple, dependency-free installation is critical
Commercial products requiring vendor-backed support and guaranteed updates

Pros & Cons

Pros

Cross-Platform Compatibility

Supports POSIX systems and Windows, allowing NFC development on Linux, macOS, and Windows, as highlighted in the README's platform independence.

Wide Hardware Support

Compatible with numerous NFC readers like PN532, ACR122, and Feitian devices via multiple drivers such as pn53x_usb and pcsc, per the README's device list.

Flexible Configuration Options

Enables configuration through files, environment variables, and per-device settings, offering fine-grained control, as detailed in the Configuration and Environment Variables sections.

Debugging and Logging

Provides configurable log levels (e.g., LIBNFC_LOG_LEVEL) and debugging tools to aid development, mentioned in the How to report bugs section.

Cons

Complex Setup and Dependencies

Requires installation of third-party libraries like libusb and pcsc-lite, plus manual steps such as blacklisting kernel modules or tweaking PCSC configurations, making initial setup non-trivial.

Outdated Community Resources

The official website and forum are defunct, relying on archived copies via Wayback Machine, which hinders access to current documentation and community support.

Limited High-Level Abstractions

As a low-level library, it lacks built-in tools for common NFC tasks like mobile app integration or tag emulation, forcing developers to implement functionality from scratch.

Frequently Asked Questions

Related Projects

Capstone

Capstone disassembly/disassembler framework for ARM, ARM64 (ARMv8), Alpha, BPF, Ethereum VM, HPPA, LoongArch, M68K, M680X, Mips, MOS65XX, PPC, RISC-V(rv32G/rv64G), SH, Sparc, SystemZ, TMS320C64X, TriCore, Webassembly, XCore and X86.

Stars8,680

Forks1,670

Last commit2 days ago

libimobiledevice

A cross-platform protocol library to communicate with iOS devices

Stars7,871

Forks1,492

Last commit4 months ago

CommonMark

CommonMark spec, with reference implementations in C and JavaScript

Stars5,080

Forks350

Last commit1 month ago

libffi

A portable foreign-function interface library.

Stars4,229

Forks806

Last commit3 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub