NFC Shield acts as Arduino Shield via 1Sheeld

NFC library brings you the power of NFC tags to your projects, so now with a small tag you can control your home door locks without carrying keys anymore, or  you can also control lights or any other physical objects easily once you get your tags near the smartphone.New to NFC…! check this Link.

Adding #define CUSTOM_SETTINGS along with #define INCLUDE_NFC_SHIELD is a key that will let you unlock the NFC shield only amongst all shields and prevent 1Sheeld library from eating your memory specially for UNO board.

Note:

– NFC tags cannot be read while the smartphone is in the sleep\lock mode so make sure that your smartphone is awake to get data from tags.
– NFC shield supports only NFC data exchange format “NDEF” Tags.

Helper Classes:

1- NFCTag class:

Grabs basic info carried by the tag ex. ( tag ID, tag type, Number of records in tag, Max size of tag, Used size… etc ).

2- NFCRecord class:

– Queries data from records in tag and supports  three types of data (Record type category  ,Record raw Data , Record parsed data”RTD_URI & RTD_TEXT”).
– NFC tag may contain multiple records each record is a part of the NFC memory which holds certain type and data that represents itself.

NFCTag & getLastTag(void)

NFCTag &currentTag = NFC.getLastTag( );

bool isNewTagScanned(void)

bool newTagScanned = NFC.isNewTagScanned();
if(newTagScanned)
{/*do my code*/};

void finishedReading(void)

Note

/* Call finished reading once you finished dealing with the Tag. */
NFC.finishedReading();

void enableTagInterrupts(void)

Note

/* Enable Tags interrupts. */
NFC.enableTagInterrupts();

void disableTagInterrupts(void)

/* Disable tag interrupts if no more needed. */
NFC.disableTagInterrupts( );

void setOnNewTagScanned(void(*userFunction)(NFCTag &))

/* Subscribe to the new tag scanned event. */
NFC.setOnNewTagScanned(&tagFunction);
/* tagFunction exists under the loop function. */
/* A function to be called once a new tag is scanned. */
void tagFunction(NFCTag &myTag)
{
  /* Create and object of type NFCRecord. */
  NFCRecord &myRecordNumber0 = myTag.getRecord(0);
  /* Subscribe to record parsed data response event. */
  myTag.setOnRecordParsedDataResponse(&responseFunction);
  /*
  /* Check if there's a record with number 0 in Tag. */
  if (!myRecordNumber0.isNull())
  {
    /* Parse and query the data in the first record. */
    myRecordNumber0.queryParsedData();
  }
  else
  {
    /* Print out no record found. */
    Terminal.println("No Record found");
  }
}

void setOnError(void(*userFunction)(byte))

Literals

/* Subscribe to setOnError. */
NFC.setOnError(&errorFunction);
/* errorFunction exists under the loop function. */
/* This function will be invoked if an error occurred in reading NFC Tag. */
void errorFunction(byte errorNumber)
{
  /* Switch on error number. */
  switch (errorNumber)
  {
    case INDEX_OUT_OF_BOUNDS: Terminal.println("INDEX_OUT_OF_BOUNDS"); break;
    case RECORD_CAN_NOT_BE_PARSED: Terminal.println("RECORD_CAN_NOT_BE_PARSED"); break;
    case TAG_NOT_SUPPORTED: Terminal.println("TAG_NOT_SUPPORTED"); break;
    case NO_ENOUGH_BYTES: Terminal.println("NO_ENOUGH_BYTES"); break;
    case TAG_READING_ERROR: Terminal.println("TAG_READING_ERROR"); break;
    case RECORD_NOT_FOUND: Terminal.println("RECORD_NOT_FOUND"); break;
  }
}

NFCTag Class Functions:

bool isEmpty(void)

NFCTag &myTag = NFC.getLastTag();
/* Check first if Tag has records. */
if(!myTag.isEmpty())
{/* do my code*/}

byte * getId(void)

byte * tagId;
/* Check first if Tag has records. */
if(!myTag.isEmpty())
{
  tagId = myTag.getId();
}

byte getIdLength(void)

byte idlength = 0;
NFCTag &myTag = NFC.getLastTag();
/* Check first if Tag has records. */
if(!myTag.isEmpty())
{
   IdLegnth = myTag.getIdLength( ); 
}

byte getNumberOfRecords(void)

byte recordsNo = 0;
NFCTag &myTag = NFC.getLastTag();
/* Check first if Tag has records. */
if(!myTag.isEmpty())
{
   recordsNo= myTag.getNumberOfRecords();
}

NFCRecord & getRecord(int)

