Products
Use cases
Docs
Support
Search…
Introducing DriveKit
DriveKit Guides
Get started with drivekit
iOS
Android
Trip recording lifecycle
Trip analysis
Introduction
iOS
Android
Get started
Auto start
Beacon usage
Bluetooth usage
Advanced configuration
Custom metadata
Crash Detection
References (Android)
User Interface
REST services
Trip Simulator
PERMISSIONS UTILS
Introduction
User interface
COMMON UI
Introduction
iOS
Android
References
DRIVER DATA
Introduction
iOS
Android
User interface
Vehicle
Introduction
iOS
Android
User Interface
DRIVER ACHIEVEMENT
Introduction
iOS
Android
User interface
CHALLENGE
Introduction
iOS
Android
User interface
REST SERVICES
Push Data
Driver
Drivers
Group
Vehicle
Beacon
Trips
Release notes
Changelog
Powered By
GitBook
References (Android)
StartMode
StartMode indicates how the trip is started. It is an enum with the following values:
Value
Description
gps
Automatic start when the SDK detects a change in user position
beacon
Automatic start due to the presence of a beacon
manual
Trip started manually by calling the method
startTrip
geozone
Automatic start when the SDK detects that you exit the zone where your vehicle may be parked
bluetooth
Automatic start by detecting a connection to a vehicle's Bluetooth system
unknown_bluetooth
Automatic start by detecting a connection to a unknown vehicle's Bluetooth system
bicycle_activity
Automatic start by detecting a bicycle activity
1
enum
class
StartMode
(
val
intValue
:
Int
)
{
2
GPS
(
1
),
BEACON
(
2
),
MANUAL
(
3
),
GEOZONE
(
4
),
BLUETOOTH
(
5
),
UNKNOWN_BLUETOOTH
(
6
),
BICYCLE_ACTIVITY
(
7
)
3
}
Copied!
CancelTrip
CancelTrip indicates how the trip was cancelled. It is an enum with the following values:
Value
Description
USER
Trip cancelled by calling the method
cancelTrip
HIGHSPEED
Trip cancelled because speed was too high (train, airplane)
NO_SPEED
Trip cancelled because speed was too slow to be made in a vehicle
NO_BEACON
Trip cancelled because the beacon was not detected while it was
required
MISSING_CONFIGURATION
Trip cancelled because DriveKit was not configured
NO_GPS_DATA
Trip cancelled because no GPS data was recorded
RESET
Trip cancelled because SDK configuration has been
reset
BEACON_NO_SPEED
Trip cancelled because the beacon is near the smartphone but there was no movement (zero or low speed)
1
enum
class
CancelTrip
{
2
USER
,
HIGHSPEED
,
NO_SPEED
,
NO_BEACON
,
MISSING_CONFIGURATION
,
NO_GPS_DATA
,
RESET
,
BEACON_NO_SPEED
3
}
Copied!
TripPoint
TripPoint is an object that contains data for each location registered by the SDK.
1
data
class
TripPoint
(
2
val
latitude
:
Double
,
3
val
longitude
:
Double
,
4
val
speed
:
Double
,
5
val
accuracy
:
Double
,
6
val
elevation
:
Double
,
7
val
distance
:
Double
,
8
val
heading
:
Double
,
9
val
duration
:
Double
10
)
Copied!
Attribute
Type
Description
latitude
Double
Latitude
longitude
Double
Longitude
speed
Double
Speed in km/h
accuracy
Double
Accuracy of the GPS data in meter
elevation
Double
Elevation in meter
distance
Double
Distance since the beginning of the trip in meter
heading
Double
Heading
duration
Double
Duration since the beginning of the trip in second
Vehicle
Vehicle is an object that contains vehicle detailed characteristics.
1
data
class
Vehicle
(
2
val
carTypeIndex
:
Int
=
1
,
3
val
carEngineIndex
:
Int
=
1
,
4
val
carPower
:
Double
=
150.0
,
5
val
carMass
:
Double
=
1400.0
,
6
val
carGearboxIndex
:
Int
=
2
,
7
val
carConsumption
:
Double
=
4.5
,
8
val
carAutoGearboxNumber
:
Int
=
0
9
)
Copied!
Attribute
Type
Description
carTypeIndex
Int
Vehicle body type
carEngineIndex
Int
Engine type (1: gasoline, 2: Diesel, 3: electric vehicle)
carPower
Double
Vehicle power in hp. This value must be entered in horsepower. In case you only have the engine power in kW you can apply the following formula:
P
[
h
p
]
=
P
[
k
W
]
/
0.7355
P [hp] = P [kW] / 0.7355
P
[
h
p
]
=
P
[
kW
]
/0.7355
(min: 40 hp, max 450 hp)
carMass
Double
Vehicle mass in kg (min: 700 kg, max: 3500 kg)
carGearboxIndex
Int
Gearbox type
carConsumption
Double
Combined fuel consumption [l/100km] measured during the New European Driving Cycle (NEDC). (min: 3 l/100km, max: 20 l/100km)
carAutoGearboxNumber
Int
Number of gear ratios for the automatic gearbox. This parameter is taken into account only if
carGearboxIndex
is set to 1.
Vehicle body type
Value
Description
1
Compact
2
Sedan
3
Luxury vehicle
4
Estate car
5
Minivan
6
4x4, SUV
7
Sports car
8
Convertible
9
Commercial vehicle
Gearbox type
Value
Description
1
Automatic
2
Manual-5-speed
3
Manual-6-speed
4
Manual-7-speed
5
Manual-8-speed
TripNotification
TripNotification is an object that contains the configuration of the foreground notification displayed during a trip.
1
data
class
TripNotification
(
val
title
:
String
,
val
content
:
String
,
val
iconId
:
Int
)
{
2
var
cancel
:
String
?
=
null
3
var
cancelIconId
:
Int
?
=
null
4
var
enableCancel
:
Boolean
=
false
5
}
Copied!
Attribute
Type
Description
title
String
Title of the notification
content
String
Content of the notification
iconId
Int
The icon resource for notification
cancel
String
Text of cancel button
cancelIconId
Int
Icon resource of cancel button
enableCancel
Boolean
If true a cancel button will be displayed in notification that cancels the trip when pressed
The
cancelIconId
and
cancel
parameters must be set if the
enableCancel
parameter is set to true.
BeaconData
BeaconData is an object that contains beacon characteristics.
1
data
class
BeaconData
(
2
val
proximityUuid
:
String
,
3
val
major
:
Int
,
4
val
minor
:
Int
5
)
Copied!
Attribute
Type
Description
proximityUuid
String
Beacon proximity UUID
major
Int
Beacon major value (set to -1 to ignore value)
minor
Int
Beacon minor value (set to -1 to ignore value)
BluetoothData
BluetoothData is an object that contains the Bluetooth device characteristics.
1
data
class
BluetoothData
(
2
val macAddress
:
String
,
3
val name
:
String
?
)
Copied!
Attribute
Type
Description
macAddress
String
Required MAC address of the device
name
String
Optional display name of the device
Previous
Crash Detection
Next - Trip analysis
User Interface
Last modified
1yr ago
Export as PDF
Copy link
Contents
StartMode
CancelTrip
TripPoint
Vehicle
Vehicle body type
Gearbox type
TripNotification
BeaconData
BluetoothData