HMKitFleet

HMKitFleet is the access point for the Fleet SDK functionality. It is accessed by HMKitFleet.INSTANCE and it's field configuration should be set before accessing other functions.

Properties

The shared HMKitFLeet instance

Declaration

public final static HMKitFleet INSTANCE

Set the Service Account Configuration before calling other methods

Declaration

setConfiguration(ServiceAccountApiConfiguration configuration)

Read More

The SDK environment. Default is Production

Declaration

setEnvironment(HMKitFleet.Environment environment)

Read More

Methods

Start the data access clearance process for a vehicle

Declaration

CompletableFuture<Response<ClearanceStatus>> requestClearance(String vin, Brand brand, List<ControlMeasure> controlMeasures)

Parameters

vin

The vehicle VIN number

brand

The vehicle brand

controlMeasures

Optional control measures for some vehicle brands

Start the data access clearance process for a vehicle

Declaration

CompletableFuture<Response<ClearanceStatus>> requestClearance(String vin, Brand brand)

Parameters

vin

The vehicle VIN number

brand

The vehicle brand

Get the status of VINs that have previously been registered for data access clearance with requestClearance

Declaration

CompletableFuture<Response<List<ClearanceStatus>>> getClearanceStatuses()

Discussion

After VIN is Approved, getVehicleAccess and subsequent sendCommand can be sent.

Get the Vehicle Access object.

Declaration

CompletableFuture<Response<VehicleAccess>> getVehicleAccess(String vin)

Parameters

vin

The vehicle VIN number

Send a telematics command to the vehicle

Declaration

CompletableFuture<Response<Bytes>> sendCommand(Bytes command, VehicleAccess vehicleAccess)

Parameters

command

The command that is sent to the vehicle

vehicleAccess

The vehicle access object returned in getVehicleAccess

Revoke the vehicle clearance

Declaration

CompletableFuture<Response<Boolean>> revokeClearance(VehicleAccess vehicleAccess)

Parameters

vehicleAccess

The vehicle access object returned in getVehicleAccess

Environment

Declaration

enum HMKitFleet.Environment {
  PRODUCTION, SANDBOX
}

ClearanceStatus

Declaration

enum ClearanceStatus {
  APPROVED,
  PENDING,
  ERROR,
  REVOKED,
  REJECTED
}