Install SDK for Ionic

Add Hypertrack Plugin to project

Ionic HyperTrack plugin is available for Android platform. To use it add it to your project. If you have Ionic v5.27 or later just execute:

$ npm install @ionic-native/hyper-track

Otherwise you need to install it locally, as you Ionic contains obsolete plugin version. To do it run from the project root directory:

$ curl -SLo hypertrack-plugin.zip https://github.com/hypertrack/ionic-native/releases/download/v5.27.0/hypertrack-v3-0.0.1.zip && \
unzip hypertrack-plugin.zip -d "/app/node_modules/@ionic-native/" && \
rm -f hypertrack-plugin.zip

Since Ionic plugin uses cordova plugin under the hood, you need to install dependency too.

$ npx ionic cordova plugin add cordova-plugin-hypertrack-v3

Import HyperTrack class

Add HyperTrack class to local namespace.

import {HyperTrack} from '@ionic-native/hyper-track';

Get sdk instance.

Get sdk instance passing your publishable key as a parameter:

function initializeHyperTrack() {
console.log("Initializing HyperTrack")
HyperTrack.enableDebugLogging()
HyperTrack.initialize('YOUR-PUBLISHABLE-KEY')
.then( onSdkInstanceReceived )
.catch((err) => console.error("HyperTrack init failed with error " + err));
}
function onSdkInstanceReceived(sdkInstance: HyperTrack) {
console.log("HyperTrack succesfully initialized");
}

Set up silent push notifications

Set up silent push notifications to manage on-device tracking using HyperTrack cloud APIs from your server. This requires Firebase push notification. If you do not yet have push notifications enabled, please proceed to setup Firebase Cloud Messaging.

Also you need to add your Firebase API key to your HyperTrack Dashboard Setup Page under Server to Device communication section.

note

Push notifications have delays so if you're looking for more instant channel you can use syncDeviceSettings plugin method to speed up command propagation.

Identify your device

We use internal unique identifiers to manage the devices, so in order to be able to distinguish between users you need to get this device id and pass it to your backend to establish user to deviceId mapping.

onSdkInstanceReceived(sdkInstance: HyperTrack) {}
sdkInstance.getDeviceId()
.then((id) => {
console.log("Got device id " + id)
document.getElementById('device_id').textContent = id
})
.catch((err) => console.error("Got error in HyperTrack " + err))
}

Give your device a name

You can set device name that will show up in your Dashboard and attach metadata. You might wish to look at this guide on how to use it.

hyperTrackInstance.setDeviceName("Jon Hyperseed"))
.then(() => console.log("Device name was changed"))
.then(() => hyperTrackInstance.setDeviceMetadata({platform: "Ionic Android"}))
.then(() => console.log("Device metadata was changed"))

Request permissions

HyperTrack needs access to device's geolocation and motion sensors to detect its position. Although you can use third party libraries to present the dialog, sdk has convenience method for it.

sdkInstance.requestPermissionsIfNecessary()

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.

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:

Frequently Asked Questions


What API levels (Android versions) are supported?

Currently we do support all of the Android versions starting from API 19 (Android 4.4 Kit Kat).


Why do I have NoClassDefFoundError?

I've added SDK and my app started failing with message like:

Fatal Exception: java.lang.NoClassDefFoundError

This takes place because on Android API level 19 and below you cannot have more than 65536 methods in your app (including methods in libraries).

Please check this StackOverflow answer for solutions.


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.

persistent-notification


How do I handle custom ROMs?
Smartphones are getting more and more powerful, but the battery capacity is lagging behind. Device manufactures 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, you may add the following code in your app. This would intent out your user to the right settings page on the device.

try {
Intent intent = new Intent();
String manufacturer = android.os.Build.MANUFACTURER;
if ("xiaomi".equalsIgnoreCase(manufacturer)) {
intent.setComponent(new ComponentName("com.miui.securitycenter", "com.miui.permcenter.autostart.AutoStartManagementActivity"));
}
else if ("oppo".equalsIgnoreCase(manufacturer)) {
intent.setComponent(new ComponentName("com.coloros.safecenter", "com.coloros.safecenter.permission.startup.StartupAppListActivity"));
}
else if ("vivo".equalsIgnoreCase(manufacturer)) {
intent.setComponent(new ComponentName("com.vivo.permissionmanager", "com.vivo.permissionmanager.activity.BgStartUpManagerActivity"));
}
List<ResolveInfo> list = context.getPackageManager().queryIntentActivities(intent, PackageManager.MATCH_DEFAULT_ONLY);
if (list.size() > 0) {
context.startActivity(intent);
}
}
catch (Exception e) {
Crashlytics.logException(e);
}

You may also try out open source libraries like AutoStarter.

Some manufacturers don't allow to whitelist apps programmatically.

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:

one-plus-example


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.


Starting from Android 10 Google imposes additional restrictions on services, that access location data while phone screen is turned off. Possible workaround here is to remove declared service property by adding following element to your app's manifest

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.hypertrack.quickstart"
xmlns:tools="http://schemas.android.com/tools">
...
<application>
...
<service android:name="com.hypertrack.sdk.service.HyperTrackSDKService"
tools:remove="android:foregroundServiceType" />

Although you'll be able to avoid targeting API 29, but tracking service won't work properly on Android Q devices with screen been turned off or locked.


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.