AIO Scanner #

A powerful cross-platform document and barcode scanning package for Flutter that leverages native scanning capabilities:

• iOS: Uses Apple's VisionKit for document and barcode scanning
• Android: Uses Google's ML Kit for document and barcode scanning

Features #

• 📝 Document Scanning: Automatic edge detection and perspective correction
• 🔍 Barcode Scanning: Real-time detection of QR codes, Code 128, EAN, UPC, and more
• 📱 Cross-platform Support: Works seamlessly on iOS and Android
• 🔄 Auto-confirmation: Automatically confirms detected barcodes for a seamless experience
• 💡 Flash Control: Integrated flash/torch control with clean UI
• 🔍 Text Recognition (OCR): Extract text from scanned documents
• 📐 Image Enhancement: Automatic lighting and color correction
• 📚 Multi-page Support: Scan multiple pages in one session
• 📷 Gallery Import: Import existing images for processing
• 📄 PDF Support: Generate PDFs from scanned documents with single or multi-page options
• 🎨 Customizable UI: Tailor the scanning experience
• ⚡ High Performance: Utilizes native capabilities for optimal results

Demo #

iOS #

https://github.com/user-attachments/assets/dee1c729-fbf7-43d1-870b-e31346d69acc

Android #

https://github.com/user-attachments/assets/fb36e9d8-b9c6-47d4-adf2-2d5797fb6380

Requirements #

• Flutter SDK: ^3.7.2
• iOS: 13.0 or higher (for VisionKit support), iOS 16.0+ for barcode scanning
• Android: API level 21 or higher (for ML Kit support)
• Xcode: 14.0 or higher (for iOS development)
• Android Studio: Latest version (for Android development)

Installation #

Add this to your pubspec.yaml:

dependencies:
  aio_scanner: ^1.0.3

iOS Setup #

Add the following keys to your ios/Runner/Info.plist file:

<key>NSCameraUsageDescription</key>
<string>This app needs camera access to scan documents and barcodes</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>This app needs photos access to save scanned documents</string>

Android Setup #

Add the following permissions to your android/app/src/main/AndroidManifest.xml file:

<uses-permission android:name="android.permission.CAMERA" />
<uses-feature android:name="android.hardware.camera" />

For Android 13+ (API level 33+), add:

<uses-permission android:name="android.permission.READ_MEDIA_IMAGES" />

For Android 12 and below, add:

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

Add ML Kit dependencies to your Android app:

<application ...>
    <!-- ML Kit barcode model dependency -->
    <meta-data
        android:name="com.google.mlkit.vision.DEPENDENCIES"
        android:value="barcode" />
</application>

Usage #

Document Scanning #

import 'package:aio_scanner/aio_scanner.dart';

Future<void> scanDocument() async {
  try {
    // Check if document scanning is supported
    if (!await AioScanner.isDocumentScanningSupported()) {
      print('Document scanning is not supported on this device');
      return;
    }

    // Start document scanning
    ScanResult? result = await AioScanner.startDocumentScanning(
      maxNumPages: 5,
      initialMessage: 'Position document in frame',
      scanningMessage: 'Hold still...',
      allowGalleryImport: true,
      outputFormat: ScanOutputFormat.pdf, // or ScanOutputFormat.image
      mergePDF: true, // merge all pages into a single PDF
    );

    if (result != null && result.isSuccessful) {
      // Access scanned files (images or PDFs)
      final scannedFiles = result.scannedFiles;

      // Access extracted text
      final extractedText = result.extractedText;

      // Process the results as needed
      print('Scanned ${scannedFiles.length} files');
      print('Extracted text: $extractedText');
    }
  } catch (e) {
    print('Error scanning document: $e');
  }
}

Barcode Scanning #

import 'package:aio_scanner/aio_scanner.dart';

