🚀 Migration Guide: Flat Config → Compound Config

Version: 5.0.0
Applies to: flutter_background_geolocation v5.0.0 and above

📢 Overview

Version 5 introduces a new Compound Config format that replaces the legacy "flat" config structure. This guide explains the migration steps, provides before/after examples, and details key differences.

🔑 New License Key Format

Overview

Version 9 uses a new JWT-based license key format. Your existing (legacy) license keys will not work with v9.

Important

Previous versions of the SDK did not require a license key on iOS. v9 requires a license key on both iOS and Android. See iOS Setup and Android Setup for license key configuration details.

Note

Add-on products (eg: polygon-geofencing, firebase) are now encoded as entitlements inside the JWT key itself. You no longer need separate license keys for add-on products.

Getting Your New License Key

Log in to the Transistor Software Customer Dashboard.
Navigate to your product purchase.
You will find two license tabs:
- Legacy — your old license key (for flutter-background-geolocation v4 and below)
- New — your new JWT license key (required for flutter-background-geolocation v5+)
Copy the key from the "New" tab.

Applying Your License Key

[iOS] Add your JWT license key to your Info.plist under the key TSLocationManagerLicense. See iOS Setup for full details:

📂 ios/App/App/Info.plist

<key>TSLocationManagerLicense</key>
<string>YOUR_JWT_LICENSE_KEY</string>

[Android] Add your JWT license key to AndroidManifest.xml. See Android Setup for full details:

📂 android/app/src/main/AndroidManifest.xml

<manifest>
    <application>
        <meta-data android:name="com.transistorsoft.locationmanager.license" android:value="YOUR_JWT_LICENSE_KEY" />
    </application>
</manifest>

Warning

If you previously configured a separate license key for polygon-geofencing, firebase, or any other add-on product, remove it. Add-on entitlements are now bundled into your single bgGeo JWT license key.

⚙️ Compatibility

The legacy flat config style remains fully supported for backward compatibility.
You can continue using your existing flat configuration if you prefer, though new features may only appear in the compound structure.

Note: v5 also enables a new on-device LocationFilter by default (see Breaking Changes below) which can change onLocation behavior even if your previous config is unchanged.

⏩ Why Compound Config?

Clarity: Groups related settings together (e.g., geolocation, HTTP, logging).
Extensibility: Easier to add new config domains without polluting the top-level.
Consistency: Aligns with native SDKs and improves code completion.

🏗️ Old vs. New Config Structure

Before (Flat Config)

BackgroundGeolocation.ready(Config(
  desiredAccuracy: Config.DESIRED_ACCURACY_HIGH,
  distanceFilter: 50,
  stopOnTerminate: false,
  startOnBoot: true,
  url: "https://my.server.com/locations",
  headers: { "Authorization": "Bearer TOKEN" },
  logLevel: Config.LOG_LEVEL_VERBOSE,
  debug: true,
));

After (Compound Config)

BackgroundGeolocation.ready(Config(
  geolocation: GeoConfig(
    desiredAccuracy: DesiredAccuracy.high,
    distanceFilter: 50,
  ),
  app: AppConfig(
    stopOnTerminate: false,
    startOnBoot: true,
  ),
  http: HttpConfig(
    url: "https://my.server.com/locations",
    headers: { "Authorization": "Bearer TOKEN" },
  ),
  logger: LoggerConfig(
    logLevel: LogLevel.verbose,
    debug: true,
  ),
));

🗺️ Mapping Table: Flat → Compound

Flat Key	Compound Group	Compound Property	Example
`desiredAccuracy`	`geolocation`	`desiredAccuracy`	`geolocation: GeoConfig(desiredAccuracy: ...)`
`distanceFilter`	`geolocation`	`distanceFilter`
`stopOnTerminate`	`app`	`stopOnTerminate`	`app: AppConfig(stopOnTerminate: ...)`
`startOnBoot`	`app`	`startOnBoot`
`url`	`http`	`url`	`http: HttpConfig(url: ...)`
`headers`	`http`	`headers`
`logLevel`	`logger`	`logLevel`	`logger: LoggerConfig(logLevel: ...)`
`debug`	`logger`	`debug`
...	...	...

See the full mapping table below for all properties.

🧑‍💻 Migration Steps

Update your dependency:
Ensure you are using flutter_background_geolocation v5.0.0 or later.
[Android] remove custom maven url from android/build.gradle. These are no longer required:

📂 android/build.gradle

    repositories {
        google()
        mavenCentral()
-       maven { url 'https://developer.huawei.com/repo/' }
-       // [required] background_geolocation
-       maven(url = "${project(":flutter_background_geolocation").projectDir}/libs")
-       // [required] background_fetch
-       maven(url = "${project(":background_fetch").projectDir}/libs")
    }
}

