Why

When the MRZ information cannot be extracted from the image of the passport information page, the user can enter the information manually.

Acceptance Criteria

• Create a simple screen having the following 3 editable fields:
  • Passport number
  • Date of Birth
  • Date of Expiry
• Add a button below the fields with text Next.

Draft UI

Notes:

• No need to define any custom styles.
• Keep the app's default toolbar.

Why

Coroutines and Flow are popular ways to manage long running operations in Kotlin. We should support both of these methods when processing the MRZ

Acceptance Criteria

• [Optional] Create a new interface for Coroutines and Flow to separate it from regular function
• Add suspend function for processing an image file
• Add flowable function for processing an image file

Why

To allow the app developers to pass the models around different screens, we need to make them Parcelable.

Acceptance Criteria

• All the models must implement Parcelable.

Why

Coroutines and Flow are popular ways to manage long running operations in Kotlin. We should support both of these methods when reading the NFC chip

Acceptance Criteria

• [Optional] Create a new interface for Coroutines and Flow to separate it from regular function
• Add suspend function for reading an nfc tag
• Add flowable function for reading an nfc tag

Why

After the scanning of the MRZ information from the passport information page or manual input, the user navigates to this screen to press the back of the phone against the passport NFC chip to read the NFC data.

Acceptance Criteria

• Toolbar title: Read NFC
• Show an indefinite progress wheel while the NFC data is read and processed.
• Once processed, hide progress and show the following information:
  • Name
  • Surname
  • Personal Number → ID
  • Gender
  • Birth Date
  • Expiry Date
  • Serial Number Passport Number
  • Nationality
  • Document Type → Passport | ID Card | Other
  • Issue Authority
  • Signature image (not present in the design, but we can add it below all the labels)

No need to have the buttons shown in the design.

Design

Why

For the sample app, create UI for the camera screen to capture the passport information page containing the Machine Readable Zone (MRZ).

Acceptance Criteria

• The UI should match the design below.

Design

Note: don't show the question mark icon (?) on the top right.

Why

Users of the library should be able to add it as a Gradle dependency via JitPack.

Acceptance Criteria

• Configure Gradle.

References:

• https://vtsen.hashnode.dev/how-to-publish-android-library-on-jitpackio-with-github
• https://developer.android.com/studio/publish-library/upload-library

Why

Create a new project for the library.

Acceptance Criteria

• Create a project containing an empty activity in the :app module.
• Create an Android Library module - :lib.

Why

To navigate users to the camera screen to start scanning the MRZ or to the screen to manually enter the MRZ info, the main screen needs two buttons.

Acceptance Criteria

• Add two buttons in the middle of the screen with the following texts respectively:
  • Start scanning MRZ
  • Enter MRZ info manually

Why

After the scanning of the MRZ information from the passport information page or manual input, the user navigates to this screen to press the back of the phone against the passport NFC chip to read the NFC data.

Acceptance Criteria

• Toolbar title: Read NFC
• Show an indefinite progress wheel while the NFC data is read and processed.
• Once processed, hide progress and show the following information (will be dealt with in the Integrate ticket):
  • Name
  • Surname
  • Personal Number → ID
  • Gender
  • Birth Date
  • Expiry Date
  • Serial Number Passport Number
  • Nationality
  • Document Type → Passport | ID Card | Other
  • Issue Authority
  • Signature image (not present in the design, but we can add it below all the labels)

No need to have the buttons shown in the design.

Design

Why

When the MRZ information cannot be extracted from the image of the passport information page, the user can enter the information manually.

Acceptance Criteria

• Users can enter the following fields:
  • Passport number
  • Date of Birth
  • Date of Expiry
• Clicking Next will take users to the NFC scanning screen with the information entered in the aforementioned fields.

Why

To help the developers use the library, we need the description and setup instructions on README.

Acceptance Criteria

The README should contain the following contents:

• Description about the functionalities of the library.
• Setup instructions.

Why

Many apps that scan using the camera implement live tracking (For example, scanning PromptPay QR codes) rather than taking a photo and scanning after the fact

Acceptance Criteria

• Create a class to process camera input live
• update CameraCaptureActivity to use the new class

Useful resources

• https://codelabs.developers.google.com/codelabs/mlkit-android#0
• https://github.com/alimertozdemir/EPassportNFCReader/tree/master/app/src/main/java/com/alimert/passportreader/mlkit/camera

Why

Implement the camera screen created in #5 to capture the passport information page containing the Machine Readable Zone (MRZ).

Acceptance Criteria

• Capture the image.
• Process the image to get the MRZ.
• Display the MRZ information in a toast.
• Once the processing is successful, navigate to the NFC scanning screen with the MRZ information.
• If the processing fails, show a dialog with the following properties:
  • The message: Processing failed. Try again with the MRZ section of the passport clearly visible.
  • Buttons:
    • OK: pressing it will close the dialog.
    • Enter manually: pressing it will take the user to the manual MRZ input screen.

Why

Why

To navigate users to the camera screen to start scanning the MRZ or to the screen to manually enter the MRZ info, the main screen needs two buttons.

Acceptance Criteria

• Add a button in the middle of the screen with text Start scanning MRZ.
• Add a second button below the first one with text Enter MRZ info manually.
• Clicking the top button will ask runtime permission to use the camera.
• Allowing the permission will take users to the camera screen implemented in #5.
• Denying will keep users on the same screen.
• Clicking the bottom button will take users to the screen where they can manually enter the MRZ information (will be implemented in #11 ).

Why

There is some util code in the project written in Java. We should convert them to Kotlin for consistency.

Acceptance Criteria

• All the Java code should be converted to Kotlin.

Why

Add all the necessary components to the :lib module.

Acceptance Criteria

• Add the following dependencies:

"com.google.android.gms:play-services-mlkit-text-recognition:$latest_version",
"org.jmrtd:jmrtd:$latest_version",
"com.madgag.spongycastle:prov:$latest_version",
"edu.ucar:jj2000:$latest_version",
"com.github.mhshams:jnbis:$latest_version",
"net.sf.scuba:scuba-sc-android:$latest_version"

• Add the following classes/interfaces/models:
  • MlKitWrapper and its implementation
  • NfcReader and its implementation
  • ImageUtil
  • Models:
    • MrzInfo
    • AdditionalDocumentDetails
    • AdditionalPersonDetails
    • DocumentType
    • Passportinfo
    • PersonDetails