References (Android)
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 |
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 |
enum class StartMode(val intValue : Int) {GPS(1), BEACON(2), MANUAL(3), GEOZONE(4), BLUETOOTH(5), UNKNOWN_BLUETOOTH(6), BICYCLE_ACTIVITY(7)}
CancelTrip indicates how the trip was cancelled. It is an enum with the following values:
Value | Description |
USER | Trip cancelled by calling the method |
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) |
enum class CancelTrip {USER, HIGHSPEED, NO_SPEED, NO_BEACON, MISSING_CONFIGURATION, NO_GPS_DATA, RESET, BEACON_NO_SPEED}
TripPoint is an object that contains data for each location registered by the SDK.
data class TripPoint(val latitude : Double,val longitude : Double,val speed : Double,val accuracy : Double,val elevation : Double,val distance : Double,val heading : Double,val duration : Double)
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 is an object that contains vehicle detailed characteristics.
data class Vehicle (val carTypeIndex: Int = 1,val carEngineIndex: Int = 1,val carPower: Double = 150.0,val carMass: Double = 1400.0,val carGearboxIndex: Int = 2,val carConsumption: Double = 4.5,val carAutoGearboxNumber: Int = 0)
Attribute | Type | Description |
carTypeIndex | Int | |
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: (min: 40 hp, max 450 hp) |
carMass | Double | Vehicle mass in kg (min: 700 kg, max: 3500 kg) |
carGearboxIndex | Int | |
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 |
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 |
Value | Description |
1 | Automatic |
2 | Manual-5-speed |
3 | Manual-6-speed |
4 | Manual-7-speed |
5 | Manual-8-speed |
TripNotification is an object that contains the configuration of the foreground notification displayed during a trip.
data class TripNotification(val title: String, val content: String, val iconId: Int) {var cancel: String? = nullvar cancelIconId: Int? = nullvar enableCancel: Boolean = false}
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 is an object that contains beacon characteristics.
data class BeaconData(val proximityUuid: String,val major: Int,val minor: Int)
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 is an object that contains the Bluetooth device characteristics.
data class BluetoothData(val macAddress: String,val name: String?)
Attribute | Type | Description |
macAddress | String | Required MAC address of the device |
name | String | Optional display name of the device |
