BatterySpecifications (API Reference)
Class BatterySpecifications
Parameters related to the electric vehicle's battery.
-
Field Summary
FieldsModifier and TypeFieldDescriptionFunction curve describing the maximum battery charging rate (in kW) at a given charge level (in kWh).Time in seconds spent after arriving at a charging station, but before actually charging, e.g., time spent for payment processing.List of available charging connector types.doubleCharge level of the vehicle's battery at the start of the route (in kWh).Maximum charging current supported by the vehicle's battery in Amperes.Maximum charging voltage supported by the vehicle's battery in Volts.The maximum power in kilowatts at which a vehicle can charge under given these conditions: The charging station connector's maximum supply voltage is less than 800 V.maxChargingVoltageInVoltsis greater than or equal to 800 V.doubleMinimum charge when arriving at a charging station in kWh.doubleMinimum charge at the final route destination in kWh.Minimum charge when arriving at first charging station in kWh.doubleMaximum charge to which the battery should be charged at a charging station (in kWh).doubleTotal capacity of the vehicle's battery (in kWh). -
Constructor Summary
ConstructorsConstructorDescriptionCreates a new instance.BatterySpecifications(double totalCapacityInKilowattHours) Creates a new instance.BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours) Creates a new instance.BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours, double targetChargeInKilowattHours) Creates a new instance.BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours, double targetChargeInKilowattHours, Map<Double, Double> chargingCurve) Creates a new instance.BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours, double targetChargeInKilowattHours, Map<Double, Double> chargingCurve, List<ChargingConnectorType> connectorTypes) Creates a new instance.BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours, double targetChargeInKilowattHours, Map<Double, Double> chargingCurve, List<ChargingConnectorType> connectorTypes, double minChargeAtChargingStationInKilowattHours) Creates a new instance.BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours, double targetChargeInKilowattHours, Map<Double, Double> chargingCurve, List<ChargingConnectorType> connectorTypes, double minChargeAtChargingStationInKilowattHours, Double minChargeAtFirstChargingStationInKilowattHours) Creates a new instance.BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours, double targetChargeInKilowattHours, Map<Double, Double> chargingCurve, List<ChargingConnectorType> connectorTypes, double minChargeAtChargingStationInKilowattHours, Double minChargeAtFirstChargingStationInKilowattHours, double minChargeAtDestinationInKilowattHours) Creates a new instance.BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours, double targetChargeInKilowattHours, Map<Double, Double> chargingCurve, List<ChargingConnectorType> connectorTypes, double minChargeAtChargingStationInKilowattHours, Double minChargeAtFirstChargingStationInKilowattHours, double minChargeAtDestinationInKilowattHours, Double maxChargingVoltageInVolts) Creates a new instance.BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours, double targetChargeInKilowattHours, Map<Double, Double> chargingCurve, List<ChargingConnectorType> connectorTypes, double minChargeAtChargingStationInKilowattHours, Double minChargeAtFirstChargingStationInKilowattHours, double minChargeAtDestinationInKilowattHours, Double maxChargingVoltageInVolts, Double maxChargingCurrentInAmperes) Creates a new instance.BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours, double targetChargeInKilowattHours, Map<Double, Double> chargingCurve, List<ChargingConnectorType> connectorTypes, double minChargeAtChargingStationInKilowattHours, Double minChargeAtFirstChargingStationInKilowattHours, double minChargeAtDestinationInKilowattHours, Double maxChargingVoltageInVolts, Double maxChargingCurrentInAmperes, Duration chargingSetupDuration) Creates a new instance.BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours, double targetChargeInKilowattHours, Map<Double, Double> chargingCurve, List<ChargingConnectorType> connectorTypes, double minChargeAtChargingStationInKilowattHours, Double minChargeAtFirstChargingStationInKilowattHours, double minChargeAtDestinationInKilowattHours, Double maxChargingVoltageInVolts, Double maxChargingCurrentInAmperes, Duration chargingSetupDuration, Double maxPowerAtLowVoltageInKilowatts) Creates a new instance. -
Method Summary
-
Field Details
-
totalCapacityInKilowattHours
public double totalCapacityInKilowattHoursTotal capacity of the vehicle's battery (in kWh). It must be positive. Defaults to 0. Note: For a user-planned
ChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an invalid parameter error. -
initialChargeInKilowattHours
public double initialChargeInKilowattHoursCharge level of the vehicle's battery at the start of the route (in kWh). It must be non-negative and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0. Note: For a user-plannedChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an an invalid parameter error. -
targetChargeInKilowattHours
public double targetChargeInKilowattHoursMaximum charge to which the battery should be charged at a charging station (in kWh). It must be positive and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0. -
chargingCurve
Function curve describing the maximum battery charging rate (in kW) at a given charge level (in kWh). Map keys represent charge levels that are non-negative floating point values in units of (kWh). Map values represent charging rate values that are positive floating point values in units of (kW). Given charge levels must cover the entire range of [0,
targetChargeInKilowattHours], otherwise theBatterySpecificationsinstance is considered invalid. The charging curve is considered piecewise constant instead of being interpolated. Defaults to an empty container. Note: For a user-plannedChargingStop, this parameter is also required. If one or more values are not set, the route calculation will fail as an invalid parameter error. -
connectorTypes
List of available charging connector types. It must be at least one charging connector type added, otherwise the
BatterySpecificationsinstance is considered invalid. Defaults to an empty container. -
minChargeAtChargingStationInKilowattHours
public double minChargeAtChargingStationInKilowattHoursMinimum charge when arriving at a charging station in kWh. It must be non-negative and less than the value of
targetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0. -
minChargeAtFirstChargingStationInKilowattHours
Minimum charge when arriving at first charging station in kWh. This overrides
minChargeAtChargingStationInKilowattHoursfor the first charging station. If not specified,minChargeAtChargingStationInKilowattHourswill be used for all charging stations, including the first one. Defaults tonull. When initialized, it must be non-negative and less than the value oftargetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. This is usually used when the current charge is too low to reach a charging station withinminChargeAtChargingStationlimits. -
minChargeAtDestinationInKilowattHours
public double minChargeAtDestinationInKilowattHoursMinimum charge at the final route destination in kWh. It must be non-negative and less than the value of
targetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0. -
maxChargingVoltageInVolts
Maximum charging voltage supported by the vehicle's battery in Volts. It must be positive. When omitted, the voltage is determined by the charging station attributes. Defaults to
null. -
maxChargingCurrentInAmperes
Maximum charging current supported by the vehicle's battery in Amperes. It must be positive. When omitted, the charging current is determined by the charging station attributes. Defaults to
null. -
chargingSetupDuration
Time in seconds spent after arriving at a charging station, but before actually charging, e.g., time spent for payment processing. Defaults to 0 seconds.
-
maxPowerAtLowVoltageInKilowatts
The maximum power in kilowatts at which a vehicle can charge under given these conditions:
- The charging station connector's maximum supply voltage is less than 800 V.
maxChargingVoltageInVoltsis greater than or equal to 800 V. The provided value must be greater than or equal to 0. By default, it is not set. Note: The feature is not supported by theOfflineRoutingEngine.
-
-
Constructor Details
-
BatterySpecifications
public BatterySpecifications()Creates a new instance.
-
BatterySpecifications
public BatterySpecifications(double totalCapacityInKilowattHours) Creates a new instance.
- Parameters:
totalCapacityInKilowattHours-Total capacity of the vehicle's battery (in kWh). It must be positive. Defaults to 0. Note: For a user-planned
ChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an invalid parameter error.
-
BatterySpecifications
public BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours) Creates a new instance.
- Parameters:
totalCapacityInKilowattHours-Total capacity of the vehicle's battery (in kWh). It must be positive. Defaults to 0. Note: For a user-planned
ChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an invalid parameter error.initialChargeInKilowattHours-Charge level of the vehicle's battery at the start of the route (in kWh). It must be non-negative and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0. Note: For a user-plannedChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an an invalid parameter error.
-
BatterySpecifications
public BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours, double targetChargeInKilowattHours) Creates a new instance.
- Parameters:
totalCapacityInKilowattHours-Total capacity of the vehicle's battery (in kWh). It must be positive. Defaults to 0. Note: For a user-planned
ChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an invalid parameter error.initialChargeInKilowattHours-Charge level of the vehicle's battery at the start of the route (in kWh). It must be non-negative and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0. Note: For a user-plannedChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an an invalid parameter error.targetChargeInKilowattHours-Maximum charge to which the battery should be charged at a charging station (in kWh). It must be positive and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.
-
BatterySpecifications
public BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours, double targetChargeInKilowattHours, @NonNull Map<Double, Double> chargingCurve) Creates a new instance.
- Parameters:
totalCapacityInKilowattHours-Total capacity of the vehicle's battery (in kWh). It must be positive. Defaults to 0. Note: For a user-planned
ChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an invalid parameter error.initialChargeInKilowattHours-Charge level of the vehicle's battery at the start of the route (in kWh). It must be non-negative and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0. Note: For a user-plannedChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an an invalid parameter error.targetChargeInKilowattHours-Maximum charge to which the battery should be charged at a charging station (in kWh). It must be positive and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.chargingCurve-Function curve describing the maximum battery charging rate (in kW) at a given charge level (in kWh). Map keys represent charge levels that are non-negative floating point values in units of (kWh). Map values represent charging rate values that are positive floating point values in units of (kW). Given charge levels must cover the entire range of [0,
targetChargeInKilowattHours], otherwise theBatterySpecificationsinstance is considered invalid. The charging curve is considered piecewise constant instead of being interpolated. Defaults to an empty container. Note: For a user-plannedChargingStop, this parameter is also required. If one or more values are not set, the route calculation will fail as an invalid parameter error.
-
BatterySpecifications
public BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours, double targetChargeInKilowattHours, @NonNull Map<Double, Double> chargingCurve, @NonNull List<ChargingConnectorType> connectorTypes) Creates a new instance.
- Parameters:
totalCapacityInKilowattHours-Total capacity of the vehicle's battery (in kWh). It must be positive. Defaults to 0. Note: For a user-planned
ChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an invalid parameter error.initialChargeInKilowattHours-Charge level of the vehicle's battery at the start of the route (in kWh). It must be non-negative and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0. Note: For a user-plannedChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an an invalid parameter error.targetChargeInKilowattHours-Maximum charge to which the battery should be charged at a charging station (in kWh). It must be positive and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.chargingCurve-Function curve describing the maximum battery charging rate (in kW) at a given charge level (in kWh). Map keys represent charge levels that are non-negative floating point values in units of (kWh). Map values represent charging rate values that are positive floating point values in units of (kW). Given charge levels must cover the entire range of [0,
targetChargeInKilowattHours], otherwise theBatterySpecificationsinstance is considered invalid. The charging curve is considered piecewise constant instead of being interpolated. Defaults to an empty container. Note: For a user-plannedChargingStop, this parameter is also required. If one or more values are not set, the route calculation will fail as an invalid parameter error.connectorTypes-List of available charging connector types. It must be at least one charging connector type added, otherwise the
BatterySpecificationsinstance is considered invalid. Defaults to an empty container.
-
BatterySpecifications
public BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours, double targetChargeInKilowattHours, @NonNull Map<Double, Double> chargingCurve, @NonNull List<ChargingConnectorType> connectorTypes, double minChargeAtChargingStationInKilowattHours) Creates a new instance.
- Parameters:
totalCapacityInKilowattHours-Total capacity of the vehicle's battery (in kWh). It must be positive. Defaults to 0. Note: For a user-planned
ChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an invalid parameter error.initialChargeInKilowattHours-Charge level of the vehicle's battery at the start of the route (in kWh). It must be non-negative and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0. Note: For a user-plannedChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an an invalid parameter error.targetChargeInKilowattHours-Maximum charge to which the battery should be charged at a charging station (in kWh). It must be positive and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.chargingCurve-Function curve describing the maximum battery charging rate (in kW) at a given charge level (in kWh). Map keys represent charge levels that are non-negative floating point values in units of (kWh). Map values represent charging rate values that are positive floating point values in units of (kW). Given charge levels must cover the entire range of [0,
targetChargeInKilowattHours], otherwise theBatterySpecificationsinstance is considered invalid. The charging curve is considered piecewise constant instead of being interpolated. Defaults to an empty container. Note: For a user-plannedChargingStop, this parameter is also required. If one or more values are not set, the route calculation will fail as an invalid parameter error.connectorTypes-List of available charging connector types. It must be at least one charging connector type added, otherwise the
BatterySpecificationsinstance is considered invalid. Defaults to an empty container.minChargeAtChargingStationInKilowattHours-Minimum charge when arriving at a charging station in kWh. It must be non-negative and less than the value of
targetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.
-
BatterySpecifications
public BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours, double targetChargeInKilowattHours, @NonNull Map<Double, Double> chargingCurve, @NonNull List<ChargingConnectorType> connectorTypes, double minChargeAtChargingStationInKilowattHours, @Nullable Double minChargeAtFirstChargingStationInKilowattHours) Creates a new instance.
- Parameters:
totalCapacityInKilowattHours-Total capacity of the vehicle's battery (in kWh). It must be positive. Defaults to 0. Note: For a user-planned
ChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an invalid parameter error.initialChargeInKilowattHours-Charge level of the vehicle's battery at the start of the route (in kWh). It must be non-negative and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0. Note: For a user-plannedChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an an invalid parameter error.targetChargeInKilowattHours-Maximum charge to which the battery should be charged at a charging station (in kWh). It must be positive and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.chargingCurve-Function curve describing the maximum battery charging rate (in kW) at a given charge level (in kWh). Map keys represent charge levels that are non-negative floating point values in units of (kWh). Map values represent charging rate values that are positive floating point values in units of (kW). Given charge levels must cover the entire range of [0,
targetChargeInKilowattHours], otherwise theBatterySpecificationsinstance is considered invalid. The charging curve is considered piecewise constant instead of being interpolated. Defaults to an empty container. Note: For a user-plannedChargingStop, this parameter is also required. If one or more values are not set, the route calculation will fail as an invalid parameter error.connectorTypes-List of available charging connector types. It must be at least one charging connector type added, otherwise the
BatterySpecificationsinstance is considered invalid. Defaults to an empty container.minChargeAtChargingStationInKilowattHours-Minimum charge when arriving at a charging station in kWh. It must be non-negative and less than the value of
targetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.minChargeAtFirstChargingStationInKilowattHours-Minimum charge when arriving at first charging station in kWh. This overrides
minChargeAtChargingStationInKilowattHoursfor the first charging station. If not specified,minChargeAtChargingStationInKilowattHourswill be used for all charging stations, including the first one. Defaults tonull. When initialized, it must be non-negative and less than the value oftargetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. This is usually used when the current charge is too low to reach a charging station withinminChargeAtChargingStationlimits.
-
BatterySpecifications
public BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours, double targetChargeInKilowattHours, @NonNull Map<Double, Double> chargingCurve, @NonNull List<ChargingConnectorType> connectorTypes, double minChargeAtChargingStationInKilowattHours, @Nullable Double minChargeAtFirstChargingStationInKilowattHours, double minChargeAtDestinationInKilowattHours) Creates a new instance.
- Parameters:
totalCapacityInKilowattHours-Total capacity of the vehicle's battery (in kWh). It must be positive. Defaults to 0. Note: For a user-planned
ChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an invalid parameter error.initialChargeInKilowattHours-Charge level of the vehicle's battery at the start of the route (in kWh). It must be non-negative and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0. Note: For a user-plannedChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an an invalid parameter error.targetChargeInKilowattHours-Maximum charge to which the battery should be charged at a charging station (in kWh). It must be positive and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.chargingCurve-Function curve describing the maximum battery charging rate (in kW) at a given charge level (in kWh). Map keys represent charge levels that are non-negative floating point values in units of (kWh). Map values represent charging rate values that are positive floating point values in units of (kW). Given charge levels must cover the entire range of [0,
targetChargeInKilowattHours], otherwise theBatterySpecificationsinstance is considered invalid. The charging curve is considered piecewise constant instead of being interpolated. Defaults to an empty container. Note: For a user-plannedChargingStop, this parameter is also required. If one or more values are not set, the route calculation will fail as an invalid parameter error.connectorTypes-List of available charging connector types. It must be at least one charging connector type added, otherwise the
BatterySpecificationsinstance is considered invalid. Defaults to an empty container.minChargeAtChargingStationInKilowattHours-Minimum charge when arriving at a charging station in kWh. It must be non-negative and less than the value of
targetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.minChargeAtFirstChargingStationInKilowattHours-Minimum charge when arriving at first charging station in kWh. This overrides
minChargeAtChargingStationInKilowattHoursfor the first charging station. If not specified,minChargeAtChargingStationInKilowattHourswill be used for all charging stations, including the first one. Defaults tonull. When initialized, it must be non-negative and less than the value oftargetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. This is usually used when the current charge is too low to reach a charging station withinminChargeAtChargingStationlimits.minChargeAtDestinationInKilowattHours-Minimum charge at the final route destination in kWh. It must be non-negative and less than the value of
targetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.
-
BatterySpecifications
public BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours, double targetChargeInKilowattHours, @NonNull Map<Double, Double> chargingCurve, @NonNull List<ChargingConnectorType> connectorTypes, double minChargeAtChargingStationInKilowattHours, @Nullable Double minChargeAtFirstChargingStationInKilowattHours, double minChargeAtDestinationInKilowattHours, @Nullable Double maxChargingVoltageInVolts) Creates a new instance.
- Parameters:
totalCapacityInKilowattHours-Total capacity of the vehicle's battery (in kWh). It must be positive. Defaults to 0. Note: For a user-planned
ChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an invalid parameter error.initialChargeInKilowattHours-Charge level of the vehicle's battery at the start of the route (in kWh). It must be non-negative and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0. Note: For a user-plannedChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an an invalid parameter error.targetChargeInKilowattHours-Maximum charge to which the battery should be charged at a charging station (in kWh). It must be positive and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.chargingCurve-Function curve describing the maximum battery charging rate (in kW) at a given charge level (in kWh). Map keys represent charge levels that are non-negative floating point values in units of (kWh). Map values represent charging rate values that are positive floating point values in units of (kW). Given charge levels must cover the entire range of [0,
targetChargeInKilowattHours], otherwise theBatterySpecificationsinstance is considered invalid. The charging curve is considered piecewise constant instead of being interpolated. Defaults to an empty container. Note: For a user-plannedChargingStop, this parameter is also required. If one or more values are not set, the route calculation will fail as an invalid parameter error.connectorTypes-List of available charging connector types. It must be at least one charging connector type added, otherwise the
BatterySpecificationsinstance is considered invalid. Defaults to an empty container.minChargeAtChargingStationInKilowattHours-Minimum charge when arriving at a charging station in kWh. It must be non-negative and less than the value of
targetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.minChargeAtFirstChargingStationInKilowattHours-Minimum charge when arriving at first charging station in kWh. This overrides
minChargeAtChargingStationInKilowattHoursfor the first charging station. If not specified,minChargeAtChargingStationInKilowattHourswill be used for all charging stations, including the first one. Defaults tonull. When initialized, it must be non-negative and less than the value oftargetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. This is usually used when the current charge is too low to reach a charging station withinminChargeAtChargingStationlimits.minChargeAtDestinationInKilowattHours-Minimum charge at the final route destination in kWh. It must be non-negative and less than the value of
targetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.maxChargingVoltageInVolts-Maximum charging voltage supported by the vehicle's battery in Volts. It must be positive. When omitted, the voltage is determined by the charging station attributes. Defaults to
null.
-
BatterySpecifications
public BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours, double targetChargeInKilowattHours, @NonNull Map<Double, Double> chargingCurve, @NonNull List<ChargingConnectorType> connectorTypes, double minChargeAtChargingStationInKilowattHours, @Nullable Double minChargeAtFirstChargingStationInKilowattHours, double minChargeAtDestinationInKilowattHours, @Nullable Double maxChargingVoltageInVolts, @Nullable Double maxChargingCurrentInAmperes) Creates a new instance.
- Parameters:
totalCapacityInKilowattHours-Total capacity of the vehicle's battery (in kWh). It must be positive. Defaults to 0. Note: For a user-planned
ChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an invalid parameter error.initialChargeInKilowattHours-Charge level of the vehicle's battery at the start of the route (in kWh). It must be non-negative and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0. Note: For a user-plannedChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an an invalid parameter error.targetChargeInKilowattHours-Maximum charge to which the battery should be charged at a charging station (in kWh). It must be positive and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.chargingCurve-Function curve describing the maximum battery charging rate (in kW) at a given charge level (in kWh). Map keys represent charge levels that are non-negative floating point values in units of (kWh). Map values represent charging rate values that are positive floating point values in units of (kW). Given charge levels must cover the entire range of [0,
targetChargeInKilowattHours], otherwise theBatterySpecificationsinstance is considered invalid. The charging curve is considered piecewise constant instead of being interpolated. Defaults to an empty container. Note: For a user-plannedChargingStop, this parameter is also required. If one or more values are not set, the route calculation will fail as an invalid parameter error.connectorTypes-List of available charging connector types. It must be at least one charging connector type added, otherwise the
BatterySpecificationsinstance is considered invalid. Defaults to an empty container.minChargeAtChargingStationInKilowattHours-Minimum charge when arriving at a charging station in kWh. It must be non-negative and less than the value of
targetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.minChargeAtFirstChargingStationInKilowattHours-Minimum charge when arriving at first charging station in kWh. This overrides
minChargeAtChargingStationInKilowattHoursfor the first charging station. If not specified,minChargeAtChargingStationInKilowattHourswill be used for all charging stations, including the first one. Defaults tonull. When initialized, it must be non-negative and less than the value oftargetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. This is usually used when the current charge is too low to reach a charging station withinminChargeAtChargingStationlimits.minChargeAtDestinationInKilowattHours-Minimum charge at the final route destination in kWh. It must be non-negative and less than the value of
targetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.maxChargingVoltageInVolts-Maximum charging voltage supported by the vehicle's battery in Volts. It must be positive. When omitted, the voltage is determined by the charging station attributes. Defaults to
null.maxChargingCurrentInAmperes-Maximum charging current supported by the vehicle's battery in Amperes. It must be positive. When omitted, the charging current is determined by the charging station attributes. Defaults to
null.
-
BatterySpecifications
public BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours, double targetChargeInKilowattHours, @NonNull Map<Double, Double> chargingCurve, @NonNull List<ChargingConnectorType> connectorTypes, double minChargeAtChargingStationInKilowattHours, @Nullable Double minChargeAtFirstChargingStationInKilowattHours, double minChargeAtDestinationInKilowattHours, @Nullable Double maxChargingVoltageInVolts, @Nullable Double maxChargingCurrentInAmperes, @NonNull Duration chargingSetupDuration) Creates a new instance.
- Parameters:
totalCapacityInKilowattHours-Total capacity of the vehicle's battery (in kWh). It must be positive. Defaults to 0. Note: For a user-planned
ChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an invalid parameter error.initialChargeInKilowattHours-Charge level of the vehicle's battery at the start of the route (in kWh). It must be non-negative and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0. Note: For a user-plannedChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an an invalid parameter error.targetChargeInKilowattHours-Maximum charge to which the battery should be charged at a charging station (in kWh). It must be positive and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.chargingCurve-Function curve describing the maximum battery charging rate (in kW) at a given charge level (in kWh). Map keys represent charge levels that are non-negative floating point values in units of (kWh). Map values represent charging rate values that are positive floating point values in units of (kW). Given charge levels must cover the entire range of [0,
targetChargeInKilowattHours], otherwise theBatterySpecificationsinstance is considered invalid. The charging curve is considered piecewise constant instead of being interpolated. Defaults to an empty container. Note: For a user-plannedChargingStop, this parameter is also required. If one or more values are not set, the route calculation will fail as an invalid parameter error.connectorTypes-List of available charging connector types. It must be at least one charging connector type added, otherwise the
BatterySpecificationsinstance is considered invalid. Defaults to an empty container.minChargeAtChargingStationInKilowattHours-Minimum charge when arriving at a charging station in kWh. It must be non-negative and less than the value of
targetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.minChargeAtFirstChargingStationInKilowattHours-Minimum charge when arriving at first charging station in kWh. This overrides
minChargeAtChargingStationInKilowattHoursfor the first charging station. If not specified,minChargeAtChargingStationInKilowattHourswill be used for all charging stations, including the first one. Defaults tonull. When initialized, it must be non-negative and less than the value oftargetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. This is usually used when the current charge is too low to reach a charging station withinminChargeAtChargingStationlimits.minChargeAtDestinationInKilowattHours-Minimum charge at the final route destination in kWh. It must be non-negative and less than the value of
targetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.maxChargingVoltageInVolts-Maximum charging voltage supported by the vehicle's battery in Volts. It must be positive. When omitted, the voltage is determined by the charging station attributes. Defaults to
null.maxChargingCurrentInAmperes-Maximum charging current supported by the vehicle's battery in Amperes. It must be positive. When omitted, the charging current is determined by the charging station attributes. Defaults to
null.chargingSetupDuration-Time in seconds spent after arriving at a charging station, but before actually charging, e.g., time spent for payment processing. Defaults to 0 seconds.
-
BatterySpecifications
public BatterySpecifications(double totalCapacityInKilowattHours, double initialChargeInKilowattHours, double targetChargeInKilowattHours, @NonNull Map<Double, Double> chargingCurve, @NonNull List<ChargingConnectorType> connectorTypes, double minChargeAtChargingStationInKilowattHours, @Nullable Double minChargeAtFirstChargingStationInKilowattHours, double minChargeAtDestinationInKilowattHours, @Nullable Double maxChargingVoltageInVolts, @Nullable Double maxChargingCurrentInAmperes, @NonNull Duration chargingSetupDuration, @Nullable Double maxPowerAtLowVoltageInKilowatts) Creates a new instance.
- Parameters:
totalCapacityInKilowattHours-Total capacity of the vehicle's battery (in kWh). It must be positive. Defaults to 0. Note: For a user-planned
ChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an invalid parameter error.initialChargeInKilowattHours-Charge level of the vehicle's battery at the start of the route (in kWh). It must be non-negative and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0. Note: For a user-plannedChargingStop, this parameter is also required. If not set greater than 0, the route calculation will fail as an an invalid parameter error.targetChargeInKilowattHours-Maximum charge to which the battery should be charged at a charging station (in kWh). It must be positive and less than or equal to the value of
totalCapacityInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.chargingCurve-Function curve describing the maximum battery charging rate (in kW) at a given charge level (in kWh). Map keys represent charge levels that are non-negative floating point values in units of (kWh). Map values represent charging rate values that are positive floating point values in units of (kW). Given charge levels must cover the entire range of [0,
targetChargeInKilowattHours], otherwise theBatterySpecificationsinstance is considered invalid. The charging curve is considered piecewise constant instead of being interpolated. Defaults to an empty container. Note: For a user-plannedChargingStop, this parameter is also required. If one or more values are not set, the route calculation will fail as an invalid parameter error.connectorTypes-List of available charging connector types. It must be at least one charging connector type added, otherwise the
BatterySpecificationsinstance is considered invalid. Defaults to an empty container.minChargeAtChargingStationInKilowattHours-Minimum charge when arriving at a charging station in kWh. It must be non-negative and less than the value of
targetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.minChargeAtFirstChargingStationInKilowattHours-Minimum charge when arriving at first charging station in kWh. This overrides
minChargeAtChargingStationInKilowattHoursfor the first charging station. If not specified,minChargeAtChargingStationInKilowattHourswill be used for all charging stations, including the first one. Defaults tonull. When initialized, it must be non-negative and less than the value oftargetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. This is usually used when the current charge is too low to reach a charging station withinminChargeAtChargingStationlimits.minChargeAtDestinationInKilowattHours-Minimum charge at the final route destination in kWh. It must be non-negative and less than the value of
targetChargeInKilowattHours, otherwise theBatterySpecificationsinstance is considered invalid. Defaults to 0.maxChargingVoltageInVolts-Maximum charging voltage supported by the vehicle's battery in Volts. It must be positive. When omitted, the voltage is determined by the charging station attributes. Defaults to
null.maxChargingCurrentInAmperes-Maximum charging current supported by the vehicle's battery in Amperes. It must be positive. When omitted, the charging current is determined by the charging station attributes. Defaults to
null.chargingSetupDuration-Time in seconds spent after arriving at a charging station, but before actually charging, e.g., time spent for payment processing. Defaults to 0 seconds.
maxPowerAtLowVoltageInKilowatts-The maximum power in kilowatts at which a vehicle can charge under given these conditions:
- The charging station connector's maximum supply voltage is less than 800 V.
maxChargingVoltageInVoltsis greater than or equal to 800 V. The provided value must be greater than or equal to 0. By default, it is not set. Note: The feature is not supported by theOfflineRoutingEngine.
-
-
Method Details