NFCTag &myTag = NFC.getLastTag();
/* Get Record number 0 in Tag.*/
NFCRecord &record0 = myTag.getRecord(0);

int getSize(void)

int usedSize = 0;
NFCTag &myTag = NFC.getLastTag();
/* Check first if Tag has records. */
if(!myTag.isEmpty())
{
   usedSize = myTag.getSize();
}

int getMaxSize(void)

int maxSize = 0;
NFCTag &myTag = NFC.getLastTag();
/* Check first if Tag has records. */
if(!myTag.isEmpty())
{
   maxSize = myTag.getMaxSize();
}

bool isNull(void)

NFCTag &myTag = NFC.getLastTag();
if(myTag.isNull)
{
   Terminal.println(“Tag has no size”);
}

void setOnRecordTypeResponse(void(*userFunction)(byte,byte [],byte))

Dependencies

/* Subscribe to onRecordTypeResponse event. */
myTag..setOnRecordTypeResponse(&recordTypeFunction);
/* Query type from application. */ 
myTag.getRecord(0).queryType( );
/*recordTypeFunction is invoked once application responds with type.*/
void recordTypeFunction(byte recordNumber , byte type[] , byte typeLength)
{
  Terminal.println(recordNumber);
  for (int i = 0 ; i < typeLength ; i++)
  {
    Terminal.write(type[i]);
  }
}

void setOnRecordParsedDataResponse(void (*userFunction)(byte , char[]))

Dependencies

/* Subscribe to OnRecordParsedData event. */
myTag..setOnRecordParsedDataResponse(&recordParsedFunction);
/* Query parsed data from the application. */
myTag.getRecord(0).queryParsedData( );
/* recordParsedFunction will be called once parsed data sent from application. */
void recordParsedFunction(byte recordNumber ,char data)
{
   Terminal.println(recordNumber);
   Terminal.write(data);
}

void setOnRecordDataResponse(void (userFunction)(byte ,byte [],byte ))

Dependencies

/* Subscribe to OnRecordDataResponse event. */
myTag..setOnRecordDataResponse(&recordDataFunction);
/* Query raw Data from the application. */
myTag.getRecord(0).queryData( );
/* recordDataFunction will be called once raw data is sent by application. */
void recordDataFunction(byte recordNumber , byte data[] , byte dataLength)
{
  Terminal.println(recordNumber);
  for (int i = 0 ; i < dataLength ; i++)
  {
    Terminal.write(data[i]);
  }

}

NFCRecord Class Functions:

byte getTypeCategory(void)

Categories “Literals”

NFCTag &myTag = NFC.getLastTag();
switch(myTag.getRecord(0).getTypeCategory())
{
  case TNF_UNKNOWN : Terminal.println("TNF_UNKNOWN");break;
  case TNF_EMPTY : Terminal.println("TNF_EMPTY");break;
  case TNF_EXTERNAL_TYPE : Terminal.println("TNF_EXTERNAL_TYPE");break;
  case TNF_MIME_MEDIA : Terminal.println("TNF_MIME_MEDIA");break;
  case TNF_UNCHANGED : Terminal.println("TNF_UNCHANGED");break;
  case TNF_ABSOLUTE_URI : Terminal.println("TNF_ABSOLUTE_URI");break;
  case RTD_TEXT : Terminal.println("RTD_TEXT");break;
  case RTD_URI : Terminal.println("RTD_URI");break;
  case RTD_UNSUPPORTED : Terminal.println("RTD_UNSUPPORTED");break;
}

int getTypeLength(void)

int recordTypeLength = 0;
NFCTag &myTag = NFC.getLastTag();
recordTypeLength = myTag.getRecord(0).getTypeLength()

int getDataLength(void)

int recordDataLength = 0;
NFCTag &myTag = NFC.getLastTag();
recordDataLength = myTag.getRecord(0).getDataLength()

void queryData(int,byte)

NFCRecord &myRecordNumber0 = myTag.getRecord(0);
/* Subscribe to record parsed data response event. */
myTag.setOnRecordDataResponse(&responseFunction);
/* Check if there's a record with number 0 in Tag. */
if(!myRecordNumber0.isNull())
{
  /* Parse and query the data in the first record. */
  myRecordNumber0.queryData();  
}

void queryType(int,byte)

NFCRecord &myRecordNumber0 = myTag.getRecord(0);
/* Subscribe to record parsed data response event. */
myTag.setOnRecordTypeDataResponse(&responseFunction);
/* Check if there's a record with number 0 in Tag. */
if(!myRecordNumber0.isNull())
{
  /* Parse and query the data in the first record. */
  myRecordNumber0.queryTypeData();  
}

void queryParsedData(void)

None.