Advanced configuration

Custom stop timeout

A trip being analyzed is automatically terminated after a period of inactivity (which begins when the vehicle has stopped). The DriveQuant SDK allows to set the end-of-trip duration.
By default, the trip analysis is stopped after 240 seconds. This value can be tuned according to your need and you can choose any integer values between 120 and 480 seconds by calling the following method:
Kotlin
Java
1
DriveKitTripAnalysis.setStopTimeOut(180)
Copied!
1
DriveKitTripAnalysis.INSTANCE.setStopTimeOut(180);
Copied!
If a value greater than 480 is set, the value will be forced to 480.
If a value lower than 120 is set, the value will be forced to 120.

Custom metadata

If your use case requires it, it is possible to add your own data in the trip analysis request. For example, it can be data that is specific to your trip, application or user identification system.
You can add additional metadata to your trip by calling the following method:
Kotlin
Java
1
DriveKitTripAnalysis.setTripMetaData(metaData)
Copied!
1
DriveKitTripAnalysis.INSTANCE.setTripMetaData(metaData);
Copied!
The metadata must be represented as a key/value object where the key and value have a String type.
If metadata are sent, they will also be added to the push data request in the metaData field.

Sharing data during the trip

The Trip Analysis component records the trip locally while it is in progress. The data are recorded with a period of one point per second. At the end of the trip, the SDK requests the driving analysis service and then retrieves the driving indicators.
In addition to this feature, the SDK is also able to share data with the server before the trip is completed. The data is transmitted at a lower frequency with a time interval of one point per minute.
The system for sharing information during the trip can be used in a vehicle fleet management system. This feature requires access to specific APIs. For more information, contact DriveQuant.
Sharing information with the server allows you to store the trip data even if it has been interrupted, and if the data post at the end of the trip could not be performed. This can happen in very rare cases such as the destruction of the mobile phone.
By default, this setting is disabled but you can enable it by calling the following method:
Kotlin
Java
1
DriveKitTripAnalysis.enableSharePosition(true)
Copied!
1
DriveKitTripAnalysis.INSTANCE.enableSharePosition(true);
Copied!
To disable this setting, call the same method with the parameter set to false
Kotlin
Java
1
DriveKitTripAnalysis.enableSharePosition(false)
Copied!
1
DriveKitTripAnalysis.INSTANCE.enableSharePosition(false);
Copied!
Here is the list of data shared every minute by the SDK:
  • Date of trip start.
  • Duration of the trip in seconds.
  • Distance traveled in km.
  • Longitude of the current location.
  • Latitude of the current location.
  • Smartphone battery level.
  • StartMode of the trip recording: manual, GPS-based or beacon-based.
  • Beacon parameters: uuid, major, minor.

Access the trip trigger events

Why use trip triggers?

DriveKit's automatic start mode detects a trip and launches its recording immediately. This operating mode may not be appropriate for all use cases.
Your application may require other information or business logic before enabling the trip recording. For example, it may be appropriate to check that:
  • A connected device is near to the smartphone.
  • The trip recording is acceptable in a given time slot.
In this case, you may want to subscribe to the events that are indicative of the trip start but not necessarily launch the GPS sensor and the trip analysis.
This is why DriveKit allows you to subscribe to trigger events that indicate that a trip has probably started.

How does it work?

By default, this feature is disabled.
To enable this feature, DriveKit Trip Analysis should not be configured in automatic mode but in manual mode.
If DriveKit Trip Analysis is set to automatic mode, the trip will be recorded.
If DriveKit Trip Analysis is set to manual mode and you follow the instructions below, you will be able to listen for trip start trigger events but the trip analysis will not be started automatically.
To listen to trigger events that indicate a start of trip, even if the autostart is disabled, you can call the following method:
Kotlin
Java
1
DriveKitTripAnalysis.monitorPotentialTripStart = true
Copied!
1
DriveKitTripAnalysis.INSTANCE.monitorPotentialTripStart = true
Copied!
Once the feature is enabled, events will be available in the TripListener potentialTripStart() where you initialize the TripAnalysis component:
Kotlin
Java
1
DriveKitTripAnalysis.initialize(createForegroundNotification(), object: TripListener {
2
(...)
3
4
override fun potentialTripStart(startMode: StartMode) {
5
6
}
7
})
Copied!
1
DriveKitTripAnalysis.INSTANCE.initialize(createForegroundTripNotification(), new TripListener() {
2
(...)
3
4
@Override
5
public void potentialTripStart(@NotNull StartMode startMode) {
6
7
}
8
});
Copied!
The potentialTripStart() method can return all StartMode values ; except MANUAL.
Indeed, a trip manually started is considered as confirmed.
Last modified 4mo ago