Skip to content

NFC library using PN532 to read/write card and communicate with android

License

Notifications You must be signed in to change notification settings

Seeed-Studio/PN532

 
 

Repository files navigation

NFC library

This is an library for PN532 to use NFC technology. It is for NFC Shield and Grove - NFC.

NFC Shield Grove - NFC

Features

To Do

  • To support more than one INFO PDU of P2P communication
  • To read/write NFC Type 4 tag

Getting Started

Using Arduino IDE

  1. Download zip file, extract it into Arduino's libraries and rename it to PN532-Arduino.

  2. Download Don's NDEF library, extract it into Arduino's libraries and rename it to NDEF.

  3. Add the NFC_INTERFACE_<interface> build flag to your build system or define it in your code using #define NFC_INTERFACE_<interface> like

    #define NFC_INTERFACE_I2C
  4. Follow the examples of the two libraries.

PlatformIO library

Add https://github.com/Seeed-Studio/PN532.git to your lib_deps variable in platformio.ini like so. This library will automatically include Don's NDEF library as well.

lib_deps =
    https://github.com/Seeed-Studio/PN532.git

⚠️ Besides using the correct PN532_<interface>.h include file, you have to add -DNFC_INTERFACE_<interface> to build_flags to select what interface you want to use. This is done to prevent requiring unnecessary dependencies on e.g. SoftwareSerial or SPI when you are not using those interfaces.

build_flags =
    -DNFC_INTERFACE_HSU

Git way for Linux/Mac (recommended)

  1. Get PN532 library and NDEF library

    cd {Arduino}\libraries
    git clone --recursive https://github.com/Seeed-Studio/PN532.git NFC
    git clone --recursive https://github.com/don/NDEF.git NDEF
    ln -s NFC/PN532 ./
    ln -s NDEF/NDEF ./
    
  2. Add the NFC_INTERFACE_<interface> build flag to your build system or define it in your code using #define NFC_INTERFACE_<interface> like

    #define NFC_INTERFACE_I2C
  3. Follow the examples of the two libraries

Interfaces

This library offers four ways to interface with the PN532 board:

  • HSU (High Speed Uart)
  • I2C
  • SPI
  • SWHSU (Software-based High Speed Uart)

Read the section for the interface you want to use.

Make sure to add the PN532_<interface>.h include file and the NFC_INTERFACE_<interface> define to your code like the example below:

#define NFC_INTERFACE_HSU

#include <PN532_HSU.h>
#include <PN532.h>

HSU Interface

HSU is short for High Speed Uart. HSU interface needs only 4 wires to connect PN532 with Arduino, Sensor Shield can make it more easier. For some Arduino boards like Leonardo, DUE, Mega ect, there are more than one Serial on these boards, so we can use this additional Serial to control PN532, HSU uses 115200 baud rate.

To use the Serial1 control PN532, refer to the code below.

#define NFC_INTERFACE_HSU

#include <PN532_HSU.h>
#include <PN532.h>

PN532_HSU pn532hsu(Serial1);
PN532 nfc(pn532hsu);

void setup(void)
{
	nfc.begin();
	//...
}

If your Arduino has only one serial interface and you want to keep it for control or debugging with the Serial Monitor, you can use the SoftwareSerial library to control the PN532 by emulating a serial interface. Include PN532_SWHSU.h instead of PN532_HSU.h:

#define NFC_INTERFACE_SWHSU

#include <SoftwareSerial.h>
#include <PN532_SWHSU.h>
#include <PN532.h>

SoftwareSerial SWSerial( 10, 11 ); // RX, TX

PN532_SWHSU pn532swhsu( SWSerial );
PN532 nfc( pn532swhsu );

void setup(void)
{
	nfc.begin();
	//...
}

Attribution

This library is based on Adafruit_NFCShield_I2C. Seeed Studio rewrite the library to make it easy to support different interfaces and platforms. @Don writes the NDEF library to make it more easy to use. @JiapengLi adds HSU interface. @awieser adds card emulation function.

About

NFC library using PN532 to read/write card and communicate with android

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C++ 99.2%
  • C 0.8%