Package com.highmobility.autoapi

Class Charging.State.Builder

java.lang.Object
com.highmobility.autoapi.SetCommand.Builder<Charging.State.Builder>
com.highmobility.autoapi.Charging.State.Builder
Enclosing class:
Charging.State
public static final class Charging.State.Builder extends SetCommand.Builder<Charging.State.Builder>

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public Charging.State build()
      Overrides:
      build in class SetCommand.Builder<Charging.State.Builder>

    • setEstimatedRange

      public Charging.State.Builder setEstimatedRange(Property<com.highmobility.autoapi.value.measurement.Length> estimatedRange)
      Parameters:
      estimatedRange - Estimated range
      Returns:
      The builder

    • setBatteryLevel

      public Charging.State.Builder setBatteryLevel(Property<Double> batteryLevel)
      Parameters:
      batteryLevel - Battery level percentage between 0.0-1.0
      Returns:
      The builder

    • setBatteryCurrentAC

      @Deprecated public Charging.State.Builder setBatteryCurrentAC(Property<com.highmobility.autoapi.value.measurement.ElectricCurrent> batteryCurrentAC)
      Deprecated.
      moved AC/DC distinction into a separate property. Replaced by Charging.State.getBatteryCurrent()
      Parameters:
      batteryCurrentAC - Battery alternating current
      Returns:
      The builder

    • setBatteryCurrentDC

      @Deprecated public Charging.State.Builder setBatteryCurrentDC(Property<com.highmobility.autoapi.value.measurement.ElectricCurrent> batteryCurrentDC)
      Deprecated.
      moved AC/DC distinction into a separate property. Replaced by Charging.State.getBatteryCurrent()
      Parameters:
      batteryCurrentDC - Battery direct current
      Returns:
      The builder

    • setChargerVoltageAC

      @Deprecated public Charging.State.Builder setChargerVoltageAC(Property<com.highmobility.autoapi.value.measurement.ElectricPotentialDifference> chargerVoltageAC)
      Deprecated.
      moved AC/DC distinction into a separate property. Replaced by Charging.State.getChargerVoltage()
      Parameters:
      chargerVoltageAC - Charger voltage for alternating current
      Returns:
      The builder

    • setChargerVoltageDC

      @Deprecated public Charging.State.Builder setChargerVoltageDC(Property<com.highmobility.autoapi.value.measurement.ElectricPotentialDifference> chargerVoltageDC)
      Deprecated.
      moved AC/DC distinction into a separate property. Replaced by Charging.State.getChargerVoltage()
      Parameters:
      chargerVoltageDC - Charger voltage for direct current
      Returns:
      The builder

    • setChargeLimit

      public Charging.State.Builder setChargeLimit(Property<Double> chargeLimit)
      Parameters:
      chargeLimit - Charge limit percentage between 0.0-1.0
      Returns:
      The builder

    • setTimeToCompleteCharge

      public Charging.State.Builder setTimeToCompleteCharge(Property<com.highmobility.autoapi.value.measurement.Duration> timeToCompleteCharge)
      Parameters:
      timeToCompleteCharge - Time until charging completed
      Returns:
      The builder

    • setChargingRateKW

      @Deprecated public Charging.State.Builder setChargingRateKW(Property<com.highmobility.autoapi.value.measurement.Power> chargingRateKW)
      Deprecated.
      removed the unit from the name. Replaced by Charging.State.getChargingRate()
      Parameters:
      chargingRateKW - Charging rate
      Returns:
      The builder

    • setChargePortState

      public Charging.State.Builder setChargePortState(Property<Position> chargePortState)
      Parameters:
      chargePortState - The charge port state
      Returns:
      The builder

    • setChargeMode

      public Charging.State.Builder setChargeMode(Property<Charging.ChargeMode> chargeMode)
      Parameters:
      chargeMode - The charge mode
      Returns:
      The builder

    • setMaxChargingCurrent

      public Charging.State.Builder setMaxChargingCurrent(Property<com.highmobility.autoapi.value.measurement.ElectricCurrent> maxChargingCurrent)
      Parameters:
      maxChargingCurrent - Maximum charging current
      Returns:
      The builder

    • setPlugType

      public Charging.State.Builder setPlugType(Property<Charging.PlugType> plugType)
      Parameters:
      plugType - The plug type
      Returns:
      The builder

    • setChargingWindowChosen

      public Charging.State.Builder setChargingWindowChosen(Property<Charging.ChargingWindowChosen> chargingWindowChosen)
      Parameters:
      chargingWindowChosen - The charging window chosen
      Returns:
      The builder

    • setDepartureTimes

      public Charging.State.Builder setDepartureTimes(Property<DepartureTime>[] departureTimes)
      Add an array of departure times
      Parameters:
      departureTimes - The departure times
      Returns:
      The builder

    • addDepartureTime

      public Charging.State.Builder addDepartureTime(Property<DepartureTime> departureTime)
      Add a single departure time
      Parameters:
      departureTime - The departure time
      Returns:
      The builder

    • setReductionTimes

      public Charging.State.Builder setReductionTimes(Property<ReductionTime>[] reductionTimes)
      Add an array of reduction times
      Parameters:
      reductionTimes - The reduction times
      Returns:
      The builder

    • addReductionTime

      public Charging.State.Builder addReductionTime(Property<ReductionTime> reductionTime)
      Add a single reduction time
      Parameters:
      reductionTime - The reduction time
      Returns:
      The builder

    • setBatteryTemperature

      public Charging.State.Builder setBatteryTemperature(Property<com.highmobility.autoapi.value.measurement.Temperature> batteryTemperature)
      Parameters:
      batteryTemperature - Battery temperature
      Returns:
      The builder

    • setTimers

      public Charging.State.Builder setTimers(Property<Timer>[] timers)
      Add an array of timers
      Parameters:
      timers - The timers
      Returns:
      The builder

    • addTimer

      public Charging.State.Builder addTimer(Property<Timer> timer)
      Add a single timer
      Parameters:
      timer - The timer
      Returns:
      The builder

    • setPluggedIn

      public Charging.State.Builder setPluggedIn(Property<Charging.PluggedIn> pluggedIn)
      Parameters:
      pluggedIn - The plugged in
      Returns:
      The builder

    • setStatus

      public Charging.State.Builder setStatus(Property<Charging.Status> status)
      Parameters:
      status - The status
      Returns:
      The builder

    • setChargingRate

      public Charging.State.Builder setChargingRate(Property<com.highmobility.autoapi.value.measurement.Power> chargingRate)
      Parameters:
      chargingRate - Charge rate when charging
      Returns:
      The builder

    • setBatteryCurrent

      public Charging.State.Builder setBatteryCurrent(Property<com.highmobility.autoapi.value.measurement.ElectricCurrent> batteryCurrent)
      Parameters:
      batteryCurrent - Battery current - charging if posititive and discharning when negative.
      Returns:
      The builder

    • setChargerVoltage

      public Charging.State.Builder setChargerVoltage(Property<com.highmobility.autoapi.value.measurement.ElectricPotentialDifference> chargerVoltage)
      Parameters:
      chargerVoltage - Charger voltage
      Returns:
      The builder

    • setCurrentType

      public Charging.State.Builder setCurrentType(Property<Charging.CurrentType> currentType)
      Parameters:
      currentType - Type of current in use
      Returns:
      The builder

    • setMaxRange

      public Charging.State.Builder setMaxRange(Property<com.highmobility.autoapi.value.measurement.Length> maxRange)
      Parameters:
      maxRange - Maximum electric range with 100% of battery
      Returns:
      The builder

    • setStarterBatteryState

      public Charging.State.Builder setStarterBatteryState(Property<Charging.StarterBatteryState> starterBatteryState)
      Parameters:
      starterBatteryState - State of the starter battery
      Returns:
      The builder

    • setSmartChargingStatus

      public Charging.State.Builder setSmartChargingStatus(Property<Charging.SmartChargingStatus> smartChargingStatus)
      Parameters:
      smartChargingStatus - Status of optimized/intelligent charging
      Returns:
      The builder

    • setBatteryLevelAtDeparture

      public Charging.State.Builder setBatteryLevelAtDeparture(Property<Double> batteryLevelAtDeparture)
      Parameters:
      batteryLevelAtDeparture - Battery charge level expected at time of departure
      Returns:
      The builder

    • setPreconditioningDepartureStatus

      public Charging.State.Builder setPreconditioningDepartureStatus(Property<ActiveState> preconditioningDepartureStatus)
      Parameters:
      preconditioningDepartureStatus - Status of preconditioning at departure time
      Returns:
      The builder

    • setPreconditioningImmediateStatus

      public Charging.State.Builder setPreconditioningImmediateStatus(Property<ActiveState> preconditioningImmediateStatus)
      Parameters:
      preconditioningImmediateStatus - Status of immediate preconditioning
      Returns:
      The builder

    • setPreconditioningDepartureEnabled

      public Charging.State.Builder setPreconditioningDepartureEnabled(Property<EnabledState> preconditioningDepartureEnabled)
      Parameters:
      preconditioningDepartureEnabled - Preconditioning activation status at departure
      Returns:
      The builder

    • setPreconditioningError

      public Charging.State.Builder setPreconditioningError(Property<Charging.PreconditioningError> preconditioningError)
      Parameters:
      preconditioningError - Preconditioning error if one is encountered
      Returns:
      The builder

    • setBatteryCapacity

      public Charging.State.Builder setBatteryCapacity(Property<com.highmobility.autoapi.value.measurement.Energy> batteryCapacity)
      Parameters:
      batteryCapacity - Indicates the battery capacity
      Returns:
      The builder

    • setAuxiliaryPower

      public Charging.State.Builder setAuxiliaryPower(Property<com.highmobility.autoapi.value.measurement.Power> auxiliaryPower)
      Parameters:
      auxiliaryPower - Auxiliary power used for predictions.
      Returns:
      The builder

    • setChargingCompleteLock

      public Charging.State.Builder setChargingCompleteLock(Property<ActiveState> chargingCompleteLock)
      Parameters:
      chargingCompleteLock - Locking status of the charging plug after charging complete.
      Returns:
      The builder

    • setBatteryMaxAvailable

      public Charging.State.Builder setBatteryMaxAvailable(Property<com.highmobility.autoapi.value.measurement.Energy> batteryMaxAvailable)
      Parameters:
      batteryMaxAvailable - Maximum available energy content of the high-voltage battery.
      Returns:
      The builder

    • setChargingEndReason

      public Charging.State.Builder setChargingEndReason(Property<Charging.ChargingEndReason> chargingEndReason)
      Parameters:
      chargingEndReason - Reason for ending a charging process.
      Returns:
      The builder

    • setChargingPhases

      public Charging.State.Builder setChargingPhases(Property<Charging.ChargingPhases> chargingPhases)
      Parameters:
      chargingPhases - Charging process count of the high-voltage battery (phases).
      Returns:
      The builder

    • setBatteryEnergy

      public Charging.State.Builder setBatteryEnergy(Property<com.highmobility.autoapi.value.measurement.Energy> batteryEnergy)
      Parameters:
      batteryEnergy - Energy content of the high-voltage battery.
      Returns:
      The builder

    • setBatteryEnergyChargable

      public Charging.State.Builder setBatteryEnergyChargable(Property<com.highmobility.autoapi.value.measurement.Energy> batteryEnergyChargable)
      Parameters:
      batteryEnergyChargable - Energy required until high-voltage battery is fully charged.
      Returns:
      The builder

    • setChargingSingleImmediate

      public Charging.State.Builder setChargingSingleImmediate(Property<ActiveState> chargingSingleImmediate)
      Parameters:
      chargingSingleImmediate - Single instant charging function status.
      Returns:
      The builder

    • setChargingTimeDisplay

      public Charging.State.Builder setChargingTimeDisplay(Property<Charging.ChargingTimeDisplay> chargingTimeDisplay)
      Parameters:
      chargingTimeDisplay - Charging time displayed in the vehicle.
      Returns:
      The builder

    • setDepartureTimeDisplay

      public Charging.State.Builder setDepartureTimeDisplay(Property<Charging.DepartureTimeDisplay> departureTimeDisplay)
      Parameters:
      departureTimeDisplay - Departure time displayed in the vehicle.
      Returns:
      The builder

    • setRestriction

      public Charging.State.Builder setRestriction(Property<ChargingRestriction> restriction)
      Parameters:
      restriction - Charging limit and state
      Returns:
      The builder

    • setLimitStatus

      public Charging.State.Builder setLimitStatus(Property<ActiveState> limitStatus)
      Parameters:
      limitStatus - Indicates whether charging limit is active.
      Returns:
      The builder

    • setCurrentLimit

      public Charging.State.Builder setCurrentLimit(Property<com.highmobility.autoapi.value.measurement.ElectricCurrent> currentLimit)
      Parameters:
      currentLimit - Limit for the charging current.
      Returns:
      The builder

    • setSmartChargingOption

      public Charging.State.Builder setSmartChargingOption(Property<Charging.SmartChargingOption> smartChargingOption)
      Parameters:
      smartChargingOption - Smart charging option being used to charge with.
      Returns:
      The builder

    • setPlugLockStatus

      public Charging.State.Builder setPlugLockStatus(Property<LockState> plugLockStatus)
      Parameters:
      plugLockStatus - Locking status of charging plug.
      Returns:
      The builder

    • setFlapLockStatus

      public Charging.State.Builder setFlapLockStatus(Property<LockState> flapLockStatus)
      Parameters:
      flapLockStatus - Locking status of charging flap.
      Returns:
      The builder

    • setAcousticLimit

      public Charging.State.Builder setAcousticLimit(Property<Charging.AcousticLimit> acousticLimit)
      Parameters:
      acousticLimit - Acoustic limitation of charging process.
      Returns:
      The builder

    • setMinChargingCurrent

      public Charging.State.Builder setMinChargingCurrent(Property<com.highmobility.autoapi.value.measurement.ElectricCurrent> minChargingCurrent)
      Parameters:
      minChargingCurrent - Minimum charging current.
      Returns:
      The builder

    • setEstimatedRangeTarget

      public Charging.State.Builder setEstimatedRangeTarget(Property<com.highmobility.autoapi.value.measurement.Length> estimatedRangeTarget)
      Parameters:
      estimatedRangeTarget - Remaining electric range depending on target charging status.
      Returns:
      The builder

    • setFullyChargedEndTimes

      public Charging.State.Builder setFullyChargedEndTimes(Property<WeekdayTime> fullyChargedEndTimes)
      Parameters:
      fullyChargedEndTimes - Time and weekday when the vehicle will be fully charged.
      Returns:
      The builder

    • setPreconditioningScheduledTime

      public Charging.State.Builder setPreconditioningScheduledTime(Property<Time> preconditioningScheduledTime)
      Parameters:
      preconditioningScheduledTime - Preconditioning scheduled departure time.
      Returns:
      The builder

    • setPreconditioningRemainingTime

      public Charging.State.Builder setPreconditioningRemainingTime(Property<com.highmobility.autoapi.value.measurement.Duration> preconditioningRemainingTime)
      Parameters:
      preconditioningRemainingTime - Time until preconditioning is complete.
      Returns:
      The builder

    • setBatteryVoltage

      public Charging.State.Builder setBatteryVoltage(Property<com.highmobility.autoapi.value.measurement.ElectricPotentialDifference> batteryVoltage)
      Parameters:
      batteryVoltage - High-voltage battery electric potential difference (aka voltage).
      Returns:
      The builder

    • setBatteryTempretatureExtremes

      @Deprecated public Charging.State.Builder setBatteryTempretatureExtremes(Property<TemperatureExtreme> batteryTempretatureExtremes)
      Deprecated.
      fixed the name typo. Replaced by Charging.State.getBatteryTemperatureExtremes()
      Parameters:
      batteryTempretatureExtremes - Current highest-lowest temperature inside the battery.
      Returns:
      The builder

    • setBatteryTemperatureControlDemand

      public Charging.State.Builder setBatteryTemperatureControlDemand(Property<Charging.BatteryTemperatureControlDemand> batteryTemperatureControlDemand)
      Parameters:
      batteryTemperatureControlDemand - Current demand of HV battery temperature control system.
      Returns:
      The builder

    • setChargingCurrent

      public Charging.State.Builder setChargingCurrent(Property<com.highmobility.autoapi.value.measurement.ElectricCurrent> chargingCurrent)
      Parameters:
      chargingCurrent - Charging electric current.
      Returns:
      The builder

    • setBatteryStatus

      public Charging.State.Builder setBatteryStatus(Property<Charging.BatteryStatus> batteryStatus)
      Parameters:
      batteryStatus - Battery state.
      Returns:
      The builder

    • setBatteryLed

      public Charging.State.Builder setBatteryLed(Property<Charging.BatteryLed> batteryLed)
      Parameters:
      batteryLed - State of LED for the battery.
      Returns:
      The builder

    • setBatteryCoolingTemperature

      public Charging.State.Builder setBatteryCoolingTemperature(Property<com.highmobility.autoapi.value.measurement.Temperature> batteryCoolingTemperature)
      Parameters:
      batteryCoolingTemperature - Battery cooling temperature.
      Returns:
      The builder

    • setBatteryTemperatureExtremes

      public Charging.State.Builder setBatteryTemperatureExtremes(Property<TemperatureExtreme> batteryTemperatureExtremes)
      Parameters:
      batteryTemperatureExtremes - Current highest-lowest temperature inside the battery.
      Returns:
      The builder

    • setDrivingModePHEV

      public Charging.State.Builder setDrivingModePHEV(Property<DrivingModePhev> drivingModePHEV)
      Parameters:
      drivingModePHEV - Indicates the current driving mode for Plug-In Hybrid Vehicle.
      Returns:
      The builder

    • setBatteryChargeType

      public Charging.State.Builder setBatteryChargeType(Property<Charging.BatteryChargeType> batteryChargeType)
      Parameters:
      batteryChargeType - Battery charge type.
      Returns:
      The builder

    • setDistanceToCompleteCharge

      public Charging.State.Builder setDistanceToCompleteCharge(Property<com.highmobility.autoapi.value.measurement.Length> distanceToCompleteCharge)
      Parameters:
      distanceToCompleteCharge - Distance until charging completed
      Returns:
      The builder