weebi_barcode_scanner 1.4.0

Self-contained barcode scanner with real-time detection overlay. Features embedded YOLO detection, cross-platform support (Windows/macOS), point-of-sale optimizations, and OpenFoodFacts integration. N [...]

Weebi Barcode Scanner

A Flutter package for barcode and QR code scanning on Windows and macOS powered by YOLO object detection and ZXing decoding. Self-contained and ready for pub.dev publication.

Features

• Cross-Platform: Windows and macOS support
• AI-Powered Detection: YOLO model for accurate barcode localization
• Multiple Formats: QR codes, Code 128, EAN-13, and more
• Real-Time Processing: Live camera feed with detection overlay
• Point-of-Sale Ready: Optimized scanning modes for retail use
• OpenFoodFacts Integration: Automatic product information lookup
• Self-Contained: No external dependencies or manual asset copying

📦 Installation

Add this to your pubspec.yaml:

dependencies:
  # Camera permissions (automatically included)
  permission_handler: ^11.0.0

Then run:

flutter pub get

Quick Start

Basic Usage

import 'package:flutter/material.dart';
import 'package:weebi_barcode_scanner/weebi_barcode_scanner.dart';

class ScannerPage extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('Barcode Scanner')),
      body: BarcodeScannerWidget(
        onBarcodeDetected: (result) {
          print('Scanned: ${result.text}');
          print('Format: ${result.format}');
          
          // Show result dialog
          showDialog(
            context: context,
            builder: (context) => AlertDialog(
              title: Text('Barcode Detected'),
              content: Text('${result.format}: ${result.text}'),
              actions: [
                TextButton(
                  onPressed: () => Navigator.pop(context),
                  child: Text('OK'),
                ),
              ],
            ),
          );
        },
        onError: (error) {
          print('Scanner error: $error');
        },
      ),
    );
  }
}

Point-of-Sale Mode

BarcodeScannerWidget(
  config: ScannerConfig.pointOfSale(),  // Single scan, haptic feedback
  onBarcodeDetected: (result) {
    // Automatically stops scanning after first detection
    Navigator.pop(context, result);
  },
)

Continuous Scanning Mode

BarcodeScannerWidget(
  config: ScannerConfig.continuous(),  // Continuous scanning
  onBarcodeDetected: (result) {
    // Keeps scanning for multiple barcodes
    addToCart(result);
  },
)

🎯 Scanner Configurations

Pre-Built Configurations

// Point-of-sale: Single scan with haptic feedback
ScannerConfig.pointOfSale()

// Continuous: Multiple scans, no auto-stop
ScannerConfig.continuous()

Custom Configuration

ScannerConfig(
  // Detection frequency
  detectionInterval: Duration(milliseconds: 500),
  
  // AI model confidence threshold (0.0-1.0)
  confidenceThreshold: 0.6,
  
  // Image enhancement for damaged barcodes
  enableSuperResolution: true,
  
  // Auto-stop after first detection
  stopAfterFirstScan: true,
  
  // Haptic feedback on detection
  enableHapticFeedback: true,
)

📊 BarcodeResult

class BarcodeResult {
  final String text;                    // Decoded barcode text
  final String format;                  // Barcode format (QR_CODE, EAN_13, etc.)
  final String? productName;            // Product name (via OpenFoodFacts)
  final String? productBrand;           // Product brand
  final Map<String, dynamic>? location; // Barcode location in image
  final double? confidence;             // Detection confidence (0.0-1.0)
  
  bool get hasProductInfo => productName != null;
  bool get hasLocationInfo => location != null;
}

🖼️ Visual Detection Feedback

The package automatically displays:

• Detection Overlay: Shows barcode location even before decoding
• Confidence Indicators: Visual feedback on detection quality
• Real-Time Tracking: Bounding boxes follow detected barcodes
• Status Messages: Clear feedback on scanning progress

🏪 OpenFoodFacts Integration

Automatic product lookup for food barcodes:

BarcodeScannerWidget(
  onBarcodeDetected: (result) {
    if (result.hasProductInfo) {
      print('Product: ${result.productName}');
      print('Brand: ${result.productBrand}');
      // Additional product data available
    }
  },
)

To enable full product features, add credentials (optional):

# Copy template and add your credentials
cp open_prices_credentials.json.example open_prices_credentials.json
# Edit with your OpenFoodFacts account details

🎨 UI Customization

Split-Screen Layout

BarcodeScannerWidget(
  showProductInfo: true,  // Enables split-screen with product details
  onBarcodeDetected: (result) {
    // Product info automatically displayed on right side
  },
)

Custom Overlay

BarcodeScannerWidget(
  overlayBuilder: (context, detections) {
    return CustomPaint(
      painter: YourCustomOverlayPainter(detections),
    );
  },
)

🔧 Platform Setup

Windows

• Camera permissions handled automatically
• Native libraries included in package
• No additional setup required

Self-Contained Design

• Embedded AI Model: YOLO detection model included
• Native Libraries: Rust FFI libraries bundled
• No External Dependencies: Everything needed is included
• Cross-Platform: Single package works on Windows and macOS

Performance Optimizations

• Hardware Acceleration: GPU-accelerated inference where available
• Efficient Memory Usage: Optimized image processing pipeline
• Smart Caching: Model and image caching for better performance
• Background Processing: Non-blocking detection using isolates

🚨 Troubleshooting

Common Issues

1. Camera not working

   • Ensure camera permissions are granted
   • Check that camera is not in use by another app
   • Restart the app if camera appears frozen

2. Poor detection accuracy

   • Ensure good lighting conditions
   • Try adjusting confidenceThreshold (lower = more sensitive)
   • Enable enableSuperResolution for damaged barcodes

3. Performance issues

   • Increase detectionInterval (less frequent detection)
   • Disable enableSuperResolution if not needed

Debug Information

BarcodeScannerWidget(
  config: ScannerConfig(
    // Enable detailed logging
    enableDebugMode: true,
  ),
  onError: (error) {
    print('Detailed error: $error');
  },
)

📝 License

MIT License - see LICENSE file for details.