Group related options:
- Move geolocation-related keys into GeoConfig
- Move HTTP-related keys into HttpConfig
- Move logging/debug keys into LoggerConfig
- Move app lifecycle keys into AppConfig
- Move activity-recognition keys into ActivityConfig
- Move persistence keys into PersistenceConfig
Replace flat keys:
- Instead of passing all options to Config(...) directly, pass the relevant compound config objects.
- Remove any duplicate or conflicting flat keys.
Check for breaking changes:
- Some keys may have been renamed, moved, or refactored.
- See Breaking Changes below.

📝 Example Migration

Flat Config (Old)

BackgroundGeolocation.ready(Config(
  desiredAccuracy: Config.DESIRED_ACCURACY_HIGH,
  distanceFilter: 10,
  stopOnTerminate: false,
  startOnBoot: true,
  url: "https://my.server.com/locations",
  headers: { "Authorization": "Bearer TOKEN" },
  logLevel: Config.LOG_LEVEL_DEBUG,
  debug: true,
  autoSync: true,
  batchSync: false,
));

Compound Config (New)

BackgroundGeolocation.ready(Config(
  geolocation: GeoConfig(
    desiredAccuracy: DesiredAccuracy.high,
    distanceFilter: 10,
  ),
  app: AppConfig(
    stopOnTerminate: false,
    startOnBoot: true,
  ),
  http: HttpConfig(
    url: "https://my.server.com/locations",
    headers: { "Authorization": "Bearer TOKEN" },
    autoSync: true,
    batchSync: false,
  ),
  logger: LoggerConfig(
    logLevel: LogLevel.debug,
    debug: true,
  ),
));

🧩 Compound Config Groups

Group	Class Name	Description
`geolocation`	`GeoConfig`	Location and geofencing options
`app`	`AppConfig`	App lifecycle and scheduling
`http`	`HttpConfig`	HTTP sync, batching, headers, etc.
`logger`	`LoggerConfig`	Debug, log-level, log retention
`activity`	`ActivityConfig`	Activity recognition, stop detection
`persistence`	`PersistenceConfig`	Data storage, max days, max records

Each group is a separate Dart class. See API docs for details.

🛠️ Full Mapping Table

Flat Key	Compound Group	Compound Property	Notes
`desiredAccuracy`	`geolocation`	`desiredAccuracy`
`distanceFilter`	`geolocation`	`distanceFilter`
`stationaryRadius`	`geolocation`	`stationaryRadius`
`stopTimeout`	`geolocation`	`stopTimeout`
`stopAfterElapsedMinutes`	`geolocation`	`stopAfterElapsedMinutes`
`geofenceProximityRadius`	`geolocation`	`geofenceProximityRadius`
`geofenceInitialTriggerEntry`	`geolocation`	`geofenceInitialTriggerEntry`
`geofenceModeHighAccuracy`	`geolocation`	`geofenceModeHighAccuracy`
`pausesLocationUpdatesAutomatically`	`geolocation`	`pausesLocationUpdatesAutomatically`
`showsBackgroundLocationIndicator`	`geolocation`	`showsBackgroundLocationIndicator`
`activityType`	`geolocation`	`activityType`	iOS only
`locationAuthorizationAlert`	`geolocation`	`locationAuthorizationAlert`	iOS only
`maxMonitoredGeofences`	`geolocation`	`maxMonitoredGeofences`
`filter`	`geolocation`	`filter`	Advanced filtering
`stopOnTerminate`	`app`	`stopOnTerminate`
`startOnBoot`	`app`	`startOnBoot`
`enableHeadless`	`app`	`enableHeadless`	Android only
`heartbeatInterval`	`app`	`heartbeatInterval`
`schedule`	`app`	`schedule`
`scheduleUseAlarmManager`	`app`	`scheduleUseAlarmManager`	Android only
`notification`	`app`	`notification`	Android only
`backgroundPermissionRationale`	`app`	`backgroundPermissionRationale`	Android only
`preventSuspend`	`app`	`preventSuspend`	iOS only
`url`	`http`	`url`
`autoSync`	`http`	`autoSync`
`autoSyncThreshold`	`http`	`autoSyncThreshold`
`disableAutoSyncOnCellular`	`http`	`disableAutoSyncOnCellular`
`batchSync`	`http`	`batchSync`
`maxBatchSize`	`http`	`maxBatchSize`
`method`	`http`	`method`
`params`	`http`	`params`
`headers`	`http`	`headers`
`rootProperty`/`httpRootProperty`	`http`	`rootProperty`
`timeout`/`httpTimeout`	`http`	`timeout`
`debug`	`logger`	`debug`
`logLevel`	`logger`	`logLevel`	Now an enum: `LogLevel`
`logMaxDays`	`logger`	`logMaxDays`
`activityRecognitionInterval`	`activity`	`activityRecognitionInterval`	Android only
`minimumActivityRecognitionConfidence`	`activity`	`minimumActivityRecognitionConfidence`	Android only
`disableStopDetection`	`activity`	`disableStopDetection`
`stopOnStationary`	`activity`	`stopOnStationary`
`motionTriggerDelay`	`activity`	`motionTriggerDelay`	Android only
`triggerActivities`	`activity`	`triggerActivities`	Android only
`disableMotionActivityUpdates`	`activity`	`disableMotionActivityUpdates`	iOS only
`stopDetectionDelay`	`activity`	`stopDetectionDelay`	iOS only
`persistMode`	`persistence`	`persistMode`
`maxDaysToPersist`	`persistence`	`maxDaysToPersist`
`maxRecordsToPersist`	`persistence`	`maxRecordsToPersist`
`locationsOrderDirection`	`persistence`	`locationsOrderDirection`

