flutter_native_location 0.2.2

Native location tracking for Flutter with configurable interval and accuracy filter.

flutter_native_location

A Flutter plugin for native GPS location tracking with configurable accuracy. Currently supports iOS only.

Features

• 📍 Continuous location tracking via CLLocationManager
• 🎯 Native precision — forwards all qualitative GPS fixes using Apple's hardware engine
• 🔋 Background location updates (screen-off tracking)
• 📡 Stream-based API — tracking starts on subscribe, stops on cancel
• 🛑 Native errors forwarded to Flutter as PlatformException

Installation

dependencies:
  flutter_native_location: ^0.2.0

iOS Setup

Add the following keys to ios/Runner/Info.plist:

<key>NSLocationWhenInUseUsageDescription</key>
<string>Required to track your location while the app is open.</string>

<key>NSLocationAlwaysAndWhenInUseUsageDescription</key>
<string>Required to track your location in the background.</string>

<key>UIBackgroundModes</key>
<array>
  <string>location</string>
</array>

Note: Location permission is requested automatically when the stream is first subscribed to.

Usage

1. Subscribe to the location stream

final sub = FlutterNativeLocation.getLocationStream(
  LocationConfig(
    accuracy: LocationAccuracy.high, // Set desired accuracy
    timeLimit: const Duration(seconds: 15), // Optional timeout
  ),
).listen(
  (Position pos) {
    print('${pos.latitude}, ${pos.longitude}');
    print('Speed: ${pos.speedKmh} km/h');
    print('Accuracy: ±${pos.accuracy} m');
  },
  onError: (error) {
    // PlatformException forwarded from native (e.g. permission denied)
    print('Location error: $error');
  },
);

2. Stop tracking

Cancel the subscription — tracking stops automatically when all subscribers cancel.

await sub.cancel();

3. One-shot location helpers

These work independently of the stream subscription.

// Last cached location (instant, no GPS fix needed)
final last = await FlutterNativeLocation.getLastLocation();

// Fresh location fix (may take a moment)
final current = await FlutterNativeLocation.getCurrentLocation();

4. Multiple subscribers

All subscribers share one native tracking session. Tracking starts when the first subscriber joins and stops when the last one cancels.

// Both receive the same location events from one native session
final subA = FlutterNativeLocation.getLocationStream(config).listen(...);
final subB = FlutterNativeLocation.getLocationStream(config).listen(...);

await subA.cancel(); // tracking continues (subB is still active)
await subB.cancel(); // tracking stops

Configuration

LocationConfig

Parameter	Type	Default	Description
accuracy	LocationAccuracy	high	Native iOS desiredAccuracy precision level
timeLimit	Duration?	null	Maximum time to wait between consecutive location updates before throwing a TimeoutException.

LocationAccuracy values

Value	iOS desiredAccuracy
best	kCLLocationAccuracyBest
high	kCLLocationAccuracyNearestTenMeters
medium	kCLLocationAccuracyHundredMeters
low	kCLLocationAccuracyKilometer
lowest	~3000 m

Position fields

Field	Type	Description
latitude	double?	Degrees
longitude	double?	Degrees
timestamp	DateTime?	Time of the fix
accuracy	double?	Horizontal accuracy in metres
altitude	double?	Metres above sea level
altitudeAccuracy	double?	Vertical accuracy in metres
heading	double?	Direction of travel (degrees, 0–360), -1 if invalid
headingAccuracy	double?	Heading accuracy in degrees
speed	double?	Speed in m/s, -1 if invalid
speedAccuracy	double?	Speed accuracy in m/s
speedKmh	double?	Speed in km/h (computed from speed), -1 if invalid

Background Tracking

This plugin uses CLLocationManager.startUpdatingLocation() with allowsBackgroundLocationUpdates = true and pausesLocationUpdatesAutomatically = false. This ensures location updates continue reliably when the screen is off — unlike async/await-based APIs (e.g. CLLocationUpdate.liveUpdates()) which can be throttled by iOS's cooperative thread scheduler after ~90 seconds in the background.

Required: UIBackgroundModes: location in Info.plist and location permission set to "Always" in device Settings.

Platform Support

Platform	Support
iOS	✅
Android	🔜 Planned