SMAATSDK. NFC MODULE ON ANDROID REQUIREMENTS AND DOCUMENTATION RELEASE v1.0

Size: px

Start display at page:

Download "SMAATSDK. NFC MODULE ON ANDROID REQUIREMENTS AND DOCUMENTATION RELEASE v1.0"

Nelson Brown
5 years ago
Views:

1 SMAATSDK NFC MODULE ON ANDROID REQUIREMENTS AND DOCUMENTATION RELEASE v1.0

2 NFC Module on Android Requirements and Documentation Table of contents Scope...3 Purpose...3 General operating diagram...3 Functions provided and parameters to use them...4 Functions necessary for data extraction...4 Functions necessary for reading the extracted data...5 Optional functions...6 Parameters to use...6 Usage example...9

3 Scope This document contains a detailed explanation of the functionalities and requirements of the NFC module. First, a general operating diagram is shown. Then, all the functions provided and their parameters are explained. Finally, a usage example is given. Purpose The purpose of this document is to explain the operation and requirements of the NFC Module in detail, and to facilitate its integration into new or already existing projects. General operating diagram Requests Solicitar NFC Post-Procesado reading Establishes connection with the chip Extracts data Returns control Saves data Application blocks Blocks encapsulated by the SDK NFC engine blocks 06/04/2018 3/14

4 Functions provided and parameters to use them Functions necessary for data extraction NfcInterface nfcinterface = new NfcInterface() *Add optional functions Functions for data extraction These functions are necessary for the module to function void nfcinterface.runid_nfc(activity activity, int requestcode, String documentid, String birthdate, String expirydate) void nfcinterface.runpassport_nfc(activity activity, int requestcode, String documentid, String birthdate, String expirydate) void nfcinterface.runbankcard_nfc(activity activity,int requestcode) ** Activity resultcode Create a new NfcInterface object. Starts the ID data extraction using NFC. ** Starts passport data extraction using NFC. ** Starts bank card data extraction using NFC. ** 0 Incorrect NFC access keys 1 NFC data correct extraction 2 Activity skiped 06/04/2018 4/14

5 Functions necessary for reading the extracted data Functions for reading the extracted data These functions are necessary for reading the extracted data JSONObject nfcinterface.getiddata() JSONObject nfcinterface.getpassportdata() JSONObject nfcinterface.getbankcarddata() Bitmap nfcinterface.getphoto() Returns data extracted from the ID. Within the set of data, a distinction is made between: name surname birthdate gender nationality documentnumber nationalid expirydate birthplace address Exceptions: JSONException Returns data extracted from the passport. Within the set of data, a distinction is made between: name surname birthdate gender nationality documentnumber nationalid expirydate Exceptions: JSONException Returns data extracted from the bank card. Within the set of data, a distinction is made between: PAN (Permanent Account Number) expirydate cardtype Returns a bitmap with the photo. Exceptions: Exception 06/04/2018 5/14

6 Optional functions void nfcinterface.setparameters(boolean photo) void nfcinterface.setwarningtimer(int timerwarning) Optional functions If you wish to extract the photo from the ID or passport, you must enable setparameters() before runid_nfc() or runpassport_nfc(). Enables a warning message if the connection could not be established between the device and the document chip. Allows timeout parametrisation that enables the message. void nfcinterface.setskiptimer(int timerskipnfc) Enables a warning message that a connection could not be established between the device and the document chip. The reading will not be carried out, and application control is returned. Allows timeout that omits the reading. Parameters to use Parameters to use Parameters to use in the above functions int requestcode String documentid String birthdate String expirydate boolean photo It is the requestcode for getting the result of the startactivityforresult(). This parameter contains the document number and is used to establish the connection with the chip. This parameter contains the date of birth in "yymmdd" format, and is used to establish the connection with the chip. This parameter contains the expiry date of the document and is used in "yymmdd" format. The documentid and birthdate parameters together form the access key to the chip. Enables the extraction of the photo from the ID. 06/04/2018 6/14

