volvo-api-core/com.github.ayastrebov.volvo.api.model.connectedvehicle

Package-level declarations

Types

AvailableCommand

@Serializable

data class AvailableCommand(val command: String? = null, val href: String? = null)

Available command with its accessibility status.

BaseInvokeResult

interface BaseInvokeResult

Base interface for all command invocation results.

BrakeStatus

@Serializable

data class BrakeStatus(val brakeFluidLevelWarning: ValueWithTimestamp<String>? = null)

Brake status values.

BrakeStatusResponse

@Serializable

data class BrakeStatusResponse(val status: Int? = null, val operationId: String? = null, val data: BrakeStatus? = null)

Vehicle brake status response.

Command

@Serializable

data class Command(val command: String? = null, val href: String? = null)

Available command for the vehicle.

CommandAccessibility

@Serializable

data class CommandAccessibility(val availableCommands: List<AvailableCommand>? = null, val unavailableCommands: List<UnavailableCommand>? = null)

Command accessibility status.

CommandAccessibilityResponse

@Serializable

data class CommandAccessibilityResponse(val status: Int? = null, val operationId: String? = null, val data: CommandAccessibility? = null)

Vehicle command accessibility response.

CommandListResponse

@Serializable

data class CommandListResponse(val status: Int? = null, val operationId: String? = null, val data: List<Command>? = null)

Vehicle command list response.

CommandResponse

@Serializable

data class CommandResponse(val status: Int? = null, val operationId: String? = null, val data: InvokeResult? = null)

Response for a command invocation.

Diagnostics

@Serializable

data class Diagnostics(val serviceWarning: ValueWithTimestamp<String>? = null, val serviceTrigger: ValueWithTimestamp<String>? = null, val engineHoursToService: ValueWithTimestamp<Int>? = null, val distanceToService: ValueWithTimestamp<Int>? = null, val washerFluidLevelWarning: ValueWithTimestamp<String>? = null, val timeToService: ValueWithTimestamp<Int>? = null)

Vehicle diagnostic values.

DiagnosticsResponse

@Serializable

data class DiagnosticsResponse(val status: Int? = null, val operationId: String? = null, val data: Diagnostics? = null)

Vehicle diagnostics response.

DoorAndLockStatus

@Serializable

data class DoorAndLockStatus(val centralLock: ValueWithTimestamp<String>? = null, val frontLeftDoor: ValueWithTimestamp<String>? = null, val frontRightDoor: ValueWithTimestamp<String>? = null, val rearLeftDoor: ValueWithTimestamp<String>? = null, val rearRightDoor: ValueWithTimestamp<String>? = null, val hood: ValueWithTimestamp<String>? = null, val tailgate: ValueWithTimestamp<String>? = null, val tankLid: ValueWithTimestamp<String>? = null)

Door and lock status values.

DoorAndLockStatusResponse

@Serializable

data class DoorAndLockStatusResponse(val status: Int? = null, val operationId: String? = null, val data: DoorAndLockStatus? = null)

Vehicle door and lock status response.

EmptyCommandRequest

@Serializable

data object EmptyCommandRequest

Empty request body for command invocations that require no parameters.

EngineDiagnostics

@Serializable

data class EngineDiagnostics(val oilLevelWarning: ValueWithTimestamp<String>? = null, val engineCoolantLevelWarning: ValueWithTimestamp<String>? = null)

Engine diagnostic values.

EngineDiagnosticsResponse

@Serializable

data class EngineDiagnosticsResponse(val status: Int? = null, val operationId: String? = null, val data: EngineDiagnostics? = null)

Vehicle engine diagnostics response.

EngineStartRequest

@Serializable

data class EngineStartRequest(val runtimeMinutes: Int)

Request body for engine start command.

EngineStatus

@Serializable

data class EngineStatus(val engineStatus: ValueWithTimestamp<String>? = null)

Engine status values.

EngineStatusResponse

@Serializable

data class EngineStatusResponse(val status: Int? = null, val operationId: String? = null, val data: EngineStatus? = null)

Vehicle engine status response.

FuelAmount

@Serializable

data class FuelAmount(val fuelAmount: ValueWithTimestamp<Double>? = null)

Fuel amount value in liters.

FuelAmountResponse

@Serializable

data class FuelAmountResponse(val status: Int? = null, val operationId: String? = null, val data: FuelAmount? = null)

Vehicle fuel amount response.

InvokeResult

@Serializable

data class InvokeResult(val vin: String? = null, val invokeStatus: String? = null, val message: String? = null) : BaseInvokeResult

Standard command invocation result.

Odometer

@Serializable

data class Odometer(val odometer: ValueWithTimestamp<Int>? = null)

Odometer value.

OdometerResponse

@Serializable

data class OdometerResponse(val status: Int? = null, val operationId: String? = null, val data: Odometer? = null)

Vehicle odometer response.

Statistics

@Serializable

data class Statistics(val averageSpeed: ValueWithTimestamp<String>? = null, val distanceToEmpty: ValueWithTimestamp<String>? = null, val tripMeter1: ValueWithTimestamp<String>? = null, val tripMeter2: ValueWithTimestamp<String>? = null, val averageFuelConsumption: ValueWithTimestamp<String>? = null)

Vehicle statistics data.

StatisticsResponse

@Serializable

