Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 48d2e1c6 authored by Aaqib Ismail's avatar Aaqib Ismail Committed by Android (Google) Code Review
Browse files

Merge "Add missing documentation in HAL for enum states"

parents d5af8fbf 68175631
Loading
Loading
Loading
Loading
+16 −2
Original line number Diff line number Diff line
@@ -17,14 +17,28 @@
package android.hardware.automotive.vehicle;

/**
 * Used by the trailer present property to enumerate the current state
 * of the trailer.
 * Used to enumerate the current state of VehicleProperty#TRAILER_PRESENT.
 */
@VintfStability
@Backing(type="int")
enum TrailerState {
    /**
     * This state is used as an alternative for any TrailerState value that is not defined in the
     * platform. Ideally, implementations of VehicleProperty#TRAILER_PRESENT should not use this
     * state. The framework can use this field to remain backwards compatible if TrailerState is
     * extended to include additional states.
     */
    UNKNOWN = 0,
    /**
     * A trailer is not attached to the vehicle.
     */
    NOT_PRESENT = 1,
    /**
     * A trailer is attached to the vehicle.
     */
    PRESENT = 2,
    /**
     * The state of the trailer is not available due to an error.
     */
    ERROR = 3,
}
+16 −1
Original line number Diff line number Diff line
@@ -16,15 +16,30 @@

package android.hardware.automotive.vehicle;

/**
 * Used to enumerate the current level of VehicleProperty#ENGINE_OIL_LEVEL.
 */
@VintfStability
@Backing(type="int")
enum VehicleOilLevel {
    /**
     * Oil level values
     * The oil level of the engine is critically low, so the vehicle may be unsafe to drive.
     */
    CRITICALLY_LOW = 0,
    /**
     * The oil level of the engine is low and needs to be replaced.
     */
    LOW = 1,
    /**
     * The oil level of the engine is normal for the vehicle.
     */
    NORMAL = 2,
    /**
     * The oil level of the engine is high, so the vehicle may be unsafe to drive.
     */
    HIGH = 3,
    /**
     * This value represents an error when retrieving the oil level of the engine.
     */
    ERROR = 4,
}
+6 −1
Original line number Diff line number Diff line
@@ -30,9 +30,14 @@ enum WindshieldWipersState {
     * WindshieldWipersState is extended to include additional states.
     */
    OTHER = 0,
    /**
     * This state indicates the windshield wipers are currently off. If
     * VehicleProperty#WINDSHIELD_WIPERS_SWITCH is implemented, then it may be set to any of the
     * following modes: OFF or AUTO.
     */
    OFF = 1,
    /**
     * This state indicates windshield wipers are currently on. If
     * This state indicates the windshield wipers are currently on. If
     * VehicleProperty#WINDSHIELD_WIPERS_SWITCH is implemented, then it may be set to any of the
     * following modes: MIST, INTERMITTENT_LEVEL_*, CONTINUOUS_LEVEL_*, or AUTO.
     */