7 Access Keys to the JSON name surname birthdate gender nationality documentnumber nationalid expirydate birthplace address Allows the extraction of the FIRST NAME from the JSONObject that the getiddata() and getpassportdata() functions return. Allows the extraction of the SURNAMES from the JSONObject that the getiddata() and getpassportdata() functions return. Allows the extraction of the DATE OF BIRTH from the JSONObject that the getiddata() and getpassportdata() functions return. Allows the extraction of the SEX from the JSONObject that the getiddata() and getpassportdata() functions return. Permite la extracción de la NACIONALIDAD del JSONObject que retornan las funciones getiddata() y getpassportdata().allows the extraction of the NATIONALITY from the JSONObject that the getiddata() and getpassportdata() functions return. Allows the extraction of the DOCUMENT NUMBER from the JSONObject that the getiddata() and getpassportdata() functions return. Allows the extraction of the National Identification Number, if there is one, from the JSONObject that the getiddata() and getpassportdata() functions return. Allows the extraction of the EXPIRY DATE from the JSONObject that the getiddata(), getpassportdata() and getbankcarddata() functions return. Allows the extraction of the PLACE OF BIRTH from the JSONObject that the getiddata() function returns. Allows the extraction of the Address from the JSONObject that the getiddata() function returns. PAN Allows the extraction of the Permanent Account Number (PAN) from the JSONObject that the getiddata() function returns. 06/04/2018 7/14

8 cardtype Allows the extraction of the TYPE of bank card from the JSONObject that the getiddata() function returns. 06/04/2018 8/14

Usage example Once nfclibrary.aar AAR is installed, you can start to use the NFC module. Suppose that you want to create an application that extracts the data and the photo from the ID 3.

9 Usage example Once nfclibrary.aar AAR is installed, you can start to use the NFC module. Suppose that you want to create an application that extracts the data and the photo from the ID 3.0 and from the passport, in addition to the bank card data by using NFC. The following screen could be the main screen: In this example application there are three buttons, one for each document type. Once the data is extracted, the onactivityresult() function is used to display the results. In the case of the ID and the passport, the data will be displayed in a different activity, which is called DataResult in this case. For bank cards, due to the small amount of information that is extracted, it will be displayed in a text view in the same activity, Main, or in this case StartMenu. The code for this basic application example is shown below: 06/04/2018 9/14

