Scanflow Core Scan

Pub package

Scanflow Core Scan is the foundational Flutter plugin that provides the core platform layer for all Scanflow data capture modules (tyre, barcode, text, document, etc.). It exposes the native Android and iOS SDK base used for camera access, scanning infrastructure, and workflow automation.

This plugin enables Flutter apps to depend on a single core package; data capture features are added by depending on the specific Scanflow modules (e.g. scanflow_datacapture_tyre) which use this core.

Requirements

iOS Android
Supported minSdk >= 24

Example

Minimal usage: get the native platform version (used by modules under the hood).

import 'package:scanflow_core_scan/core.dart';

void useCore() async {
  var core = Core();
  var platformVersion = await core.getPlatformVersion();
  debugPrint('Platform version: $platformVersion');
}

For full scanning flows (tyre, barcode, text, etc.), use the corresponding Scanflow data capture packages that depend on this core.

Quick Start Guide

1. Get a license

Get your license key from Scanflow to use Scanflow data capture in your app.

2. Add the Scanflow Core plugin

Add this to your package's pubspec.yaml:

dependencies:
  scanflow_core_scan: ^2.1.0

Install it:

flutter pub get

3. Import the plugin

import 'package:scanflow_core_scan/core.dart';
import 'package:scanflow_core_scan/core_method_channel.dart';
import 'package:scanflow_core_scan/core_platform_interface.dart';

4. Use the core (or a data capture module)

  • Core only: Use Core() and call getPlatformVersion() as in the example above.
  • With a module: Add a Scanflow data capture package (e.g. scanflow_datacapture_tyre) to your pubspec.yaml. Those modules depend on scanflow_core_scan and provide the actual scanning UI and callbacks. See each module’s README for usage.

Installation (summary)

Depend on it

flutter pub add scanflow_core_scan

Or in pubspec.yaml:

dependencies:
  scanflow_core_scan: ^2.1.0

Import it

import 'package:scanflow_core_scan/core.dart';

Additional information

  • Homepage: https://www.scanflow.ai/
  • This package is intended to be used as a dependency of other Scanflow Flutter modules (tyre, barcode, text, etc.), not necessarily called directly in app code except for platform version or tests.

License

See the LICENSE file.