Package com.highmobility.autoapi
Class Usage.State
java.lang.Object
java.util.AbstractCollection<E>
java.util.AbstractList<Byte>
com.highmobility.value.Bytes
com.highmobility.autoapi.Command
com.highmobility.autoapi.SetCommand
com.highmobility.autoapi.Usage.State
- Enclosing class:
- Usage
The usage state
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class com.highmobility.autoapi.SetCommand
SetCommand.BaseBuilderNested classes/interfaces inherited from class com.highmobility.autoapi.Command
Command.HandleNotParsedProperty, Command.PropertyIteration, Command.PropertyIterator -
Field Summary
Fields inherited from class com.highmobility.autoapi.Command
BRAND_IDENTIFIER, NONCE_IDENTIFIER, propertyIterator, SIGNATURE_IDENTIFIER, TIMESTAMP_IDENTIFIER, universalPropertyIds, VIN_IDENTIFIERFields inherited from class com.highmobility.value.Bytes
bytesFields inherited from class java.util.AbstractList
modCount -
Method Summary
Modifier and TypeMethodDescriptionProperty<com.highmobility.autoapi.value.measurement.FuelEfficiency>Property<com.highmobility.autoapi.value.measurement.Speed>Property<com.highmobility.autoapi.value.measurement.Speed>Property<com.highmobility.autoapi.value.measurement.Speed>Property<com.highmobility.autoapi.value.measurement.Length>Property<com.highmobility.autoapi.value.measurement.Length>Property<com.highmobility.autoapi.value.measurement.FuelEfficiency>Property<com.highmobility.autoapi.value.measurement.Duration>Property<com.highmobility.autoapi.value.measurement.Duration>Property<com.highmobility.autoapi.value.measurement.Length>Property<com.highmobility.autoapi.value.measurement.EnergyEfficiency>Property<com.highmobility.autoapi.value.measurement.EnergyEfficiency>Property<com.highmobility.autoapi.value.measurement.EnergyEfficiency>Property<com.highmobility.autoapi.value.measurement.Length>Property<com.highmobility.autoapi.value.measurement.Length>Property<com.highmobility.autoapi.value.measurement.Duration>Property<com.highmobility.autoapi.value.measurement.Duration>Property<com.highmobility.autoapi.value.measurement.FuelEfficiency>Property<com.highmobility.autoapi.value.measurement.FuelEfficiency>Property<com.highmobility.autoapi.value.measurement.Length>Property<com.highmobility.autoapi.value.measurement.Length>Property<com.highmobility.autoapi.value.measurement.EnergyEfficiency>Property<com.highmobility.autoapi.value.measurement.Energy>Property<com.highmobility.autoapi.value.measurement.Volume>Property<com.highmobility.autoapi.value.measurement.Length>Deprecated.'mileage' is an incorrect term for this.Property<com.highmobility.autoapi.value.measurement.Length>Property<com.highmobility.autoapi.value.measurement.Power>Methods inherited from class com.highmobility.autoapi.SetCommand
addProperty, createBytes, mandatoryPropertyErrorMessage, optionalPropertyErrorMessageMethods inherited from class com.highmobility.autoapi.Command
findUniversalProperties, findUniversalProperties, getAutoApiVersion, getBrand, getCommandType, getIdentifier, getNonce, getProperties, getProperty, getSignature, getSignedBytes, getTimestamp, getVinMethods inherited from class com.highmobility.value.Bytes
concat, concat, equals, get, getBase64, getBase64UrlSafe, getByteArray, getHex, getLength, getRange, set, set, set, size, toStringMethods inherited from class java.util.AbstractList
add, add, addAll, clear, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subListMethods inherited from class java.util.AbstractCollection
addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArrayMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArrayMethods inherited from interface java.util.List
addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray
-
Method Details
-
getAverageWeeklyDistance
- Returns:
- Average weekly distance
-
getAverageWeeklyDistanceLongRun
public Property<com.highmobility.autoapi.value.measurement.Length> getAverageWeeklyDistanceLongRun()- Returns:
- Average weekyl distance over long term
-
getAccelerationEvaluation
- Returns:
- Acceleration evaluation percentage
-
getDrivingStyleEvaluation
- Returns:
- Driving style evaluation percentage
-
getDrivingModesActivationPeriods
- Returns:
- The driving modes activation periods
-
getDrivingModesEnergyConsumptions
- Returns:
- The driving modes energy consumptions
-
getLastTripEnergyConsumption
- Returns:
- Energy consumption in the last trip
-
getLastTripFuelConsumption
- Returns:
- Fuel consumption in the last trip
-
getMileageAfterLastTrip
@Deprecated public Property<com.highmobility.autoapi.value.measurement.Length> getMileageAfterLastTrip()Deprecated.'mileage' is an incorrect term for this. Replaced bygetOdometerAfterLastTrip()- Returns:
- Mileage after the last trip
-
getLastTripElectricPortion
- Returns:
- Portion of the last trip used in electric mode
-
getLastTripAverageEnergyRecuperation
public Property<com.highmobility.autoapi.value.measurement.EnergyEfficiency> getLastTripAverageEnergyRecuperation()- Returns:
- Energy recuperation rate for last trip
-
getLastTripBatteryRemaining
- Returns:
- Battery % remaining after last trip
-
getLastTripDate
- Returns:
- The last trip date
-
getAverageFuelConsumption
public Property<com.highmobility.autoapi.value.measurement.FuelEfficiency> getAverageFuelConsumption()- Returns:
- Average fuel consumption for current trip
-
getCurrentFuelConsumption
public Property<com.highmobility.autoapi.value.measurement.FuelEfficiency> getCurrentFuelConsumption()- Returns:
- Current fuel consumption
-
getOdometerAfterLastTrip
- Returns:
- Odometer after the last trip
-
getSafetyDrivingScore
- Returns:
- Safety driving score as percentage
-
getRapidAccelerationGrade
- Returns:
- Grade given for rapid acceleration over time
-
getRapidDecelerationGrade
- Returns:
- Grade given for rapid deceleration over time
-
getLateNightGrade
- Returns:
- Grade given for late night driving over time
-
getDistanceOverTime
- Returns:
- Distance driven over a given time period
-
getElectricConsumptionRateSinceStart
public Property<com.highmobility.autoapi.value.measurement.EnergyEfficiency> getElectricConsumptionRateSinceStart()- Returns:
- Electric energy consumption rate since the start of a trip
-
getElectricConsumptionRateSinceReset
public Property<com.highmobility.autoapi.value.measurement.EnergyEfficiency> getElectricConsumptionRateSinceReset()- Returns:
- Electric energy consumption rate since a reset
-
getElectricDistanceLastTrip
- Returns:
- Distance travelled with electricity in last trip
-
getElectricDistanceSinceReset
- Returns:
- Distance travelled with electricity since reset
-
getElectricDurationLastTrip
- Returns:
- Duration of travelling using electricity during last trip
-
getElectricDurationSinceReset
public Property<com.highmobility.autoapi.value.measurement.Duration> getElectricDurationSinceReset()- Returns:
- Duration of travelling using electricity since reset
-
getFuelConsumptionRateLastTrip
public Property<com.highmobility.autoapi.value.measurement.FuelEfficiency> getFuelConsumptionRateLastTrip()- Returns:
- Liquid fuel consumption rate during last trip
-
getFuelConsumptionRateSinceReset
public Property<com.highmobility.autoapi.value.measurement.FuelEfficiency> getFuelConsumptionRateSinceReset()- Returns:
- Liquid fuel consumption rate since reset
-
getAverageSpeedLastTrip
- Returns:
- Average speed during last trip
-
getAverageSpeedSinceReset
- Returns:
- Average speed since reset
-
getFuelDistanceLastTrip
- Returns:
- Distance travelled with (liquid) fuel during last trip
-
getFuelDistanceSinceReset
- Returns:
- Distance travelled with (liquid) fuel since reset
-
getDrivingDurationLastTrip
- Returns:
- Duration of last trip
-
getDrivingDurationSinceReset
- Returns:
- Duration of travelling since reset
-
getEcoScoreTotal
- Returns:
- Overall eco-score rating
-
getEcoScoreFreeWheel
- Returns:
- Eco-score rating for free-wheeling
-
getEcoScoreConstant
- Returns:
- Eco-score rating constant
-
getEcoScoreBonusRange
- Returns:
- Eco-score bonus range
-
getTripMeters
- Returns:
- The trip meters
-
getElectricConsumptionAverage
public Property<com.highmobility.autoapi.value.measurement.EnergyEfficiency> getElectricConsumptionAverage()- Returns:
- Average electric energy consumption calculated based on the last 20km
-
getBrakingEvaluation
- Returns:
- Braking evaluation percentage
-
getAverageSpeed
- Returns:
- Average speed at data collection.
-
getRecuperationPower
- Returns:
- Recuperation energy of the drivetrain.
-
getAccelerationDurations
- Returns:
- Durations of normal or other accelerations.
-
getDrivingModeActivationPeriod
@Nullable public Property<DrivingModeActivationPeriod> getDrivingModeActivationPeriod(DrivingMode mode) - Parameters:
mode- The driving mode.- Returns:
- The driving mode activation period for given mode.
-
getDrivingModeEnergyConsumption
@Nullable public Property<DrivingModeEnergyConsumption> getDrivingModeEnergyConsumption(DrivingMode mode) - Parameters:
mode- The driving mode.- Returns:
- The driving mode energy consumptionfor given mode.
-