flutter_compass

A Flutter compass. The heading varies from 0-360, 0 being north.

Note: Android Only: null is returned as direction on android when no sensor available.

Usage

To use this plugin, add flutter_compass as a dependency in your pubspec.yaml file. For example:

dependencies:
                  flutter_compass: '^0.8.1'
                

iOS

Make sure to add keys with appropriate descriptions to the Info.plist file.

• NSLocationWhenInUseUsageDescription
• NSLocationAlwaysAndWhenInUseUsageDescription

:memo: Reference example code

Android

Make sure to add permissions to the app/src/main/AndroidManifest.xml file.

• android.permission.INTERNET
• android.permission.ACCESS_COARSE_LOCATION
• android.permission.ACCESS_FINE_LOCATION

:memo: Reference example code

Recommended support plugins

• Flutter Permission handler Plugin: Easy to request and check permissions in a cross-platform (iOS, Android) API.

:memo: Reference example code

0.8.1

• Bump the compileSdkVersion to 34 to support Android 14
• Support the AGP >= 8

0.8.0

• Add guard on web (Web always returns an empty stream)
• Heading accounts for orientation on iOS
• Unregister listeners when detaching engine on Android

0.7.0

• Updates Android Embedding
• Resolves deprecations warnings
• New Android Implementation supporting Sensor.TYPE_ROTATION_VECTOR and Sensor.TYPE_GEOMAGNETIC_ROTATION_VECTOR.
• Fixes multiple listeners on stream
• Fixes for null safety

0.6.1

• Flutter Compass no more depends on RxDart

0.6.0

• Migrate to null safety

0.5.1

Android:

• Remove roll from heading calculations
• Uses matrix reorientation to do a better job calculating heading "out the back of the phone" iOS:
• Use the device motion orientation matrix to compute heading out the back of the device. This is much like what is done on Android, and yields a more stable and precise heading. Dart:
• Add documentation to flutter_compass.dart.

0.5.0

Breaking Change: The events stream now gives you CompassEvent that consists of heading, headingForCamera and accuracy.

Android: Remove roll from heading calculations

0.4.3

Use geomagnetic rotation sensor as fallback on Android

0.4.2+1

Minor fix

0.4.2

Updated rxDart to 0.24.0

0.4.1

Updated README.md

0.4.0

Breaking change: Uses magnetic heading by default for iOS.

Older versions used True heading and which caused deviations.

0.3.7

• Sensor check added on android. null is returned as direction when no sensor available.

0.3.6

• Upgrade rxdart version to 0.23.1

0.3.5

• Improve README.md

0.3.4

• Add dispose method

0.3.3

• Update permission_handler to 3.2.2
• Update rxdart to 0.22.3

0.3.2

• Android: The plugin will now remember the last read azimuth. This will be done across Isolates using a static variable. Additionally, the value is cached within the isolate with the introduction of a RxDart BehaviorSubject. Reading the current azimuth using await FlutterCompass.events.first will therefore not hang anymore when th user has not moved the handset at all.
• Sample updated to cover the functional updates in Android.
• Added missing locatio permissions to the Android example which prevented the permission dialog from being shown.

0.3.1

• iOS: Remove permission request when Plugin is instantiated. Library users are responsible to request location permission by themselves.
• Request permission in the example directly.

0.3.0

• Replace kotlin code with simple java to reduce integration complexity

0.2.0

• Upgrade Android build components (Kotlin version) Breaking change. Migrate from the deprecated original Android Support Library to AndroidX. This shouldn't result in any functional changes, but it requires any Android apps using this plugin to also migrate if they're using the original support library.
• Upgrade iOS component to Swift 4.2

0.1.0

• Added example
• Added public api docs

0.0.3

• bug fixes

0.0.2

• Android emulator fix

0.0.1

• flutter compass plugin