Future<void> scanBarcode() async {
  try {
    // Check if barcode scanning is supported
    if (!await AioScanner.isBarcodeScanningSupported()) {
      print('Barcode scanning is not supported on this device');
      return;
    }

    // Start barcode scanning
    BarcodeScanResult? result = await AioScanner.startBarcodeScanning(
      recognizedFormats: ['qr', 'code128', 'ean13'],  // Empty list scans all formats
      scanningMessage: 'Point camera at a barcode',
    );

    if (result != null && result.isSuccessful) {
      // Access barcode values
      for (int i = 0; i < result.barcodeValues.length; i++) {
        print('Barcode value: ${result.barcodeValues[i]}');
        print('Format: ${result.barcodeFormats[i]}');
      }
    }
  } catch (e) {
    print('Error scanning barcode: $e');
  }
}

Requesting Permissions #

Before scanning, ensure you have the necessary permissions:

import 'dart:io';
import 'package:permission_handler/permission_handler.dart';
import 'package:device_info_plus/device_info_plus.dart';

Future<void> requestScannerPermissions() async {
  if (Platform.isAndroid) {
    // Get Android SDK version using device_info_plus
    final deviceInfo = DeviceInfoPlugin();
    final androidInfo = await deviceInfo.androidInfo;
    final sdkVersion = androidInfo.version.sdkInt;

    final bool isAndroid13OrHigher = sdkVersion >= 33; // SDK 33 = Android 13
    final bool isAndroid10OrHigher = sdkVersion >= 29; // SDK 29 = Android 10

    // Determine which permissions to request based on Android version
    final permissionsToRequest = <Permission>[
      Permission.camera,
      if (isAndroid13OrHigher)
        // Android 13+ uses more granular storage permissions
        Permission.photos
      else if (isAndroid10OrHigher)
        // Android 10-12 uses general storage permission but with scoped storage
        Permission.storage
      else
        // Android < 10 uses general storage permission
        Permission.storage,
    ];

    // Request all required permissions
    final statuses = await permissionsToRequest.request();

    // Check if any permission was denied
    if (statuses.values.any((status) => status.isDenied || status.isPermanentlyDenied)) {
      // Handle denied permissions
      print('Required permissions were denied');
      return false;
    }
    return true;
  }

  // iOS permissions are requested automatically when using the scanner
  return true;
}

Complete Example #

Check out the example directory for a full working example that demonstrates both document and barcode scanning features.

Configuration Options #

The AIO Scanner plugin provides several configuration options:

Document Scanning Options #

Barcode Scanning Options #

Supported Barcode Formats

Scan Results #

Document Scan Result #

The ScanResult object provides access to the document scanning results:

Barcode Scan Result #

The BarcodeScanResult object provides access to the barcode scanning results:

Platform-specific Implementation Details #

iOS Implementation #

• Document Scanning: Uses Apple's VisionKit VNDocumentCameraViewController for document scanning.
• Barcode Scanning: Uses VisionKit's DataScannerViewController for barcode scanning (iOS 16.0+).
• Text Recognition: Uses the Vision framework for OCR.
• PDF Generation: Uses PDFKit for PDF creation and manipulation.

Android Implementation #

• Document Scanning: Uses Google's ML Kit Document Scanner API for document scanning.
• Barcode Scanning: Uses ML Kit's Barcode Scanning API for barcode detection.
• Text Recognition: Uses ML Kit Text Recognition API for OCR.
• PDF Generation: Uses Android's PDF generation capabilities.

Troubleshooting #

iOS Issues #

1. Scanner not working on simulator: The document scanner requires a physical device with a camera.
2. Permission errors: Ensure you've added the necessary privacy descriptions in Info.plist.
3. PDF generation issues: Make sure you have sufficient storage space and permissions.

Android Issues #

1. ML Kit initialization failure: Make sure Google Play Services are up to date on the device.
2. Permission issues: For Android 13+, ensure you're requesting the correct granular permissions (READ_MEDIA_IMAGES instead of storage).
3. PDF generation issues: Check storage permissions and available space.

License #

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing #

Contributions are welcome! If you find a bug or want to add a feature, please open an issue or submit a pull request.