data class StatisticsResponse(val status: Int? = null, val operationId: String? = null, val data: Statistics? = null)

Vehicle statistics response.

TyrePressureValue

@Serializable

data class TyrePressureValue(val value: String? = null, val timestamp: Instant? = null)

Individual tyre pressure value.

TyreStatus

@Serializable

data class TyreStatus(val frontLeft: TyrePressureValue? = null, val frontRight: TyrePressureValue? = null, val rearLeft: TyrePressureValue? = null, val rearRight: TyrePressureValue? = null)

Tyre pressure values for all wheels.

TyreStatusResponse

@Serializable

data class TyreStatusResponse(val status: Int? = null, val operationId: String? = null, val data: TyreStatus? = null)

Vehicle tyre pressure status response.

UnavailableCommand

@Serializable

data class UnavailableCommand(val command: String? = null, val reason: String? = null)

Unavailable command with reason.

UnlockCommandResponse

@Serializable

data class UnlockCommandResponse(val status: Int? = null, val operationId: String? = null, val data: UnlockInvokeResult? = null)

Response for unlock command invocation with additional unlock-specific fields.

UnlockInvokeResult

@Serializable

data class UnlockInvokeResult(val vin: String? = null, val invokeStatus: String? = null, val message: String? = null, val readyToUnlock: Boolean? = null, val readyToUnlockUntil: Long? = null) : BaseInvokeResult

Unlock command invocation result with additional unlock-specific fields.

VehicleDescriptions

@Serializable

data class VehicleDescriptions(val model: String? = null, val upholstery: String? = null, val steering: String? = null)

Vehicle descriptions.

VehicleDetails

@Serializable

data class VehicleDetails(val vin: String? = null, val modelYear: Int? = null, val gearbox: String? = null, val fuelType: String? = null, val externalColour: String? = null, val batteryCapacityKWH: Double? = null, val images: VehicleImages? = null, val descriptions: VehicleDescriptions? = null)

Detailed information about a vehicle.

VehicleDetailsResponse

@Serializable

data class VehicleDetailsResponse(val status: Int? = null, val operationId: String? = null, val data: VehicleDetails? = null)

Vehicle details response.

VehicleImages

@Serializable

data class VehicleImages(val exteriorImageUrl: String? = null, val internalImageUrl: String? = null)

Vehicle image URLs.

VehicleListResponse

@Serializable

data class VehicleListResponse(val status: Int? = null, val operationId: String? = null, val data: List<VehicleVin>? = null)

Response containing a list of vehicles associated with the user.

VehicleVin

@Serializable

data class VehicleVin(val vin: String)

Vehicle identification.

Warnings

@Serializable

data class Warnings(val brakeLightCenterWarning: ValueWithTimestamp<String>? = null, val brakeLightLeftWarning: ValueWithTimestamp<String>? = null, val brakeLightRightWarning: ValueWithTimestamp<String>? = null, val fogLightFrontWarning: ValueWithTimestamp<String>? = null, val fogLightRearWarning: ValueWithTimestamp<String>? = null, val positionLightFrontLeftWarning: ValueWithTimestamp<String>? = null, val positionLightFrontRightWarning: ValueWithTimestamp<String>? = null, val positionLightRearLeftWarning: ValueWithTimestamp<String>? = null, val positionLightRearRightWarning: ValueWithTimestamp<String>? = null, val highBeamLeftWarning: ValueWithTimestamp<String>? = null, val highBeamRightWarning: ValueWithTimestamp<String>? = null, val lowBeamLeftWarning: ValueWithTimestamp<String>? = null, val lowBeamRightWarning: ValueWithTimestamp<String>? = null, val daytimeRunningLightLeftWarning: ValueWithTimestamp<String>? = null, val daytimeRunningLightRightWarning: ValueWithTimestamp<String>? = null, val turnIndicationFrontLeftWarning: ValueWithTimestamp<String>? = null, val turnIndicationFrontRightWarning: ValueWithTimestamp<String>? = null, val turnIndicationRearLeftWarning: ValueWithTimestamp<String>? = null, val turnIndicationRearRightWarning: ValueWithTimestamp<String>? = null, val registrationPlateLightWarning: ValueWithTimestamp<String>? = null, val sideMarkLightsWarning: ValueWithTimestamp<String>? = null, val hazardLightsWarning: ValueWithTimestamp<String>? = null, val reverseLightsWarning: ValueWithTimestamp<String>? = null)

Vehicle exterior warnings (bulb failures, etc.).

WarningsResponse

@Serializable

data class WarningsResponse(val status: Int? = null, val operationId: String? = null, val data: Warnings? = null)

Vehicle warnings response.

WindowStatus

@Serializable

data class WindowStatus(val frontLeftWindow: ValueWithTimestamp<String>? = null, val frontRightWindow: ValueWithTimestamp<String>? = null, val rearLeftWindow: ValueWithTimestamp<String>? = null, val rearRightWindow: ValueWithTimestamp<String>? = null, val sunroof: ValueWithTimestamp<String>? = null)

Status of vehicle windows.

WindowStatusResponse

@Serializable

data class WindowStatusResponse(val status: Int? = null, val operationId: String? = null, val data: WindowStatus? = null)

Vehicle window status response.

Properties

status

val BaseInvokeResult.status: InvokeStatus

Returns the BaseInvokeResult.invokeStatus as a type-safe InvokeStatus enum.