WeConnect/rsdev.ovh.weconnect.model

Package-level declarations

Types

@Serializable

data class AccessStatus(val doors: List<DoorState>, val windows: List<WindowState>, val overallStatus: String?, val doorLockStatus: String?)

Door lock and window status for all vehicle openings.

BatteryStatus

@Serializable

data class BatteryStatus(val capturedAt: Instant, val currentSoc: Int?, val remainingRange: Int?, val carType: CarType?) : CarStatus

High-voltage (traction) battery state: charge level and remaining electric range.

BatterySupportStatus

@Serializable

data class BatterySupportStatus(val batterySupport: String?)

Battery support mode status.

CarStatus

@Serializable

abstract class CarStatus

Base class for time-stamped status sections. Each subclass captures data from a specific BFF capability.

CarType

@Serializable

enum CarType : Enum<CarType>

Vehicle powertrain type as reported by the BFF API.

ChargingProfile

@Serializable

data class ChargingProfile(val id: Int?, val name: String?, val maxChargingCurrent: String?, val minSoc: Int?, val targetSoc: Int?, val autoUnlockPlugWhenCharged: String?, val preferredChargingTimes: List<PreferredChargingTime>)

A named charging profile with target SoC, current limit, and time windows.

ChargingProfiles

@Serializable

data class ChargingProfiles(val profiles: List<ChargingProfile>, val vehiclePositionedInProfileId: Int?, val nextChargingTimerId: Int?, val nextChargingTimerTargetSocReachable: String?)

Collection of charging profiles configured for a vehicle.

ChargingState

@Serializable(with = ChargingStateSerializer::class)

sealed class ChargingState

Sealed hierarchy representing all known charging states from the BFF API. Unknown API values are captured as Unknown.

ChargingStateSerializer

object ChargingStateSerializer : KSerializer<ChargingState>

ChargingStatus

@Serializable

data class ChargingStatus(val capturedAt: Instant, val chargingState: ChargingState?, val chargeMode: String?, val chargePower: Double?, val remainingTimeToCompleteMin: Int?, val targetSoc: Int?) : CarStatus

Current charging session state: mode, power, target SoC, and estimated time remaining.

ClimatizationState

@Serializable(with = ClimatizationStateSerializer::class)

sealed class ClimatizationState

Sealed hierarchy representing climate control operating states.

ClimatizationStateSerializer

object ClimatizationStateSerializer : KSerializer<ClimatizationState>

ClimatizationStatus

@Serializable

data class ClimatizationStatus(val capturedAt: Instant, val state: ClimatizationState?, val remainingTimeMin: Int?, val targetTemperature: Double?, val windowHeatingEnabled: Boolean?) : CarStatus

Climate control state: heating/cooling mode, target temperature, and window heating.

DoorState

@Serializable

data class DoorState(val name: String, val status: String)

Per-door open/close state.

LightState

@Serializable

data class LightState(val name: String, val status: List<String>)

State of a single vehicle light group.

LvBatteryStatus

@Serializable

data class LvBatteryStatus(val batterySupport: String?, val voltage: Double?)

12V (low-voltage) auxiliary battery state.

MeasurementStatus

@Serializable

data class MeasurementStatus(val mileage: Int?, val odometer: Int?, val temperatureBattery: Double?, val temperatureBatteryMin: Double?, val temperatureBatteryMax: Double?)

Odometer and battery temperature measurements. All temperatures in Celsius, distances in km.

ParkingPosition

@Serializable

data class ParkingPosition(val latitude: Double, val longitude: Double, val heading: Double?, val capturedAt: Instant)

Last known parking position (GPS coordinates and compass heading).

PlugConnectionState

@Serializable(with = PlugConnectionStateSerializer::class)

sealed class PlugConnectionState

Sealed hierarchy representing charging plug connection states.

PlugConnectionStateSerializer

object PlugConnectionStateSerializer : KSerializer<PlugConnectionState>

PlugLockState

@Serializable(with = PlugLockStateSerializer::class)

sealed class PlugLockState

Sealed hierarchy representing charging plug lock states.

PlugLockStateSerializer

object PlugLockStateSerializer : KSerializer<PlugLockState>

PlugStatus

@Serializable

data class PlugStatus(val capturedAt: Instant, val plugConnectionState: PlugConnectionState?, val plugLockState: PlugLockState?) : CarStatus

Charging plug connection and lock state.

PowerBudgetStatus

@Serializable

data class PowerBudgetStatus(val dailyPowerBudgetAvailable: Boolean?, val insufficientBatteryLevelWarning: Boolean?, val dailyPowerBudgetWarning: Boolean?)

Daily power budget availability and warning flags.

PreferredChargingTime

@Serializable

data class PreferredChargingTime(val id: Int?, val enabled: Boolean?, val startTime: String?, val endTime: String?)

A preferred charging time window within a ChargingProfile.

ReadinessStatus

@Serializable

data class ReadinessStatus(val isOnline: Boolean, val ignitionOn: Boolean, val inMotion: Boolean, val batteryPowerLevel: String?, val isActive: Boolean, val insufficientBatteryLevelWarning: Boolean?, val dailyPowerBudgetWarning: Boolean?)

Vehicle connectivity and motion readiness flags.

Trip

@Serializable

data class Trip(val id: Long, val tripEndTimestamp: Instant, val tripType: String, val mileage: Int?, val averageElectricConsumption: Double?, val averageFuelConsumption: Double?, val averageSpeed: Double?, val travelTimeSeconds: Int?)

Summary of a single trip with consumption and speed averages. All distances in km, speeds in km/h.

Vehicle

@Serializable

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

A vehicle registered under the VW We Connect account.

VehicleDump

@Serializable

data class VehicleDump(val vehicle: Vehicle, val status: VehicleStatus)

A vehicle paired with its full status snapshot, useful for serialisation/export.

VehicleHealthInspection

@Serializable

data class VehicleHealthInspection(val inspectionDueDays: Int?, val inspectionDueDistance: Int?, val oilServiceDueDays: Int?, val oilServiceDueDistance: Int?)

Service inspection and oil change intervals (days and km remaining).

VehicleHealthWarnings

@Serializable

data class VehicleHealthWarnings(val mileage: Int?, val warningLights: List<WarningLight>, val insufficientBatteryLevelWarning: Boolean?)

Active warning lights and battery-level warnings.

VehicleLightsStatus

@Serializable

data class VehicleLightsStatus(val lights: List<LightState>)

Exterior lighting status.

VehicleStatus

@Serializable

data class VehicleStatus(val vin: String, val batteryStatus: BatteryStatus?, val chargingStatus: ChargingStatus?, val plugStatus: PlugStatus?, val climatizationStatus: ClimatizationStatus?, val parkingPosition: ParkingPosition?, val readinessStatus: ReadinessStatus?, val measurementStatus: MeasurementStatus?, val accessStatus: AccessStatus?, val vehicleLightsStatus: VehicleLightsStatus?, val lvBatteryStatus: LvBatteryStatus?, val vehicleHealthWarnings: VehicleHealthWarnings?, val vehicleHealthInspection: VehicleHealthInspection?, val batterySupportStatus: BatterySupportStatus?, val powerBudgetStatus: PowerBudgetStatus?)

Aggregated status snapshot for a single vehicle, assembled from the BFF selective status endpoint.

WarningLight

@Serializable

data class WarningLight(val text: String?, val category: String?, val priority: Int?, val iconColor: String?)

A single warning light indicator from the instrument cluster.

WindowState

@Serializable

data class WindowState(val name: String, val status: String)

Per-window open/close state.