EvDataProvider

interface EvDataProvider

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
open val ascent: Flow<Float?>

Optional parameter that defines the amount of energy an electric vehicle consumes from increasing elevation (watt-hours per meter). Max value is currently 1000.0 Wh/m and min value is currently 0.0 Wh/m. This is used in conjunction with the descent parameter, as a result both must be supplied when using either optional field. If only one of these parameters is supplied, this is considered an invalid query and will be rejected.

Link copied to clipboard
open val auxiliaryConsumption: Flow<Int?>

Optional parameter that defines latest auxiliary consumption of the EV which is the energy in watts consumed by the vehicle's auxiliary systems (e.g., air conditioning, lights). Note if auxiliary_consumption is NOT specified, API fallbacks to using corresponding value from ev directions request, if available, for this refresh session.

Link copied to clipboard
abstract val chargingCurve: Flow<String>

Specifies the maximum battery charging rate (W) at a given charge level (Wh) in a list of pairs. Example value of 0,100000; 40000,70000; 60000,30000; 80000,10000 defines for instance 70 kW charging when the battery has 40 kWh charge. The charging curve's charging levels should span from 0 to maximum charge. The first element's charging rate is assumed to be constant between the 0 and the first element's charging level. The last element's charging rate is assumed to be constant between the last element's charging level and maxCharge.

Link copied to clipboard
abstract val connectorTypes: Flow<String>

Defines the compatible connector-types for the vehicle. The router will select the charging stations compatible with connector-types. Following connector-types are supported:

Link copied to clipboard
open val descent: Flow<Float?>

Optional parameter that defines the amount of energy an electric vehicle gains from decreasing elevation (watt-hours per meter). Max value is currently 1000.0 Wh/m and min value is currently 0.0 Wh/m. This is used in conjunction with the ascent parameter, as a result both must be supplied when using either optional field. If only one of these parameters is supplied, this is considered an invalid query and will be rejected.

Link copied to clipboard
abstract val energyConsumptionCurve: Flow<String>

Specifies in pairs the energy consumption in watt-hours per kilometer at a certain speed in kph. Example value of 0,300;20,160;80,140;120,180 defines for instance 160 watt-hours per kilometer at 20 km/h.

Link copied to clipboard
abstract val isChargerPluggedIn: Flow<Boolean>

Defines whether charger is plugged in or not.

Link copied to clipboard
open val maxAcChargingPower: Flow<Int?>

Optional parameter. Specify maximum AC charging power(W) that can be delivered by the onboard vehicle charger. This parameter along with the chargingCurve dictates the battery charging rate. For example, when charging at a 16kW AC power outlet, with a vehicle onboard AC converter of 10kW (maxAcChargingPower), router will use max charging power of 10kW. The default value is 14400W.

Link copied to clipboard
abstract val maxBatteryRange: Flow<Float?>

Defines the maximum possible range of the vehicle in kilometers based on the current SoC.

Link copied to clipboard
abstract val maxCharge: Flow<Int>

Defines the maximum possible charge of vehicle in Wh (watt-hours). Example value of 80000 denotes a battery capacity of 80 kWh.

Link copied to clipboard

Optional parameter. Limits maximum charge when charging at stations (Wh). Example value of 20000 denotes that the vehicle will not charge past 20 kWh charge at a charging station. maxChargeAtChargingStation must be between 0 and ev_max_charge. The default value is 100% of maxCharge.

Link copied to clipboard
abstract val minBatteryRange: Flow<Float?>

Defines the minimum possible range of the vehicle in kilometers based on the current SoC.

Link copied to clipboard

Optional parameter. Defines the minimum charge when arriving at the charging station (Wh). Example value of 20000 denotes that the vehicle will reach each charging stop with at least 20 kWh charge. minChargeAtChargingStation must be between 0 and ev_max_charge. The default value is 10% of maxCharge.

Link copied to clipboard
open val minChargeAtDestination: Flow<Int?>

Optional parameter. Defines the minimum battery charge required at the final route destination (Wh). Example value of 20000 denotes that vehicle will reach destination with at least 20 kWh charge. minChargeAtDestination must be between 0 and ev_max_charge. The default value is 10% of maxCharge.

Link copied to clipboard
open val preConditioningTime: Flow<Int?>

Optional parameter. Defines the time in minutes it would take for the vehicle's battery to condition. This is used in conjunction with the unconditionedChargingCurve parameter, as a result both must be supplied when using either optional field. If only one of these parameters is supplied, they both will be ignored.

Link copied to clipboard
abstract val secondsRemainingToCharge: Flow<Int?>

Defines remaining time in seconds until the vehicle's battery is fully charged.

Link copied to clipboard
open val socEstimateAvgSpeed: Flow<Speed?>

Optional parameter. Average speed used for fast State Of Charge estimation. This value is used to query the energyConsumptionCurve to get the energy consumption in watt-hours per kilometer — the returned value is then multiplied by the distance traveled to get the total energy used.

Link copied to clipboard
abstract val stateOfCharge: Flow<Float>

Defines the current state of charge (SoC) of the vehicle's battery in percent. Example value of 50 denote 50% charge compared to the maxCharge.

Link copied to clipboard

Optional parameter. Specifies the maximum battery charging rate (W) at a specified charge level (Wh) in a list of pairs when the battery is in an unconditioned state (eg: cold). This is used in conjunction with the preConditioningTime parameter, as a result both must be supplied when using either optional field. If only one of these parameters is supplied, they both will be ignored.