Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alann-maulana/flutter_beacon
An hybrid iBeacon scanner and transmitter SDK for Flutter Android and iOS.
https://github.com/alann-maulana/flutter_beacon
beacon beacon-scanner beacon-transmitter flutter-beacon flutter-plugin
Last synced: 5 days ago
JSON representation
An hybrid iBeacon scanner and transmitter SDK for Flutter Android and iOS.
- Host: GitHub
- URL: https://github.com/alann-maulana/flutter_beacon
- Owner: alann-maulana
- License: apache-2.0
- Created: 2018-12-25T11:47:41.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-03T20:59:06.000Z (3 months ago)
- Last Synced: 2024-10-15T21:48:21.006Z (about 1 month ago)
- Topics: beacon, beacon-scanner, beacon-transmitter, flutter-beacon, flutter-plugin
- Language: Dart
- Homepage:
- Size: 6.14 MB
- Stars: 118
- Watchers: 9
- Forks: 148
- Open Issues: 60
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Flutter Beacon
[](https://pub.dartlang.org/packages/flutter_beacon) [](https://github.com/alann-maulana/flutter_beacon/blob/master/LICENSE) [](https://github.com/alann-maulana/flutter_beacon/actions?query=workflow%3A%22Flutter+CI%22) [](https://coveralls.io/github/alann-maulana/flutter_beacon?branch=master) [](https://app.fossa.com/projects/git%2Bgithub.com%2Falann-maulana%2Fflutter_beacon?ref=badge_shield) [](https://codecov.io/gh/alann-maulana/flutter_beacon)
[Flutter plugin](https://pub.dartlang.org/packages/flutter_beacon/) to work with iBeacons.
An hybrid iBeacon scanner and transmitter SDK for Flutter plugin. Supports Android API 18+ and iOS 8+.
Features:
* Automatic permission management
* Ranging iBeacons
* Monitoring iBeacons
* Transmit as iBeacon
## Installation
Add to pubspec.yaml:
```yaml
dependencies:
flutter_beacon: latest
```
### Setup specific for Android
For target SDK version 29+ (Android 10, 11) is necessary to add manually ```ACCESS_FINE_LOCATION```
```
```
and if you want also background scanning:
```
```
### Setup specific for iOS
In order to use beacons related features, apps are required to ask the location permission. It's a two step process:
1. Declare the permission the app requires in configuration files
2. Request the permission to the user when app is running (the plugin can handle this automatically)
The needed permissions in iOS is `when in use`.
For more details about what you can do with each permission, see:
https://developer.apple.com/documentation/corelocation/choosing_the_authorization_level_for_location_services
Permission must be declared in `ios/Runner/Info.plist`:
```xml
NSLocationWhenInUseUsageDescription
Reason why app needs location
NSLocationAlwaysAndWhenInUseUsageDescription
Reason why app needs location
NSLocationAlwaysUsageDescription
Reason why app needs location
NSBluetoothAlwaysUsageDescription
Reason why app needs bluetooth
```
## iOS Troubleshooting
* Example code works properly only on **physical device** (bluetooth on simulator is disabled)
* How to deploy flutter app on iOS device [Instruction](https://flutter.dev/docs/get-started/install/macos)
* If example code don't works on device (beacons not appear), please make sure that you have enabled
Location and Bluetooth (Settings -> Flutter Beacon)
## How-to
Ranging APIs are designed as reactive streams.
* The first subscription to the stream will start the ranging
### Initializing Library
```dart
try {
// if you want to manage manual checking about the required permissions
await flutterBeacon.initializeScanning;
// or if you want to include automatic checking permission
await flutterBeacon.initializeAndCheckScanning;
} on PlatformException catch(e) {
// library failed to initialize, check code and message
}
```
### Ranging beacons
```dart
final regions = [];
if (Platform.isIOS) {
// iOS platform, at least set identifier and proximityUUID for region scanning
regions.add(Region(
identifier: 'Apple Airlocate',
proximityUUID: 'E2C56DB5-DFFB-48D2-B060-D0F5A71096E0'));
} else {
// android platform, it can ranging out of beacon that filter all of Proximity UUID
regions.add(Region(identifier: 'com.beacon'));
}
// to start ranging beacons
_streamRanging = flutterBeacon.ranging(regions).listen((RangingResult result) {
// result contains a region and list of beacons found
// list can be empty if no matching beacons were found in range
});
// to stop ranging beacons
_streamRanging.cancel();
```
### Monitoring beacons
```dart
final regions = [];
if (Platform.isIOS) {
// iOS platform, at least set identifier and proximityUUID for region scanning
regions.add(Region(
identifier: 'Apple Airlocate',
proximityUUID: 'E2C56DB5-DFFB-48D2-B060-D0F5A71096E0'));
} else {
// Android platform, it can ranging out of beacon that filter all of Proximity UUID
regions.add(Region(identifier: 'com.beacon'));
}
// to start monitoring beacons
_streamMonitoring = flutterBeacon.monitoring(regions).listen((MonitoringResult result) {
// result contains a region, event type and event state
});
// to stop monitoring beacons
_streamMonitoring.cancel();
```
## Under the hood
* iOS uses native Framework [CoreLocation](https://developer.apple.com/documentation/corelocation/)
* Android uses the [Android-Beacon-Library](https://github.com/AltBeacon/android-beacon-library) ([Apache License 2.0](https://github.com/AltBeacon/android-beacon-library/blob/master/LICENSE))
# Author
Flutter Beacon plugin is developed by Eyro Labs. You can contact me at .