Package com.highmobility.autoapi

Class Diagnostics.State.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

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

    • setMileage

      @Deprecated public Diagnostics.State.Builder setMileage(Property<com.highmobility.autoapi.value.measurement.Length> mileage)
      Deprecated.
      'mileage' is an incorrect term for this. Replaced by Diagnostics.State.getOdometer()
      Parameters:
      mileage - The vehicle mileage (odometer)
      Returns:
      The builder

    • setEngineOilTemperature

      public Diagnostics.State.Builder setEngineOilTemperature(Property<com.highmobility.autoapi.value.measurement.Temperature> engineOilTemperature)
      Parameters:
      engineOilTemperature - Engine oil temperature
      Returns:
      The builder

    • setSpeed

      public Diagnostics.State.Builder setSpeed(Property<com.highmobility.autoapi.value.measurement.Speed> speed)
      Parameters:
      speed - The vehicle speed
      Returns:
      The builder

    • setEngineRPM

      public Diagnostics.State.Builder setEngineRPM(Property<com.highmobility.autoapi.value.measurement.AngularVelocity> engineRPM)
      Parameters:
      engineRPM - Engine RPM (revolutions per minute)
      Returns:
      The builder

    • setFuelLevel

      public Diagnostics.State.Builder setFuelLevel(Property<Double> fuelLevel)
      Parameters:
      fuelLevel - Fuel level percentage between 0.0-1.0
      Returns:
      The builder

    • setEstimatedRange

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

    • setWasherFluidLevel

      public Diagnostics.State.Builder setWasherFluidLevel(Property<FluidLevel> washerFluidLevel)
      Parameters:
      washerFluidLevel - The washer fluid level
      Returns:
      The builder

    • setBatteryVoltage

      public Diagnostics.State.Builder setBatteryVoltage(Property<com.highmobility.autoapi.value.measurement.ElectricPotentialDifference> batteryVoltage)
      Parameters:
      batteryVoltage - Battery voltage
      Returns:
      The builder

    • setAdBlueLevel

      public Diagnostics.State.Builder setAdBlueLevel(Property<Double> adBlueLevel)
      Parameters:
      adBlueLevel - AdBlue level percentage between 0.0-1.0
      Returns:
      The builder

    • setDistanceSinceReset

      public Diagnostics.State.Builder setDistanceSinceReset(Property<com.highmobility.autoapi.value.measurement.Length> distanceSinceReset)
      Parameters:
      distanceSinceReset - The distance driven since reset
      Returns:
      The builder

    • setDistanceSinceStart

      public Diagnostics.State.Builder setDistanceSinceStart(Property<com.highmobility.autoapi.value.measurement.Length> distanceSinceStart)
      Parameters:
      distanceSinceStart - The distance driven since trip start
      Returns:
      The builder

    • setFuelVolume

      public Diagnostics.State.Builder setFuelVolume(Property<com.highmobility.autoapi.value.measurement.Volume> fuelVolume)
      Parameters:
      fuelVolume - The fuel volume measured in liters
      Returns:
      The builder

    • setAntiLockBraking

      public Diagnostics.State.Builder setAntiLockBraking(Property<ActiveState> antiLockBraking)
      Parameters:
      antiLockBraking - The anti lock braking
      Returns:
      The builder

    • setEngineCoolantTemperature

      public Diagnostics.State.Builder setEngineCoolantTemperature(Property<com.highmobility.autoapi.value.measurement.Temperature> engineCoolantTemperature)
      Parameters:
      engineCoolantTemperature - Engine coolant temperature
      Returns:
      The builder

    • setEngineTotalOperatingHours

      @Deprecated public Diagnostics.State.Builder setEngineTotalOperatingHours(Property<com.highmobility.autoapi.value.measurement.Duration> engineTotalOperatingHours)
      Deprecated.
      removed the unit from the name. Replaced by Diagnostics.State.getEngineTotalOperatingTime()
      Parameters:
      engineTotalOperatingHours - The accumulated time of engine operation
      Returns:
      The builder

    • setEngineTotalFuelConsumption

      public Diagnostics.State.Builder setEngineTotalFuelConsumption(Property<com.highmobility.autoapi.value.measurement.Volume> engineTotalFuelConsumption)
      Parameters:
      engineTotalFuelConsumption - The accumulated lifespan fuel consumption
      Returns:
      The builder

    • setBrakeFluidLevel

      public Diagnostics.State.Builder setBrakeFluidLevel(Property<FluidLevel> brakeFluidLevel)
      Parameters:
      brakeFluidLevel - The brake fluid level
      Returns:
      The builder

    • setEngineTorque

      public Diagnostics.State.Builder setEngineTorque(Property<Double> engineTorque)
      Parameters:
      engineTorque - Current engine torque percentage between 0.0-1.0
      Returns:
      The builder

    • setEngineLoad

      public Diagnostics.State.Builder setEngineLoad(Property<Double> engineLoad)
      Parameters:
      engineLoad - Current engine load percentage between 0.0-1.0
      Returns:
      The builder

    • setWheelBasedSpeed

      public Diagnostics.State.Builder setWheelBasedSpeed(Property<com.highmobility.autoapi.value.measurement.Speed> wheelBasedSpeed)
      Parameters:
      wheelBasedSpeed - The vehicle speed measured at the wheel base
      Returns:
      The builder

    • setBatteryLevel

      public Diagnostics.State.Builder setBatteryLevel(Property<Double> batteryLevel)
      Parameters:
      batteryLevel - Battery level in %, value between 0.0 and 1.0
      Returns:
      The builder

    • setCheckControlMessages

      public Diagnostics.State.Builder setCheckControlMessages(Property<CheckControlMessage>[] checkControlMessages)
      Add an array of check control messages
      Parameters:
      checkControlMessages - The check control messages
      Returns:
      The builder

    • addCheckControlMessage

      public Diagnostics.State.Builder addCheckControlMessage(Property<CheckControlMessage> checkControlMessage)
      Add a single check control message
      Parameters:
      checkControlMessage - The check control message
      Returns:
      The builder

    • setTirePressures

      public Diagnostics.State.Builder setTirePressures(Property<TirePressure>[] tirePressures)
      Add an array of tire pressures
      Parameters:
      tirePressures - The tire pressures
      Returns:
      The builder

    • addTirePressure

      public Diagnostics.State.Builder addTirePressure(Property<TirePressure> tirePressure)
      Add a single tire pressure
      Parameters:
      tirePressure - The tire pressure
      Returns:
      The builder

    • setTireTemperatures

      public Diagnostics.State.Builder setTireTemperatures(Property<TireTemperature>[] tireTemperatures)
      Add an array of tire temperatures
      Parameters:
      tireTemperatures - The tire temperatures
      Returns:
      The builder

    • addTireTemperature

      public Diagnostics.State.Builder addTireTemperature(Property<TireTemperature> tireTemperature)
      Add a single tire temperature
      Parameters:
      tireTemperature - The tire temperature
      Returns:
      The builder

    • setWheelRPMs

      public Diagnostics.State.Builder setWheelRPMs(Property<WheelRpm>[] wheelRPMs)
      Add an array of wheel rpms
      Parameters:
      wheelRPMs - The wheel rpms
      Returns:
      The builder

    • addWheelRpm

      public Diagnostics.State.Builder addWheelRpm(Property<WheelRpm> wheelRpm)
      Add a single wheel rpm
      Parameters:
      wheelRpm - The wheel rpm
      Returns:
      The builder

    • setTroubleCodes

      public Diagnostics.State.Builder setTroubleCodes(Property<TroubleCode>[] troubleCodes)
      Add an array of trouble codes
      Parameters:
      troubleCodes - The trouble codes
      Returns:
      The builder

    • addTroubleCode

      public Diagnostics.State.Builder addTroubleCode(Property<TroubleCode> troubleCode)
      Add a single trouble code
      Parameters:
      troubleCode - The trouble code
      Returns:
      The builder

    • setMileageMeters

      @Deprecated public Diagnostics.State.Builder setMileageMeters(Property<com.highmobility.autoapi.value.measurement.Length> mileageMeters)
      Deprecated.
      'mileage' is an incorrect term for this. Replaced by Diagnostics.State.getOdometer()
      Parameters:
      mileageMeters - The vehicle mileage (odometer) in meters
      Returns:
      The builder

    • setOdometer

      public Diagnostics.State.Builder setOdometer(Property<com.highmobility.autoapi.value.measurement.Length> odometer)
      Parameters:
      odometer - The vehicle odometer value in a given units
      Returns:
      The builder

    • setEngineTotalOperatingTime

      public Diagnostics.State.Builder setEngineTotalOperatingTime(Property<com.highmobility.autoapi.value.measurement.Duration> engineTotalOperatingTime)
      Parameters:
      engineTotalOperatingTime - The accumulated time of engine operation
      Returns:
      The builder

    • setTirePressureStatuses

      public Diagnostics.State.Builder setTirePressureStatuses(Property<TirePressureStatus>[] tirePressureStatuses)
      Add an array of tire pressure statuses
      Parameters:
      tirePressureStatuses - The tire pressure statuses
      Returns:
      The builder

    • addTirePressureStatus

      public Diagnostics.State.Builder addTirePressureStatus(Property<TirePressureStatus> tirePressureStatus)
      Add a single tire pressure status
      Parameters:
      tirePressureStatus - The tire pressure status
      Returns:
      The builder

    • setBrakeLiningWearPreWarning

      public Diagnostics.State.Builder setBrakeLiningWearPreWarning(Property<ActiveState> brakeLiningWearPreWarning)
      Parameters:
      brakeLiningWearPreWarning - Status of brake lining wear pre-warning
      Returns:
      The builder

    • setEngineOilLifeRemaining

      public Diagnostics.State.Builder setEngineOilLifeRemaining(Property<Double> engineOilLifeRemaining)
      Parameters:
      engineOilLifeRemaining - Remaining life of engine oil which decreases over time
      Returns:
      The builder

    • setOemTroubleCodeValues

      public Diagnostics.State.Builder setOemTroubleCodeValues(Property<OemTroubleCodeValue>[] oemTroubleCodeValues)
      Add an array of oem trouble code values
      Parameters:
      oemTroubleCodeValues - The oem trouble code values. Additional OEM trouble codes
      Returns:
      The builder

    • addEngineTroubleCodeValue

      public Diagnostics.State.Builder addEngineTroubleCodeValue(Property<OemTroubleCodeValue> engineTroubleCodeValue)
      Add a single engine trouble code value
      Parameters:
      engineTroubleCodeValue - The engine trouble code value. Additional OEM trouble codes
      Returns:
      The builder

    • setDieselExhaustFluidRange

      public Diagnostics.State.Builder setDieselExhaustFluidRange(Property<com.highmobility.autoapi.value.measurement.Length> dieselExhaustFluidRange)
      Parameters:
      dieselExhaustFluidRange - Distance remaining until diesel exhaust fluid is empty
      Returns:
      The builder

    • setDieselParticulateFilterSootLevel

      public Diagnostics.State.Builder setDieselParticulateFilterSootLevel(Property<Double> dieselParticulateFilterSootLevel)
      Parameters:
      dieselParticulateFilterSootLevel - Level of soot in diesel exhaust particulate filter
      Returns:
      The builder

    • setConfirmedTroubleCodes

      public Diagnostics.State.Builder setConfirmedTroubleCodes(Property<ConfirmedTroubleCode>[] confirmedTroubleCodes)
      Add an array of confirmed trouble codes
      Parameters:
      confirmedTroubleCodes - The confirmed trouble codes
      Returns:
      The builder

    • addConfirmedTroubleCode

      public Diagnostics.State.Builder addConfirmedTroubleCode(Property<ConfirmedTroubleCode> confirmedTroubleCode)
      Add a single confirmed trouble code
      Parameters:
      confirmedTroubleCode - The confirmed trouble code
      Returns:
      The builder

    • setDieselExhaustFilterStatus

      public Diagnostics.State.Builder setDieselExhaustFilterStatus(Property<DieselExhaustFilterStatus>[] dieselExhaustFilterStatus)
      Add an array of diesel exhaust filter status
      Parameters:
      dieselExhaustFilterStatus - The diesel exhaust filter status
      Returns:
      The builder

    • addDieselExhaustFilterStatu

      public Diagnostics.State.Builder addDieselExhaustFilterStatu(Property<DieselExhaustFilterStatus> dieselExhaustFilterStatu)
      Add a single diesel exhaust filter statu
      Parameters:
      dieselExhaustFilterStatu - The diesel exhaust filter statu
      Returns:
      The builder

    • setEngineTotalIdleOperatingTime

      public Diagnostics.State.Builder setEngineTotalIdleOperatingTime(Property<com.highmobility.autoapi.value.measurement.Duration> engineTotalIdleOperatingTime)
      Parameters:
      engineTotalIdleOperatingTime - The accumulated time of engine operation
      Returns:
      The builder

    • setEngineOilAmount

      public Diagnostics.State.Builder setEngineOilAmount(Property<com.highmobility.autoapi.value.measurement.Volume> engineOilAmount)
      Parameters:
      engineOilAmount - The current estimated oil tank liquid fill.
      Returns:
      The builder

    • setEngineOilLevel

      public Diagnostics.State.Builder setEngineOilLevel(Property<Double> engineOilLevel)
      Parameters:
      engineOilLevel - The current estimated oil tank liquid fill in percentage.
      Returns:
      The builder

    • setEstimatedSecondaryPowertrainRange

      public Diagnostics.State.Builder setEstimatedSecondaryPowertrainRange(Property<com.highmobility.autoapi.value.measurement.Length> estimatedSecondaryPowertrainRange)
      Parameters:
      estimatedSecondaryPowertrainRange - Estimated secondary powertrain range
      Returns:
      The builder

    • setFuelLevelAccuracy

      public Diagnostics.State.Builder setFuelLevelAccuracy(Property<Diagnostics.FuelLevelAccuracy> fuelLevelAccuracy)
      Parameters:
      fuelLevelAccuracy - This value includes the information, if the fuel level has been calculated or measured.
      Returns:
      The builder

    • setTirePressuresTargets

      public Diagnostics.State.Builder setTirePressuresTargets(Property<TirePressure>[] tirePressuresTargets)
      Add an array of tire pressures targets
      Parameters:
      tirePressuresTargets - The tire pressures targets. Target tire pressures for the vehicle.
      Returns:
      The builder

    • addTirePressureTarget

      public Diagnostics.State.Builder addTirePressureTarget(Property<TirePressure> tirePressureTarget)
      Add a single tire pressure target
      Parameters:
      tirePressureTarget - The tire pressure target. Target tire pressures for the vehicle.
      Returns:
      The builder

    • setTirePressuresDifferences

      public Diagnostics.State.Builder setTirePressuresDifferences(Property<TirePressure>[] tirePressuresDifferences)
      Add an array of tire pressures differences
      Parameters:
      tirePressuresDifferences - The tire pressures differences. Tire pressures difference from the target pressure.
      Returns:
      The builder

    • addTirePressureDifference

      public Diagnostics.State.Builder addTirePressureDifference(Property<TirePressure> tirePressureDifference)
      Add a single tire pressure difference
      Parameters:
      tirePressureDifference - The tire pressure difference. Tire pressures difference from the target pressure.
      Returns:
      The builder

    • setBackupBatteryRemainingTime

      public Diagnostics.State.Builder setBackupBatteryRemainingTime(Property<com.highmobility.autoapi.value.measurement.Duration> backupBatteryRemainingTime)
      Parameters:
      backupBatteryRemainingTime - Remaining time the backup battery can work.
      Returns:
      The builder

    • setEngineCoolantFluidLevel

      public Diagnostics.State.Builder setEngineCoolantFluidLevel(Property<FluidLevel> engineCoolantFluidLevel)
      Parameters:
      engineCoolantFluidLevel - Engine coolant fluid level
      Returns:
      The builder

    • setEngineOilFluidLevel

      public Diagnostics.State.Builder setEngineOilFluidLevel(Property<FluidLevel> engineOilFluidLevel)
      Parameters:
      engineOilFluidLevel - Engine oil fluid level
      Returns:
      The builder

    • setEngineOilPressureLevel

      public Diagnostics.State.Builder setEngineOilPressureLevel(Property<Diagnostics.EngineOilPressureLevel> engineOilPressureLevel)
      Parameters:
      engineOilPressureLevel - Engine oil pressure level
      Returns:
      The builder

    • setEngineTimeToNextService

      public Diagnostics.State.Builder setEngineTimeToNextService(Property<com.highmobility.autoapi.value.measurement.Duration> engineTimeToNextService)
      Parameters:
      engineTimeToNextService - Engine time until next service of the vehicle
      Returns:
      The builder

    • setLowVoltageBatteryChargeLevel

      public Diagnostics.State.Builder setLowVoltageBatteryChargeLevel(Property<Diagnostics.LowVoltageBatteryChargeLevel> lowVoltageBatteryChargeLevel)
      Parameters:
      lowVoltageBatteryChargeLevel - Indicates if the charge level of the low voltage battery is too low to use other systems
      Returns:
      The builder

    • setEngineOilServiceStatus

      public Diagnostics.State.Builder setEngineOilServiceStatus(Property<ServiceStatus> engineOilServiceStatus)
      Parameters:
      engineOilServiceStatus - Engine oil service status
      Returns:
      The builder

    • setPassengerAirbagStatus

      public Diagnostics.State.Builder setPassengerAirbagStatus(Property<ActiveState> passengerAirbagStatus)
      Parameters:
      passengerAirbagStatus - Passenger airbag is activated or not
      Returns:
      The builder