WeConnect/rsdev.ovh.weconnect.api

Package-level declarations

Types

@Serializable

data class AccessStatusValue(val value: AccessValue)

@Serializable

data class AccessValue(val overallStatus: String? = null, val doorLockStatus: String? = null, val doors: List<DoorValue>? = null, val windows: List<WindowValue>? = null)

AccessWrapper

@Serializable

data class AccessWrapper(val accessStatus: AccessStatusValue? = null)

BatterySupportContent

@Serializable

data class BatterySupportContent(val batterySupport: String? = null)

BatterySupportValue

@Serializable

data class BatterySupportValue(val value: BatterySupportContent)

BatterySupportWrapper

@Serializable

data class BatterySupportWrapper(val batterySupport: BatterySupportValue? = null)

Capability

enum Capability : Enum<Capability>

ChargingProfileDto

@Serializable

data class ChargingProfileDto(val id: Int? = null, val name: String? = null, val maxChargingCurrent: String? = null, val minSOC_pct: Int? = null, val targetSOC_pct: Int? = null, val options: ChargingProfileOptionsDto? = null, val preferredChargingTimes: List<PreferredChargingTimeDto>? = null)

ChargingProfileOptionsDto

@Serializable

data class ChargingProfileOptionsDto(val id: Int? = null, val autoUnlockPlugWhenCharged: String? = null)

ChargingProfilesApi

class ChargingProfilesApi(authProvider: AuthProvider, sharedClient: HttpClient? = null) : Closeable

Client for the VW BFF charging profiles endpoint.

ChargingProfilesContent

@Serializable

data class ChargingProfilesContent(val carCapturedTimestamp: String? = null, val profiles: List<ChargingProfileDto>? = null, val vehiclePositionedInProfileID: Int? = null, val nextChargingTimer: NextChargingTimerDto? = null)

ChargingProfilesResponse

@Serializable

data class ChargingProfilesResponse(val chargingProfiles: ChargingProfilesContent? = null)

ChargingStatusValue

@Serializable

data class ChargingStatusValue(val value: ChargingValue)

ChargingValue

@Serializable

data class ChargingValue(val carCapturedTimestamp: String, val plugConnectionState: String? = null, val plugLockState: String? = null, val chargingState: String? = null, val chargeMode: String? = null, val chargePowerInKw: Double? = null, val remainingTimeToCompleteSocInMin: Int? = null, val targetSocValue: Int? = null)

ChargingWrapper

@Serializable

data class ChargingWrapper(val chargingStatus: ChargingStatusValue? = null)

ClimatisationSettingsInner

@Serializable

data class ClimatisationSettingsInner(val carCapturedTimestamp: String? = null, val targetTemperature: Double? = null, val windowHeatingEnabled: Boolean? = null)

ClimatisationSettingsValue

@Serializable

data class ClimatisationSettingsValue(val value: ClimatisationSettingsInner)

ClimatisationStatusValue

@Serializable

data class ClimatisationStatusValue(val value: ClimatisationValue)

ClimatisationValue

@Serializable

data class ClimatisationValue(val carCapturedTimestamp: String, val climatisationState: String? = null, val remainingClimatisationTimeMin: Int? = null)

ClimatisationWrapper

@Serializable

data class ClimatisationWrapper(val climatisationStatus: ClimatisationStatusValue? = null, val climatisationSettings: ClimatisationSettingsValue? = null)

ConnectionState

@Serializable

data class ConnectionState(val isOnline: Boolean? = null, val ignitionOn: Boolean? = null, val inMotion: Boolean? = null, val batteryPowerLevel: String? = null, val isActive: Boolean? = null, val dailyPowerBudgetAvailable: Boolean? = null)

ConnectionWarningValue

@Serializable

data class ConnectionWarningValue(val insufficientBatteryLevelWarning: Boolean? = null, val dailyPowerBudgetWarning: Boolean? = null)

DoorValue

@Serializable

data class DoorValue(val name: String? = null, val status: List<String>? = null)

FuelLevelStatusValue

@Serializable

data class FuelLevelStatusValue(val value: FuelLevelValue)

FuelLevelValue

@Serializable

data class FuelLevelValue(val mileage_km: Int? = null)

FuelStatusValue

@Serializable

data class FuelStatusValue(val carCapturedTimestamp: String, val carType: String? = null, val primaryEngine: PrimaryEngine? = null, val totalRangeKm: Int? = null)

FuelStatusWrapper

@Serializable

data class FuelStatusWrapper(val rangeStatus: RangeStatusValue? = null)

GpsCoordinates

@Serializable

data class GpsCoordinates(val latitude: Double, val longitude: Double)

GpsPositionContent

@Serializable

data class GpsPositionContent(val carCapturedTimestamp: String, val gpsCoordinates: GpsCoordinates, val heading: Double? = null)

GpsPositionValue

@Serializable

data class GpsPositionValue(val value: GpsPositionContent)

LibraryVersion

object LibraryVersion

LightValue

@Serializable

data class LightValue(val name: String? = null, val status: List<String>? = null)

LvBatteryContent

@Serializable

data class LvBatteryContent(val batterySupport: String? = null, val voltage: Double? = null)

LvBatteryValue

@Serializable

data class LvBatteryValue(val value: LvBatteryContent)

LvBatteryWrapper

@Serializable

data class LvBatteryWrapper(val lvBattery: LvBatteryValue? = null)

MeasurementsWrapper

@Serializable

