This section documents the usage of the current Open NFC stack. To get information about porting Open NFC on new hardware or software environment, please refer to the Porting Guide page.

The Open NFC documentation is included in the software package. This page gives pointers to the proper documents to help you find the information you are looking for.

Open NFC comes in different Editions. Click here to learn more about the available editions. Editions are reference portings of Open NFC to different environments (software and hardware).

If you are an application developer and user of the Open NFC stack, the following documents contain all you need to know about the Application Programming Interface (API) of Open NFC:

Open NFC Core library C API

This document describes the basics of Open NFC, including its architecture, and all the supported features. It also describes the different architectures of Open NFC (monolithic, client-server, …) and the error conditions. All users of Open NFC should start with this document to get a good understanding of the Open NFC stack.
The C API manual can be found in the Core Edition package, under /core/documents/. It is named “SIS_NFC_0707-003“. The format is “.chm“.

Open NFC Java binding API

The SDK, Core and Linux Editions of Open NFC include since version 4.3.1 a Java binding wrapper over the Open NFC library. The wrapper gives access to the complete Open NFC library from Java applications.
The Java API documentation can be found in the different editions, under /core/porting/jni/ in file “SIS_NFC_1003-188“. It is a zip file containing html pages.

Open NFC for Android API

The Android Edition of Open NFC is fully compatible with the standard Android API: you can develop applications for Open NFC using the standard Android API.

More generally, you will be interested in reading the Porting Guide document related to your Edition, for example: FSP_NFC_0709-014 for the Core Edition.

Finally, all additional tools provided have their own documentation. For example, the Connection Center user manual is MAN_NFC_0904-106; the Win32 example applications are documented in MAN_NFC_0901-099, etc.