Capacitor-plugin-nitgen-fingerprint NPM

capacitor-plugin-nitgen-fingerprint

Capacitor 6 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(...)

init(options: InitOptions & CaptureOptions) => any

Init the plugin with options

Param	Type
`options`	InitOptions & CaptureOptions

Returns: any

Since: 0.0.1

connect()

connect() => any

Connect to fingerprint device

Returns: any

Since: 0.0.1

disconnect()

disconnect() => any

Disconnect from fingerprint device

Returns: any

Since: 0.0.1

capture(...)

capture(options?: CaptureOptions | undefined) => any

Capture a fingerprint

Param	Type
`options`	CaptureOptions

Returns: any

Since: 0.0.1

match(...)

match(options: MatchOptions & CaptureOptions) => any

Capture a fingerprint and match with a given text FIR

Param	Type
`options`	MatchOptions & CaptureOptions

Returns: any

Since: 0.0.1

addListener('onConnected', ...)

addListener(eventName: 'onConnected', listenerFunc: OnConnectedListener) => any

Listen for connected event

Param	Type
`eventName`	'onConnected'
`listenerFunc`	OnConnectedListener

Returns: any

Since: 0.0.1

addListener('onDisconnected', ...)

addListener(eventName: 'onDisconnected', listenerFunc: () => void) => any

Listen for disconnected event

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

Returns: any

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

MatchOptions

Prop	Type	Description	Since
`textFIR`	string	A stored text FIR to match with captured fingerprint	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