capacitor-plugin-nitgen-fingerprint

capacitor-plugin-nitgen-fingerprint

Capacitor 5 plugin for Nitgen fingerprint readers (Hamster DX and Hamster III).

ANDROID ONLY

Install

npm install capacitor-plugin-nitgen-fingerprint
npx cap sync

Update your app AndroidManifest.xml, into activity tag:

<intent-filter>
    <action android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED" />
</intent-filter>
<meta-data
    android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED"
    android:resource="@xml/device_filter_nitgen" />

API

• init(...)
• connect()
• disconnect()
• capture(...)
• match(...)
• addListener('onConnected', ...)
• addListener('onDisconnected', ...)
• Interfaces
• Type Aliases
• Enums

init(...)

init(options: InitOptions & CaptureOptions) => Promise<void>

Init the plugin with options

Param	Type
options	InitOptions & CaptureOptions

Since: 0.0.1

---

connect()

connect() => Promise<void>

Connect to fingerprint device

Since: 0.0.1

---

disconnect()

disconnect() => Promise<void>

Disconnect from fingerprint device

Since: 0.0.1

---

capture(...)

capture(options?: CaptureOptions | undefined) => Promise<CaptureResult>

Capture a fingerprint

Param	Type
options	CaptureOptions

Returns: Promise<CaptureResult>

Since: 0.0.1

---

match(...)

match(options: MatchOptions & CaptureOptions) => Promise<MatchResult>

Capture a fingerprint and match with a given text FIR

Param	Type
options	MatchOptions & CaptureOptions

Returns: Promise<MatchResult>

Since: 0.0.1

---

addListener('onConnected', ...)

addListener(eventName: 'onConnected', listenerFunc: OnConnectedListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for connected event

Param	Type
eventName	'onConnected'
listenerFunc	OnConnectedListener

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 0.0.1

---

addListener('onDisconnected', ...)

addListener(eventName: 'onDisconnected', listenerFunc: () => void) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for disconnected event

Param	Type
eventName	'onDisconnected'
listenerFunc	() => void

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 0.0.1

---

Interfaces

InitOptions

Prop	Type	Description	Default	Since
serial	string	Serial code		0.0.1
security	SecurityLevel	Security level	NORMAL	0.0.1

CaptureOptions

Prop	Type	Description	Default	Since
timeout	number	Capture timeout in milliseconds	10000	0.0.1
imageFormat	ImageFormat	Fingerprint image format	PNG	0.0.1
imageQuality	number	Fingerprint image quality (0-100) Only applied for JPEG	50	0.0.1

CaptureResult

Prop	Type	Description	Since
textFIR	string	Captured text FIR	0.0.1
image	string	base64 encoded fingerprint image	0.0.1

MatchResult

Prop	Type	Description	Since
isMatch	boolean	If captured fingerprint matched text FIR	0.0.1
textFIR	string	Captured text FIR	0.0.1
image	string	base64 encoded fingerprint image	0.0.1

MatchOptions

Prop	Type	Description	Since
textFIR	string	A stored text FIR to match with captured fingerprint	0.0.1

PluginListenerHandle

Prop	Type
remove	() => Promise<void>

OnConnectedListenerEvent

Prop	Type	Description	Since
openedDeviceID	number	Device ID	0.0.1

Type Aliases

ImageFormat

'PNG' | 'JPEG'

OnConnectedListener

(event: OnConnectedListenerEvent): void

Enums

SecurityLevel

Members	Value
LOWEST	1
LOWER	2
LOW	3
BELOW_NORMAL	4
NORMAL	5
ABOVE_NORMAL	6
HIGH	7
HIGHER	8
HIGHEST	9