Not all legacy keys are shown above. See API docs for full details.

⚠️ Breaking Changes

LocationFilter enabled by default (behavior change in `onLocation`)

v5 introduces an on-device LocationFilter (compound config: geolocation.filter). This filter is enabled by default and can change which locations are delivered to onLocation and how distance deltas are smoothed/adjusted.

Default behavior (if you do not configure geolocation.filter):

geolocation.filter.useKalman: true
geolocation.filter.policy: Conservative
geolocation.filter.trackingAccuracyThreshold: 100 (meters)
geolocation.filter.odometerAccuracyThreshold: 20 (meters)

If your app uses Low / Medium desired accuracy (or operates in poor GPS conditions), the default thresholds/policy can reject many locations (eg: low-accuracy samples) and the reported Location stream may differ significantly from v4.

Preserve v4 behavior (PassThrough / “passthrough mode”)

To keep the original v4 behavior (deliver locations without the new pre-filter), configure PassThrough:

BackgroundGeolocation.ready(Config(
  geolocation: GeoConfig(
    // ...your existing geolocation config...
    filter: LocationFilterConfig(
      policy: LocationFilterPolicy.passThrough,
      useKalman: false,                 // optional
      trackingAccuracyThreshold: 0,      // optional: disables accuracy gate
      odometerAccuracyThreshold: 0       // optional: disables accuracy gate
    )
  ),
));

Setting *AccuracyThreshold to 0 disables the accuracy-gate rejection.

Recommended migration step

After upgrading to v5, review your logs for location rejections/adjustments and tune geolocation.filter (policy, Kalman, and thresholds) to match your use-case.

Some keys have new enum types:
- logLevel is now a LogLevel enum (e.g., LogLevel.info), but legacy integer values are still supported for backward compatibility. You may use either the new enum or the legacy integer type.
Some keys have moved to new groups:
- E.g., debug is now in LoggerConfig.
Legacy flat config remains supported but deprecated:
- Using the legacy flat config will show warnings at runtime, but will not result in an error. Migration to the new grouped config is recommended for future compatibility.

🧪 Testing Your Migration

Run your app after migration.
Check for errors or warnings about missing or misplaced config keys.
Review logs to ensure config is applied as expected.
Consult the API docs for each config group if unsure.

🆘 Need Help?

See the API Reference for each config class.
Ask questions on GitHub Discussions or open an issue.

📚 Resources

🎉 Happy Migrating!

If you have suggestions for improving this guide, please open a PR or issue.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🚀 Migration Guide: Flat Config → Compound Config

📢 Overview

🔑 New License Key Format

Overview

Getting Your New License Key

Applying Your License Key

⚙️ Compatibility

⏩ Why Compound Config?

🏗️ Old vs. New Config Structure

Before (Flat Config)

After (Compound Config)

🗺️ Mapping Table: Flat → Compound

🧑‍💻 Migration Steps

📝 Example Migration

Flat Config (Old)

Compound Config (New)

🧩 Compound Config Groups

🛠️ Full Mapping Table

⚠️ Breaking Changes

LocationFilter enabled by default (behavior change in `onLocation`)

Preserve v4 behavior (PassThrough / “passthrough mode”)

Recommended migration step

🧪 Testing Your Migration

🆘 Need Help?

📚 Resources

🎉 Happy Migrating!

FilesExpand file tree

MIGRATION-GUIDE-5.0.0.md

Latest commit

History

MIGRATION-GUIDE-5.0.0.md

File metadata and controls

🚀 Migration Guide: Flat Config → Compound Config

📢 Overview

🔑 New License Key Format

Overview

Getting Your New License Key

Applying Your License Key

⚙️ Compatibility

⏩ Why Compound Config?

🏗️ Old vs. New Config Structure

Before (Flat Config)

After (Compound Config)

🗺️ Mapping Table: Flat → Compound

🧑‍💻 Migration Steps

📝 Example Migration

Flat Config (Old)

Compound Config (New)

🧩 Compound Config Groups

🛠️ Full Mapping Table

⚠️ Breaking Changes

LocationFilter enabled by default (behavior change in onLocation)

Preserve v4 behavior (PassThrough / “passthrough mode”)

Recommended migration step

🧪 Testing Your Migration

🆘 Need Help?

📚 Resources

🎉 Happy Migrating!

LocationFilter enabled by default (behavior change in `onLocation`)