Main configurations

Vehicle Type

The UI vehicle module allows the selection of two vehicle types: (1) cars and (2) trucks. The selection of user-configurable vehicle types is performed via the VehicleType enum.
You can define the vehicle types to be used by calling the following method:
Kotlin
Java
1
val vehiclesTypes = listOf(VehicleType.CAR, VehicleType.TRUCK)
2
DriveKitVehicleUI.configureVehiclesTypes(vehiclesTypes)
Copied!
1
List<VehicleType> vehiclesTypes = Arrays.asList(VehicleType.CAR, VehicleType.TRUCK);
2
DriveKitVehicleUI.INSTANCE.configureVehiclesTypes(vehiclesTypes);
Copied!
Settings:
  • CAR
  • TRUCK
Default value: [CAR, TRUCK]

Vehicle selection mode

DriveKit Vehicle UI allows you to choose between two types of vehicle selection modes with the categoryConfigType variable.
Method to select a generic vehicle from its category
Method to select a vehicle from its brand, version and model
You can choose which mode you want to use by calling the following method:
Kotlin
Java
1
val categoryConfigType = CategoryConfigType.BOTH_CONFIG
2
DriveKitVehicleUI.configureCategoryConfigType(categoryConfigType)
Copied!
1
CategoryConfigType categoryConfigType = CategoryConfigType.BOTH_CONFIG;
2
DriveKitVehicleUI.INSTANCE.configureCategoryConfigType(categoryConfigType);
Copied!
Settings:
  • LITE_CONFIG_ONLY: the driver simply selects a default vehicle model corresponding to a category (city car, sedan, utility vehicle, etc.). The characteristics of the vehicle will be those of a default model chosen to represent this vehicle category.
  • BRANDS_CONFIG_ONLY: the process of adding a vehicle includes more steps that lead to the exact selection of the user's vehicle.
  • BOTH_CONFIG: both modes are available to the user. The user starts by selecting a vehicle category. If he wishes, he can stop at this stage, otherwise he can proceed with the other steps.
Default value: BOTH_CONFIG

Selection of the auto start mode

The SDK allows 4 configurations for the automatic start of the trip analysis. This configuration is controlled via DetectionMode.
You can choose which detection mode(s) to display by calling the following method:
Kotlin
Java
1
DriveKitVehicleUI.configureDetectionModes(
2
listOf(DetectionMode.DISABLED, DetectionMode.GPS, DetectionMode.BEACON, DetectionMode.BLUETOOTH)
3
)
Copied!
1
DriveKitVehicleUI.INSTANCE.configureDetectionModes(
2
Arrays.asList(DetectionMode.DISABLED, DetectionMode.GPS, DetectionMode.BEACON, DetectionMode.BLUETOOTH)
3
);
Copied!
Settings:
  • DISABLED
  • GPS
  • BEACON
  • BLUETOOTH
Default value: [ DISABLED, GPS, BEACON, BLUETOOTH ]

Vehicle mileage tracking and editing

The vehicle UI component includes a simple and powerful feature to automatically track vehicle mileage and manually add a mileage record. The mileage computation is based on the sum of the trip distances for all the trips recorded automatically.
If some trips are lost or if you notice a difference between the mileage measured by the SDK and the mileage displayed on the vehicle's odometer, it is possible to correct the value and manually add the real value.

Enable mileage tracking

By default, the mileage tracking feature is disabled, if you wish to enable it, simply use the method below:
Kotlin
Java
1
DriveKitVehicleUI.enableOdometer(hasOdometer : Boolean)
Copied!
1
DriveKitVehicleUI.Companion.enableOdometer(hasOdometer : Boolean)
Copied!

Display mileage tracking

To include the vehicle odometer component, you need to use the following method:
1
startOdometerUIActivity(activity: Activity, vehicleId:String? = null)
Copied!
If you just want to display the odometer component with default configuration you can use the following method:
Kotlin
Java
1
DriveKitVehicleUI.startOdometerUIActivity(activity)
Copied!
1
DriveKitVehicleUI.INSTANCE.startOdometerUIActivity(activity, null)
Copied!
If you want to display a particular vehicle odometer, add vehicleId as a parameter.
Kotlin
Java
1
DriveKitVehicleUI.startOdometerUIActivity(activity, "vehicleId")
Copied!
1
DriveKitVehicleUI.INSTANCE.startOdometerUIActivity(activity, "vehicleId")
Copied!