10 01: 02: 03: 04: 05: 06: 07: 08: 09: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: package serimagmedia.capturaautomatica; import android.content.intent; import android.os.bundle; import android.support.v7.app.appcompatactivity; import android.util.log; import android.view.view; import android.widget.textview; import org.json.jsonexception; import org.json.jsonobject; import serimagmedia.nfclibrary.nfcinterface; public class StartMenu extends AppCompatActivity { NfcInterface nfcinterface = new NfcInterface(); TextView textview; private String doctype = protected void oncreate(bundle savedinstancestate) { super.oncreate(savedinstancestate); setcontentview(r.layout.activity_start_menu); textview = (TextView) findviewbyid(r.id.idtextview1); private void print(string text) { Log.d("MAIN", text); public void onclickid(view v){ nfcinterface.setwarningtimer(20); nfcinterface.setskiptimer(40); nfcinterface.setparameters(true); doctype = "ID"; nfcinterface.runid_nfc(this, 7001,"XXXXXXXXX", "YYMMDD", "YYMMDD"); 06/04/ /14

11 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: public void onclickpassport(view v){ nfcinterface.setwarningtimer(20); nfcinterface.setskiptimer(40); nfcinterface.setparameters(true); doctype = "PASSPORT"; nfcinterface.runpassport_nfc(this, 7003,"XXXXXXXX", "YYMMDD", "YYMMDD"); public void onclickbankcard(view v){ nfcinterface.setwarningtimer(20); nfcinterface.setskiptimer(40); nfcinterface.runbankcard_nfc(this, 7002); protected void onactivityresult(int requestcode, int resultcode, Intent intentdata){ if(requestcode == 7001){ if( nfcinterface.getbackbuttonpressed() == false){ if(resultcode == 1){ Intent intent = new Intent(this, DataResult.class); intent.putextra("doctype", doctype); startactivityforresult(intent, 1); else if(resultcode == 0){ print("keys INCORECTAS"); else if(resultcode == 2){ print("skip ACTIVITY"); 06/04/ /14

12 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: else if(requestcode == 7003) { if( nfcinterface.getbackbuttonpressed() == false){ if(resultcode == 1){ Intent intent = new Intent(this, DataResult.class); intent.putextra("doctype", doctype); startactivityforresult(intent, 1); else if(resultcode == 0){ print("keys INCORECTAS"); else if(resultcode == 2){ print("skip ACTIVITY"); else if(requestcode == 7002){ if(nfcinterface.getbackbuttonpressed() == false){ if(resultcode == 1){ JSONObject data = nfcinterface.getbankcarddata(); if(data!= null){ try { textview.settext("pan: " + data.getstring("pan") + "\n" + "Caducidad: "+ data.getstring("expirydate") + "\n" + "Tipo de tarjeta: " + data.getstring("cardtype")); catch (JSONException e) { e.printstacktrace(); else if(resultcode == 2){ print("skip ACTIVITY"); 06/04/ /14

13 01: 02: 03: 04: 05: 06: 07: 08: 09: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: package serimagmedia.capturaautomatica; import android.support.v7.app.appcompatactivity; import android.os.bundle; import android.view.windowmanager; import android.widget.imageview; import android.widget.textview; import org.json.jsonexception; import org.json.jsonobject; import serimagmedia.nfclibrary.nfcinterface; public class DataResult extends AppCompatActivity { NfcInterface nfcinterface = new NfcInterface(); private TextView textview; private ImageView imageview; private String doc = protected void oncreate(bundle savedinstancestate) { super.oncreate(savedinstancestate); setcontentview(r.layout.activity_data_result); //Remove notification bar this.getwindow().setflags(windowmanager.layoutparams. FLAG_FULLSCREEN, WindowManager.LayoutParams.FLAG_FULLSCREEN); textview = (TextView)findViewById(R.id.passData); imageview = (ImageView)findViewById(R.id.passportPhoto); doc = getintent().getextras().getstring("doctype"); 06/04/ /14

14 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: if(doc.equals("passport")){ JSONObject passportdata = nfcinterface.getpassportdata(); if(passportdata!= null) { try { textview.settext("name: " + passportdata.get("name") + "\n" + "Surname: " + passportdata.get("surname") + "\n" + "Birth Date: " + passportdata.get("birthdate") + "\n" + "Gender: " + passportdata.get("gender") + "\n" + "Nationality: " + passportdata.get("nationality") + "\n" + "Document Number: " + passportdata.get("documentnumber") +"\n"+ "ID Number: " + passportdata.get("nationalid") + "\n" + "Expiry Date: " + passportdata.get("expirydate") + "\n"); catch (JSONException e) { e.printstacktrace(); else if(doc.equals("id")){ JSONObject iddata = nfcinterface.getiddata(); if(iddata!= null) { try { textview.settext("name: " + iddata.get("name") + "\n" + "Surname: " + iddata.get("surname") + "\n" + "Birth Date: " + iddata.get("birthdate") + "\n" + "Gender: " + iddata.get("gender") + "\n" + "Nationality: " + iddata.get("nationality") + "\n" + "Document Number: " + iddata.get("documentnumber") + "\n" + "ID Number: " + iddata.get("nationalid") + "\n" + "Expiry Date: " + iddata.get("expirydate") + "\n" + "Birth Place: " + iddata.getstring("birthplace") + "\n"+ "Address: " + iddata.getstring("address")); catch (JSONException e) { e.printstacktrace(); if(nfcinterface.getphoto()!= null){ imageview.setimagebitmap(nfcinterface.getphoto()); 06/04/ /14

Appendix A : Android Studio Code For Android

Appendix A : Android Studio Code For Android Monitoring : ` public Pubnub pubnub; public static final String PUBLISH_KEY = "pub-c-798bd0f6-540b-48af-9e98-7d0028a5132a"; public static final String SUBSCRIBE_KEY