platform_vehiclefunctions_api_service_vehicleelectricengine/com.tomtom.ivi.platform.vehiclefunctions.api.service.vehicleelectricengine/VehicleElectricEngineService

VehicleElectricEngineService

interface VehicleElectricEngineService
Content copied to clipboard

A service interface that provides access to state information, coming through the VHAL as properties of electric (EV) or hybrid vehicles.

Not all vehicles have EV or hybrid properties, and specific functionality can be unavailable. To reflect this, individual properties can have different states.

  • Unsupported: the property is not supported by the vehicle platform. In this case the property itself is set to null.

  • Supported, but unavailable: the property is temporarily unavailable or has an invalid value, indicated by the value field of the property being set to null.

  • Available: the property is available and has a valid value.

Types

Link copied to clipboard
object Companion
Content copied to clipboard

Properties

Link copied to clipboard
abstract val accelerationEfficiency: VehicleProperties.NumberProperty<Float>?
Content copied to clipboard

The efficiency of the engine when accelerating.

Link copied to clipboard
abstract val auxiliaryPower: VehicleProperties.SingleProperty<Power>?
Content copied to clipboard

The amount of power consumed by sustaining auxiliary systems. It can be used to specify consumption due to devices and systems like AC systems, radio, heating, etc.

Link copied to clipboard
abstract val batteryChargeLevel: VehicleProperties.RangedProperty<Energy>?
Content copied to clipboard

Indicates the current battery level, if EV or hybrid. The maximum value of this ranged property indicates the battery's capacity.

Link copied to clipboard
abstract val chargingConnectors: VehicleProperties.SetProperty<VehicleEvChargingConnector>?
Content copied to clipboard

The charging connectors supported by the vehicle.

Link copied to clipboard
abstract val chargingCurve: VehicleProperties.SetProperty<VehicleEvChargingCurvePoint>?
Content copied to clipboard

An estimate of how fast the battery charges, depending on the current charging level.

Link copied to clipboard
abstract val chargingTimeOffset: VehicleProperties.SingleProperty<Duration>?
Content copied to clipboard

The charging time offset.

Link copied to clipboard
abstract val consumptionModel: VehicleProperties.SingleProperty<VehicleEvConsumptionModel>?
Content copied to clipboard

The data used to estimate how much energy the vehicle requires for driving.

Link copied to clipboard
abstract val decelerationEfficiency: VehicleProperties.NumberProperty<Float>?
Content copied to clipboard

The efficiency of the engine when decelerating.

Link copied to clipboard
abstract val downhillEfficiency: VehicleProperties.NumberProperty<Float>?
Content copied to clipboard

The efficiency of the engine going downhill.

Link copied to clipboard
abstract val isChargingConnectorConnected: VehicleProperties.BooleanProperty?
Content copied to clipboard

Indicates if the charging connector is connected to the vehicle.

Link copied to clipboard
abstract val remainingRange: VehicleProperties.SingleProperty<Distance>?
Content copied to clipboard

The remaining range.

Link copied to clipboard
abstract val uphillEfficiency: VehicleProperties.NumberProperty<Float>?
Content copied to clipboard

The efficiency of the engine going uphill.