Install SDK on Flutter

Add Hypertrack SDK

Add following lines to your applications pubspec.yml:

dependencies:

hypertrack_plugin: ^0.2.0

note

We constantly work on making our SDKs better, so make sure you have the latest version of it. You might take a look of its changelog here.

Import Hypertrack SDK

Import the SDK in the main.dart file of your project

import 'package:hypertrack_plugin/hypertrack.dart';

Install Hypertrack SDK

Install the SDK using the following command:

$ flutter pub get

Alternatively, the code editor might support flutter pub get. Check the editor docs for your editor to learn more.

Initialize SDK

Obtain an SDK instance, when you wish to use SDK, by passing your publishable key from the Setup page.

• Dart

HyperTrack sdk = await HyperTrack.initialize("your-publishable-key-here");

HyperTrack accesses location and activity data, you may use HyperTrack.requestPermissionsIfNecessary() convenience method to request permissions and make the SDK integration simpler.

Identify your devices

HyperTrack uses string device identifiers that could be obtained from the SDK instance

• Dart

String deviceId = await sdk.getDeviceId();

Make sure you've saved this device identifier as it is required when calling HyperTrack Devices and Trips APIs.

Give your device a name

A device can be tagged with a custom name

• Dart

sdk.setDeviceName("device-name-here");

Tag locations with geotags

Some places are more important then the others, so you can mark them on map, creating geotag when specific action in your app happens (e.g. delivery is marked done or driver confirmend pickup)

// Tag the geolocation of app action

final result = sdk.addGeotag({"action": "Login"})

if (result is GeotagSuccess) {

developer.log("Current place was tagged successfully");

} else {

GeotagError error = result as GeotagError;

developer.log("Can't tag current place due to a ${error.reason}");

}

If you already know the address, where action is supposed to happen, you can specify it to analyze the deviations

// Tag the geolocation of app action

final expectedLocation = ExpectedLocation(35.0476912, -90.0260493)

final result = sdk.addGeotag({"action": "Login"}, expectedLocation)

if (result is GeotagSuccessWithDeviation) {

GeotagSuccessWithDeviation success = result as GeotagSuccessWithDeviation;

developer.log("Created a geotag within ${success.deviation} meters from expected location");

} else {

GeotagError error = result as GeotagError;

developer.log("Can't tag current place due to a ${error.reason}");

}

Prepare for App Store and Play Market submission

Read the Prepare for App Store submission section of iOS SDK guide and Get approved for the background location access section of Android SDK guide.

Tracking your device

Once you integrated the SDK into your app, you can start tracking your device.

In order to test and verify your SDK integration, you can use either PlayGround in the Dashboard or call Devices and Trips APIs from your server.

• You can start tracking your device with the API
• You can create trips with destination
• You can also create trips with geofences

Dashboard

Once your app is running, go to the Dashboard where you can see a list of all your devices and their live location with ongoing activity on the map.

You are all set

You can now run the app and start using HyperTrack. You can see your devices on the dashboard.

SDK integration examples

To learn more about SDK integration examples, you may visit these resources:

• QuickStart app
• Use case sample apps

Frequently Asked Questions

What API levels (Android versions) are supported?

Currently we do support all of the Android versions starting from API 21 (Android 5.0 Lollipop).

Why do I have persistent notification on my app?

HyperTrack SDK by default runs as a foreground service. This is to ensure that the location tracking works reliably even when your app is minimized.

A foreground service is a service that the user is actively aware of and isn't a candidate for the system to kill when it is low on memory. Android mandates that a foreground service provides a persistent notification in the status bar. This means that the notification cannot be dismissed by the user.

How do I handle custom ROMs?

Smartphones are getting more and more powerful, but the battery capacity is lagging behind. Device manufacturers are always trying to squeeze some battery saving features into the firmware with each new Android release. Manufactures like Xiaomi, Huawei and OnePlus have their own battery savers that kills the services running in the background.

To avoid OS killing the service, users of your app need to override the automatic battery management and set it manual.

To inform your users and direct them to the right setting page, SDK shows a special promt on requestPermissionsIfNecessary() invocation.

Unfortunately whitelisting can't be performed programmatically. So you need to always rely on user performing particular action.

In that case the only way to achieve service reliability is manual setup. E.g. for Oxygen OS (OnePlus) you need to select Lock menu item from app options button in Recent Apps view:

Why does HyperTrack notification show even after my app is terminated?

The HyperTrack service runs as a separate component and it is still running when the app that started it is terminated. That is why you can observe that notification. When you tracking is stopped, the notification goes away.

How does tracking work in Doze mode?

Doze mode requires device to be stationary, so before OS starts imposing power management restrictions, exact device location is obtained. When device starts moving, Android leaves Doze mode and works regularly, so no special handling of Doze mode required with respect to location tracking.

What is AAPT: error: attribute android:foregroundServiceType not found?

If build fails with error like AAPT: error: attribute android:foregroundServiceType not found that means that you're targeting your app for Android P or earlier. To fix this update your build tools and set the target platform as Android 10 (target SDK level 30). Although there are other workarounds to fix the build still targeting earlier versions, starting from Android 10 Google imposes additional restrictions on services, that access location data while phone screen is turned off, so the drawback will be tracking gaps on devices that run Android 10 or later.

Why doesn't setting device metadata and name work in SDK?

Devices API or in PlayGround take precedence over SDK methods in setting device name and metadata. If you used either Devices API or PlayGround, these SDK methods setDeviceMetadata and setDeviceName will not modify device metadata and name.

Can I test functionality without actual movement

Although HyperTrack SDK ignores mocked locations by default, you can use standard emulator, that comes with Android Studio. Check the official manual on how to use it. All the emulators have (Emulator) suffix appended to the device-hardware field, so they can be easily identified, if you need it to distinguish between them and real devices.

caution

Make sure the mock data, you feeding to the SDK, looks real. Instant teleport from Delhi to New York doesn't make sense, so those values will be ignored by processing logic, that is present on HyperTrack platform. Make sure you set desired start location before turning the traking on.