NOMAD™ 30 SDK

Platform Guide for Android

hidglobal.com
Copyright
© 2020 HID Global Corporation/ASSA ABLOY AB. All rights reserved.
This document may not be reproduced, disseminated or republished in any form without the prior
written permission of HID Global Corporation.
20200805

Trademarks
HID GLOBAL, HID, the HID Brick Logo, the Chain Design, DigitalPersona, and NOMAD are the
trademarks or registered trademarks of HID Global Corporation, or its licensor’s, in the U.S. and other
countries. All other trademarks, service marks, and product or service names are trademarks or
registered trademarks of their respective owners.

Contact
For offices around the world, see www.hidglobal.com/contact/corporate-offices.

Customer Support
For general inquiries, you can contact Customer Support by email at cmcc@crossmatch.com.
Customer Support is also available by telephone Monday through Friday from 8 a.m. to 6 p.m.
Eastern Time (U.S. & Canada) using the following phone numbers:
Toll Free (United States): 1-866-276-7761
International: 1-561-622-9210
Fax: 1-561-622-8769
Be prepared to provide the following information when you contact Customer Support:
 Company name and contact person
 Product serial number
 Configuration information about your computer or device
 Error messages or related log files

Technical Support
You can request technical support by email or from the website.
To open a technical support case by email, send a message to customersupport@crossmatch.com
and include your company name, software version(s), and a description of the issue.
To open a technical support case from the website, complete the form at
http://www.hidglobal.com/crossmatch/support.
After submitting the email request or website form, you will receive an automated email reply that
references a case number. (Note that if you reply to the automated email, the correspondence will be
logged in your case record.)
After a request has been submitted, a technician will contact you to begin the troubleshooting
process.
Introduction ................................................................................................................................................................... 4

Installation ...................................................................................................................................................................... 4
System requirements ................................................................................................................................................... 4
Development system............................................................................................................................................................................ 4
Target system (Android device) ...................................................................................................................................................... 4
Installation steps ........................................................................................................................................................... 4
Installing on the development system........................................................................................................................................... 4
Installing on the target system ......................................................................................................................................................... 5

Java sample application ............................................................................................................................................ 6

Getting and selecting a reader .................................................................................................................................. 6
Getting reader capabilities ......................................................................................................................................... 8
Capturing fingerprints ................................................................................................................................................. 9
Streaming a fingerprint image ................................................................................................................................ 10
Enrolling fingerprints ................................................................................................................................................... 11
Verifying a fingerprint................................................................................................................................................. 12
Identifying a fingerprint ............................................................................................................................................. 13

Redistribution .............................................................................................................................................................. 13

NOMAD™ 30 SDK Platform Guide for Android 3

Introduction
This guide describes how to use the NOMAD™ 30 SDK to develop applications that will run on the
Android platform.

Installation
This section provides instructions on installing the NOMAD 30 SDK on the development and target
systems.

System requirements
Development system
The development system may be a Windows or Linux system. To develop Android applications, the
Android SDK must be installed on the development system. The recommended IDE is Android
Studio, version 3.0.1 or later.

Target system (Android device)

The operating system of the target device must be Android version 8.0 or later. A USB port in host
mode is required. You don't have to have root privileges on the Android device.
The NOMAD 30 SDK works on a variety of hardware and is intended to have a small footprint so that
it can run even on minimal hardware. Less capable hardware will work, but response time may not be
optimal.

Installation steps
The installation process is the same for all Android development, whether developing on a Linux or
Windows-based machine.
There are two steps to the installation:
• Installing on the development system
• Installing on the target system

Installing on the development system

Linux
To install the SDK on an Intel-based Linux development system:
1. Unpack the *.tar.gz.
2. Go to the folder with the unpacked contents.
3. Run setup.
4. Follow the onscreen instructions.
The installer copies all necessary files to the default or other specified folder. The files and folders
described in the table below are installed on the development machine beneath the main product
folder. The default folder is <root>/HID/nomad30sdk-android/android.

NOMAD™ 30 SDK Platform Guide for Android 4

Table 1. NOMAD 30 SDK folder contents

Folder Contents

bin/android-21 arm64-v8a
armeabi
x86
n30sdk.aar
n30sdk.jar

docs Java_API - Javadoc for Java API

EULA (End User License Agreement)
NOMAD 30 SDK Developer Guide (describes all APIs)
NOMAD 30 SDK Platform Guide for Android (describes Android-
specific details)
NOMAD 30 Pocket Reader User Guide

Samples/bin Java executable for sample application: N30SdkSample.apk

Samples/N30SdkSample Android Studio project files for the sample application

