Trip management
Last updated
Was this helpful?
Last updated
Was this helpful?
The automatic mode detects vehicle movements and triggers the trip analysis without driver intervention while the application is in background. The analysis is stopped automatically at the end of the trip.
This feature is recommended to avoid driver distraction and phone handling while driving. The automatic mode has been optimized to limit the battery drain.
By default, automatic trip detection is disabled, but you can enable it by calling the following method:
To disable automatic trip detection call the same method with parameter enable
set to false
If a trip is running when automatic trip detection is disable, the trip will not be canceled. If you want to cancel the trip, you should also call method.
You can start a trip by calling the following method:
You can stop a trip by calling the following method. The trip will be stopped instantly:
If you want to cancel a trip, you can call this method:
To obtain a more precise analysis on driving behavior, it's recommended to configure the vehicle used by the driver. You can do this by calling the following method:
Two methods are available to determine SDK state.
This method returns false
if the SDK is in inactive
state, and no trip is currently running.
If you want a more detailed state of the SDK, you can call the following method:
This method returns the state of the SDK:
inactive
: No trip is running.
starting
: The auto start mode detects a movement of the user and checks if it's a trip in vehicle.
running
: The trip has been confirmed by the speed of the movement.
stopping
: The SDK is in this state when a potential trip end is detected. If the trip continues, the SDK goes back in running
state. The duration of the stopping state can be configured.
sending
: The trip is finished and is being sent to DriveQuant's server. When the SDK has the response from the server, the state becomes inactive
waiting for the next trip.
When a trip analysis is starting, you may need some information about it, like the StartMode
which triggers the trip recording, a local unique identifier of the trip that has not yet been analyzed by the DriveQuant’s servers, etc.
To retrieve information about the current trip, use the following method:
localTripId
String
Local and unique trip identifier generated by DriveKit SDK.
⚠️ It is different from the itinId
property returned in the Trip object. itinId
corresponds to the unique trip identifier generated after the data analysis.
date
Date
Start date of the trip analysis.
startMode
StartMode
Trip Analysis SDK have a repost mechanism, in most cases, when a trip is finished it is sent to DriveQuant's server to be analyzed and once it's done, the result of the analysis is sent back to the SDK.
In some case, the trip can't be sent to the server (no network for example). In this case, the SDK will save the trip data locally, to send it later. A retry will be attempted when the next trip will start.
If you want to check if there is locally saved trips and if they can be sent to the server, you can call the following method:
A trip being analyzed is automatically stopped 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:
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.
Thanks to the driving location sharing feature, a user can generate a link that directs to a map displaying its location while driving. Location sharing provides peace of mind to family members during a trip. This section describes the methods to manage the location-sharing link.
If the trip sharing feature is enabled for your company, your API key carries out the feature access and a trip sharing link can be generated.
To check if the trip sharing feature is available for your API key, you can call the following code:
To generate a link to share trips, use the following code:
The method takes a durationInSeconds
parameter which indicates how long in seconds from now the sharing link will be valid.
success
The link has been successfully created. Information is returned in data
.
activeLinkAlreadyExists
A link already exists for this user.
Information returned in data
is nil.
error
An error occurred, for instance when the user has no network.
Information returned in data
is nil.
userNotConnected
The user is not yet connected to DriveKit. Information returned in data
is nil.
invalidDuration
An error occurred when trying to create a link. The duration parameter must be strictly greater than 0. Information returned in data
is nil.
unauthenticated
The user has been disconnected.
Information returned in data
is nil.
forbidden
Your API key is not allowed to use the feature.
Information returned in data
is nil.
code
String
Unique trip sharing code.
url
String
URL of the map that will display the current trip of the user.
startDate
Date
Link validity start date
endDate
Date
Link expiration date.
To retrieve a link to share trips, use the following code:
The method takes a synchronizationType
parameter. It will retrieve locally stored data if the value is .cache
, otherwise with the .defaultSync
value it will call the DriveQuant’s servers.
success
The link has been successfully retrieved. Information is returned in data
.
failedToGetCacheOnly
An error occurred when trying to retrieve a link. Locally trip sharing link, if exists, is returned in data.
noActiveLink
There is no active link for the user.
Information returned in data
is nil.
userNotConnected
The user is not yet connected to DriveKit. Information returned in data
is nil.
unauthenticated
The user has been disconnected.
Information returned in data
is nil.
forbidden
Your API key is not allowed to use the feature.
Information returned in data
is nil.
To revoke a trip sharing link, use the following code:
success
The link has been successfully revoked.
noActiveLink
There is no active link for the user.
error
An error occurred when trying to revoke the link.
userNotConnected
The user is not yet connected to DriveKit.
unauthenticated
The user has been disconnected.
forbidden
Your API key is not allowed to use the feature.
The Trip Analysis SDK 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 journey is completed. The data is transmitted at a lower frequency with a time interval of one point per minute.
Sharing information with the server allows you to store the trip data even if it's been interrupted and the data post could not be performed at the end of the trip. This can happen in very rare cases such as the destruction of the mobile phone for instance.
By default, this setting is disabled but you can enable it by calling the following method:
To disable this setting, call the same method with the parameter set to false
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.
Start-Mode for trip recording: manual, GPS-based or beacon-based.
Beacon parameters: uuid, major, minor.
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.
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:
The potentialTripStart()
method can return all StartMode values ; except MANUAL
. Indeed, a trip manually started is considered as confirmed.
This function returns the location of the end of the last trip recorded by the user.
The location is defined by GPS coordinates (latitude and longitude), along with the end date of the last trip and an accuracy indicator for the GPS reading.
You can use the end-of-trip coordinate for a variety of purposes, for example:
help the user find his vehicle
alert the customer that the user has reached a specific destination
create a region monitoring (also known as geofencing) to locate the vehicle
To retrieve the location at which the last recorded trip ended, use the following method:
date
Date
Date of the end of trip.
latitude
Double
Latitude of the end of the trip.
longitude
Double
Longitude of the end of the trip.
accuracyMeter
Double
GPS data accuracy value in meters.
func getAccuracyLevel()
DKCoordinateAccuracy
GPS data accuracy level. Possible values are described below.
For ease of use, this function provides a position accuracy indicator with a 3-level scale.
good
The GPS accuracy is strictly below 10 meters.
fair
The GPS accuracy is between 10 and 30 meters.
poor
The GPS accuracy is strictly above 30 meters.
A detailed description of vehicle parameter is available .
⚠️ It is different from the startDate property returned in the object.
The which triggered the trip analysis.
💡 You have to call the method to in your workflow.
This feature allows you to share to the server the location of a driver during all his trips. It is different from the feature where the user chooses to share his trips for a certain duration, thanks to a link showing his current trip on a map.
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, .
Once the feature is enabled, events will be available in the potentialTripStart()
callback.