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

val vehiclesTypes = listOf(VehicleType.CAR, VehicleType.TRUCK)
       DriveKitVehicleUI.configureVehiclesTypes(vehiclesTypes)

Java

List<VehicleType> vehiclesTypes = Arrays.asList(VehicleType.CAR, VehicleType.TRUCK);
DriveKitVehicleUI.INSTANCE.configureVehiclesTypes(vehiclesTypes);

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

val categoryConfigType = CategoryConfigType.BOTH_CONFIG
DriveKitVehicleUI.configureCategoryConfigType(categoryConfigType)

Java

CategoryConfigType categoryConfigType = CategoryConfigType.BOTH_CONFIG;
DriveKitVehicleUI.INSTANCE.configureCategoryConfigType(categoryConfigType);

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

DriveKitVehicleUI.configureDetectionModes(
    listOf(DetectionMode.DISABLED, DetectionMode.GPS, DetectionMode.BEACON, DetectionMode.BLUETOOTH)
)

Java

DriveKitVehicleUI.INSTANCE.configureDetectionModes(
   Arrays.asList(DetectionMode.DISABLED, DetectionMode.GPS, DetectionMode.BEACON, DetectionMode.BLUETOOTH)
);

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

DriveKitVehicleUI.enableOdometer(hasOdometer : Boolean)

Java

DriveKitVehicleUI.Companion.enableOdometer(hasOdometer : Boolean)

Display mileage tracking

To include the vehicle odometer component, you need to use the following method:

startOdometerUIActivity(activity: Activity, vehicleId:String? = null)

If you just want to display the odometer component with default configuration you can use the following method:

Kotlin

DriveKitVehicleUI.startOdometerUIActivity(activity)

Java

DriveKitVehicleUI.INSTANCE.startOdometerUIActivity(activity, null)

If you want to display a particular vehicle odometer, add vehicleId as a parameter.

Kotlin

DriveKitVehicleUI.startOdometerUIActivity(activity, "vehicleId")

Java

DriveKitVehicleUI.INSTANCE.startOdometerUIActivity(activity, "vehicleId")

Find my vehicle

The Vehicle component includes a feature that helps users easily find where they parked their vehicle. It displays the user’s current location alongside the vehicle’s last known location and, if needed, offers to launch a route from the user’s current position to the vehicle using their preferred navigation app.

This feature uses the getVehicleLocation() method from the Vehicle component to retrieve the vehicle’s last known location.

To display the “Find my vehicle” screen into your app, call the following method:

Kotlin

DriveKitVehicleUI.startFindMyVehicleActivity(context, "myVehicleId")

Java

DriveKitVehicleUI.INSTANCE.startFindMyVehicleActivity(context, "myVehicleId");

If you don’t have a vehicle identifier, you can also get the location of the latest used vehicle. This feature uses getLastVehicleTripLocation() method from TripAnalysis module

Kotlin

DriveKitVehicleUI.startFindMyVehicleActivity(context)

Java

DriveKitVehicleUI.INSTANCE.startFindMyVehicleActivity(context);