BioPass ID Fingerprint SDK Flutter #

Latest Version #

March 06, 2023 - [0.0.6]

Table of Contents #

• Quick Start Guide
  • Prerequisites
  • Installation
  • How to use
  • FingerCaptureListener
  • License
• Configs
• Changelog
• License

Quick Start Guide #

First, you will need a license key to use the SDK. You can acquire a license key when subscribing to a BioPass ID plan.

Check out our official documentation for more in depth information on BioPass ID.

1. Prerequisites: #

- A device with a camera
- License key
- Internet connection is required to verify the license

2. Installation #

First, add fingerprint_sdk_flutter as a dependency in your pubspec.yaml file.

Android #

Change the minimum Android sdk version to 21 (or higher) in your android/app/build.gradle file.

minSdkVersion 21

Change the compile Android sdk version to 31 (or higher) in your android/app/build.gradle file.

compileSdkVersion 31

IOS #

Requires iOS 12.0 or higher.

Add to the ios/Info.plist:

• the key Privacy - Camera Usage Description and a usage description.

If editing Info.plist as text, add:

<key>NSCameraUsageDescription</key>
<string>Your camera usage description</string>

Then go into your project's ios folder and run pod install.

# Go into ios folder
$ cd ios

# Install dependencies
$ pod install

3. How to use #

To call Fingerprint in your Flutter project is as easy as follow:

import 'package:flutter/material.dart';
import 'package:fingerprint_sdk_flutter/fingerprint_sdk_flutter.dart';
import 'dart:typed_data';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Fingerprint Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key}) : super(key: key);

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final config = FingerprintConfig(
    licenseKey: "your-license-key",
    captureType: FingerprintCaptureType.LEFT_HAND_FINGERS,
    outputType: FingerprintOutputType.CAPTURE_AND_SEGMENTATION,
    nFingersToCapture: 4,
    showStatusView: true,
    showDistanceIndicatorView: true,
    showFingersIndicatorView: true,
  );

  IFingerprintCaptureListener listener() => FingerprintCaptureListener(
        onFingerCapture: (List<Uint8List> images) async {},
        onCaptureCanceled: () async {},
        onStatusChanged: (FingerprintCaptureState state) async {},
        onFingerDetected: (List<Rect> displayFingerRects) async {},
        onClassificationChanged: (String classif) async {},
      );

  void openCamera() async {
    await Fingerprint.buildCameraView(
      config: config,
      listener: listener(),
    );
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Fingerprint Demo'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: openCamera,
          child: const Text('Capture Fingers'),
        ),
      ),
    );
  }
}

4. FingerCaptureListener #

You can set a custom listener to receive captured fingers as well as finger rectangles and monitor the current capture status and etc. You can write you own listener following this example:

IFingerprintCaptureListener listener() => FingerprintCaptureListener(
        onFingerCapture: (List<Uint8List> images) async {
          print("onFingerCapture: $images");
        },
        onCaptureCanceled: () async {
          print("onCaptureCanceled");
        },
        onStatusChanged: (FingerprintCaptureState state) async {
          print("onStatusChanged: $state");
        },
        onFingerDetected: (List<Rect> displayFingerRects) async {
          print("onFingerDetected: $displayFingerRects");
        },
        onClassificationChanged: (String classif) async {
          print("onClassificationChanged: $classif");
        },
      );

FingerprintCaptureState (enum) #

5. License #

To use Fingerprint you need a license key. To set the license key needed is simple as setting another attribute. Simply doing:

final config = FingerprintConfig(licenseKey: "your-license-key");

Configs #

FingerprintConfig #

FingerprintCaptureType (enum) #

FingerprintOutputType (enum) #

Changelog #

0.0.6 #

• Finger capture;
• Fingers segmentation;
• Parameterizable distance, status and fingers indicators.
• Documentation update;
• dlib bug fix;
• New licensing feature;
• Finger indicator fix.

License #

This project is proprietary software. See the LICENSE for more information.