data class MeasurementsWrapper(val fuelLevelStatus: FuelLevelStatusValue? = null, val temperatureBatteryStatus: TemperatureBatteryStatusValue? = null, val odometerStatus: OdometerStatusValue? = null)

NextChargingTimerDto

@Serializable

data class NextChargingTimerDto(val id: Int? = null, val targetSOCreachable: String? = null)

OdometerStatusValue

@Serializable

data class OdometerStatusValue(val value: OdometerValue)

OdometerValue

@Serializable

data class OdometerValue(val odometer: Int? = null)

ParkingPositionWrapper

@Serializable

data class ParkingPositionWrapper(val gpsPosition: GpsPositionValue? = null)

PreferredChargingTimeDto

@Serializable

data class PreferredChargingTimeDto(val id: Int? = null, val enabled: Boolean? = null, val startTime: String? = null, val endTime: String? = null)

PrimaryEngine

@Serializable

data class PrimaryEngine(val currentSOC_pct: Int? = null, val remainingRange_km: Int? = null)

RangeStatusValue

@Serializable

data class RangeStatusValue(val value: FuelStatusValue)

ReadinessStatusValue

@Serializable

data class ReadinessStatusValue(val value: ReadinessValue)

ReadinessValue

@Serializable

data class ReadinessValue(val connectionState: ConnectionState? = null, val connectionWarning: ConnectionWarningValue? = null)

ReadinessWrapper

@Serializable

data class ReadinessWrapper(val readinessStatus: ReadinessStatusValue? = null)

SelectiveStatusMapper

object SelectiveStatusMapper

SelectiveStatusResponse

@Serializable

data class SelectiveStatusResponse(val fuelStatus: FuelStatusWrapper? = null, val charging: ChargingWrapper? = null, val climatisation: ClimatisationWrapper? = null, val parkingPosition: ParkingPositionWrapper? = null, val readiness: ReadinessWrapper? = null, val measurements: MeasurementsWrapper? = null, val access: AccessWrapper? = null, val vehicleLights: VehicleLightsWrapper? = null, val lvBattery: LvBatteryWrapper? = null, val vehicleHealthWarnings: VehicleHealthWarningsWrapper? = null, val vehicleHealthInspection: VehicleHealthInspectionWrapper? = null, val batterySupport: BatterySupportWrapper? = null)

TemperatureBatteryStatusValue

@Serializable

data class TemperatureBatteryStatusValue(val value: TemperatureBatteryValue? = null)

TemperatureBatteryValue

@Serializable

data class TemperatureBatteryValue(val temperatureValue: Double? = null, val temperatureHvBatteryMin_K: Double? = null, val temperatureHvBatteryMax_K: Double? = null)

TripsApi

class TripsApi(authProvider: AuthProvider, sharedClient: HttpClient? = null) : Closeable

Client for the VW BFF trip data endpoints.

TripsResponse

@Serializable

data class TripsResponse(val id: Long? = null, val tripEndTimestamp: String? = null, val tripType: String? = null, val vehicleType: String? = null, val mileage_km: Int? = null, val startMileage_km: Int? = null, val overallMileage_km: Int? = null, val travelTime: Int? = null, val averageFuelConsumption: Double? = null, val averageElectricConsumption: Double? = null, val averageSpeed_kmph: Double? = null, val averageAuxConsumption: Double? = null, val averageRecuperation: Double? = null)

TripType

enum TripType : Enum<TripType>

Trip aggregation type used by the BFF trips endpoint.

VehicleApi

class VehicleApi(authProvider: AuthProvider, sharedClient: HttpClient? = null) : Closeable

Client for the VW BFF vehicle data endpoints.

VehicleCommandsApi

class VehicleCommandsApi(authProvider: AuthProvider, sharedClient: HttpClient? = null) : Closeable

Client for the VW BFF vehicle command endpoints.

VehicleData

@Serializable

data class VehicleData(val vin: String, val model: String? = null, val nickname: String? = null, val brandCode: String? = null, val role: String? = null, val enrollmentStatus: String? = null, val userRoleStatus: String? = null, val devicePlatform: String? = null)

VehicleHealthInspectionContent

@Serializable

data class VehicleHealthInspectionContent(val inspectionDue_days: Int? = null, val inspectionDue_km: Int? = null, val oilServiceDue_days: Int? = null, val oilServiceDue_km: Int? = null)

VehicleHealthInspectionValue

@Serializable

data class VehicleHealthInspectionValue(val value: VehicleHealthInspectionContent)

VehicleHealthInspectionWrapper

@Serializable

data class VehicleHealthInspectionWrapper(val vehicleHealthInspection: VehicleHealthInspectionValue? = null)

VehicleHealthWarningsContent

@Serializable

data class VehicleHealthWarningsContent(val mileage_km: Int? = null, val warningLights: List<WarningLightValue>? = null, val insufficientBatteryLevelWarning: Boolean? = null)

VehicleHealthWarningsValue

@Serializable

data class VehicleHealthWarningsValue(val value: VehicleHealthWarningsContent)

VehicleHealthWarningsWrapper

@Serializable

data class VehicleHealthWarningsWrapper(val vehicleHealthWarnings: VehicleHealthWarningsValue? = null)

VehicleLightsContent

@Serializable

data class VehicleLightsContent(val lights: List<LightValue>? = null)

VehicleLightsValue

@Serializable

data class VehicleLightsValue(val value: VehicleLightsContent)