README.md

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

📝 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

📝 Reference example code

Recommended support plugins

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

📝 Reference example code