Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mono0926/barcode_scan2
[reborned barcode_scan] A flutter plugin for reading 2D barcodes and QR codes.
https://github.com/mono0926/barcode_scan2
barcode barcode-reader barcode-scanner qrcode qrcode-reader qrcode-scanner reader scan scanner
Last synced: 4 days ago
JSON representation
[reborned barcode_scan] A flutter plugin for reading 2D barcodes and QR codes.
- Host: GitHub
- URL: https://github.com/mono0926/barcode_scan2
- Owner: mono0926
- License: mit
- Created: 2021-04-20T01:11:44.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-17T01:19:08.000Z (6 months ago)
- Last Synced: 2024-12-31T19:09:49.397Z (11 days ago)
- Topics: barcode, barcode-reader, barcode-scanner, qrcode, qrcode-reader, qrcode-scanner, reader, scan, scanner
- Language: Dart
- Homepage: https://pub.dev/packages/barcode_scan2
- Size: 401 KB
- Stars: 88
- Watchers: 7
- Forks: 79
- Open Issues: 51
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/mono0926/barcode_scan2/blob/master/LICENSE)
[](https://github.com/mono0926/barcode_scan2/stargazers)
[](https://pub.dartlang.org/packages/barcode_scan2)
[](https://github.com/mono0926/barcode_scan2/network)
## Reborned🎉
Original [barcode_scan](https://pub.dev/packages/barcode_scan) was discontinued, so [barcode_scan2](https://pub.dev/packages/barcode_scan2) was borned with sound null safety support🎉
# barcode_scan2
A flutter plugin for scanning 2D barcodes and QR codes.
This provides a simple wrapper for two commonly used iOS and Android libraries:
- iOS: https://github.com/mikebuss/MTBBarcodeScanner
- Android: https://github.com/dm77/barcodescanner
### Features
- [x] Scan 2D barcodes
- [x] Scan QR codes
- [x] Control the flash while scanning
- [x] Permission handling
## Getting Started
### Android
For Android, you must do the following before you can use the plugin:
* Add the camera permission to your AndroidManifest.xml
``
* This plugin is written in Kotlin. Therefore, you need to add Kotlin support to your project. See [installing the Kotlin plugin](https://kotlinlang.org/docs/tutorials/kotlin-android.html#installing-the-kotlin-plugin).
Edit your project-level build.gradle file to look like this:
```groovy
buildscript {
ext.kotlin_version = '1.3.61'
// ...
dependencies {
// ...
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
}
}
// ...
```
Edit your app-level build.gradle file to look like this:
```groovy
apply plugin: 'kotlin-android'
// ...
dependencies {
implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
// ...
}
```
Now you can depend on the barcode_scan plugin in your pubspec.yaml file:
```yaml
dependencies:
# ...
barcode_scan2: any
```
Click "Packages get" in Android Studio or run `flutter packages get` in your project folder.
### iOS
To use on iOS, you must add the the camera usage description to your Info.plist
```xml
NSCameraUsageDescription
Camera permission is required for barcode scanning.
```
## Usage
```dart
import 'package:barcode_scan2/barcode_scan2.dart';
void main() async {
var result = await BarcodeScanner.scan();
print(result.type); // The result type (barcode, cancelled, failed)
print(result.rawContent); // The barcode content
print(result.format); // The barcode format (as enum)
print(result.formatNote); // If a unknown format was scanned this field contains a note
}
```
## Advanced usage
You can pass options to the scan method:
```dart
import 'package:barcode_scan2/barcode_scan2.dart';
void main() async {
var options = ScanOptions(
// set the options
);
var result = await BarcodeScanner.scan(options: options);
// ...
}
```
### Supported options
| Option | Type | Description | Supported by |
|----------------------------|-------------------|-------------------------------------------------------------------------------------------|---------------|
| `strings.cancel` | `String` | The cancel button text on iOS | iOS only |
| `strings.flash_on` | `String` | The flash on button text | iOS + Android |
| `strings.flash_off` | `String` | The flash off button text | iOS + Android |
| `restrictFormat` | `BarcodeFormat[]` | Restrict the formats which are recognized | iOS + Android |
| `useCamera` | `int` | The index of the camera which is used for scanning (See `BarcodeScanner.numberOfCameras`) | iOS + Android |
| `autoEnableFlash` | `bool` | Enable the flash when start scanning | iOS + Android |
| `android.aspectTolerance` | `double` | Enable auto focus on Android | Android only |
| `android.useAutoFocus` | `bool` | Set aspect ratio tolerance level used in calculating the optimal Camera preview size | Android only |
## Development setup
### Setup protobuf
Mac:
```bash
$ brew install protobuf
$ brew install swift-protobuf
```
Windows / Linux: https://github.com/protocolbuffers/protobuf#protocol-compiler-installation
Activate the protobuf dart plugin:
```bash
$ flutter pub global activate protoc_plugin
```
Install the`Protobuf Support` plugin for IDEA / Android Studio or `vscode-proto3` for VS Code
If you changed the protos.proto you've to execute the ./generate_proto.sh to update the dart / swift sources
## Common problems
### Android "Could not find org.jetbrains.kotlin:kotlin-stdlib-jre..."
Change `org.jetbrains.kotlin:kotlin-stdlib-jre` to `org.jetbrains.kotlin:kotlin-stdlib-jdk`
([StackOverflow](https://stackoverflow.com/a/53358817))