Windows
1. Run NOMAD 30 SDK for Android.msi
2. Follow the onscreen instructions.
The installer copies all necessary files to the default or other specified folder. The files and folders are
the same as those shown in Table 1 above and are installed on the development machine beneath the
main product folder.
Default folders:
64-bit - C:\Program Files (x86)\HID\Nomad 30 SDK\Android
32-bit - C:\ Program Files\HID\Nomad 30 SDK\Android

Installing on the target system

To install the run-time environment on the target hardware platform:

1. Enable USB debugging mode by navigating on your device’s display to Settings > Developer
Options > Enable USB debugging.
2. Connect the target hardware platform to the development system.
3. Establish an adb connection with the device. Then, install the APK. Example command:
adb install <SDK folder>/n30sdk-android/Android/Samples/bin/N30SdkSample.apk
Installing the .apk file will place the following components into a separate application zone:
• Driver and engine libraries
• Java SDK wrapper
• Java Sample Application
If you install any of these components elsewhere on the target, you will have duplicate files installed.
The intended architecture of Android is for all applications to have all dependencies secured within
their own application zones. All dependencies, UIs, and services are installed and started
automatically.

NOMAD™ 30 SDK Platform Guide for Android 5

Java sample application
The NOMAD 30 SDK for Android includes a sample application (Samples/bin/N30SdkSample.apk)
that demonstrates some of the features of the SDK when using the Java API.
The information in this section describes the following features included in the sample:
• Getting and selecting a reader (GET READER)
• Getting reader capabilities (GET CAPABILITIES)
• Capturing a fingerprint (CAPTURE)
• Live streaming a fingerprint image (STREAM IMAGE)
• Enrolling fingerprints (ENROLLMENT)
• Verifying a fingerprint (VERIFICATION)
• Identifying a fingerprint (IDENTIFICATION)

Before running the sample, connect a reader to the system.

Getting and selecting a reader

After you launch the sample application, the main screen is displayed:

GET READER identifies and returns the readers available to the program.

NOMAD™ 30 SDK Platform Guide for Android 6

After a reader in the list is selected successfully, the view returns to the main screen and all menu
items become available.

NOMAD™ 30 SDK Platform Guide for Android 7

Getting reader capabilities
GET CAPABILITIES returns information about the reader, similar to the following example.

Click on the Back button to return to the main screen.

NOMAD™ 30 SDK Platform Guide for Android 8

Capturing fingerprints
CAPTURE initiates fingerprint capture mode on the reader.
After a fingerprint is captured successfully, the image is then displayed in the app.

To exit capture mode, click on the Back button.

NOMAD™ 30 SDK Platform Guide for Android 9

Streaming a fingerprint image
STREAM IMAGE puts the reader into streaming mode, which streams activity on the sensor of the
reader back to the app in real time.
For example, when no finger is present on the sensor, a blank screen is streaming in the app.
Similarly, when a finger is placed on the sensor, an image of the print is streaming in the app.

To exit streaming mode, click on Back.

NOMAD™ 30 SDK Platform Guide for Android 10

Enrolling fingerprints
ENROLLMENT simulates an enrollment sequence.
After the first finger is successfully scanned, there are a series of prompts to scan additional fingers
until a sufficient number of high-quality scans are completed.

When the enrollment is complete, click Back to return to the main screen.

NOMAD™ 30 SDK Platform Guide for Android 11

Verifying a fingerprint
VERIFICATION is a 1-to-1 comparison where the app matches against a specified fingerprint.
The app prompts you to place any finger on the reader, which will create a fingerprint template to
match against. Next, you will be prompted to place either the same finger or a different finger on the
reader.

If you placed the same finger on the reader, a Match is returned. If you placed a different finger on
the reader, a No Match is returned.
To exit verification mode, click on the Back button.

NOMAD™ 30 SDK Platform Guide for Android 12

Identifying a fingerprint
IDENTIFICATION is a 1-to-many comparison where the app searches through a collection of enrolled
fingerprints to find a match.
The app prompts you to place various fingers on the reader (thumb, index, middle, and index) so
that it can create Fingerprint Minutiae Data (FMD).

After FMD is created, you will be prompted to place any finger on the reader to identify against the
FMD that was just created. If you place a previously enrolled finger on the reader, a match will be
indicated and the enrollment sequence will begin again.
To exit identification mode, click on the Back button.

Redistribution
You can redistribute the NOMAD 30 Pocket Reader User Guide included with the NOMAD 30 SDK
according to the terms of the End User License Agreement (see file locations in Table 1 on page 5).

NOMAD™ 30 SDK Platform Guide for Android 13