automotive/vehicle/aidl_property/android/hardware/automotive/vehicle/HandsOnDetectionWarning.aidl

/*
 * Copyright (C) 2023 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.hardware.automotive.vehicle;

/**
 * Used to enumerate the current warning state of Hands On Detection (HOD).
 */
@VintfStability
@Backing(type="int")
enum HandsOnDetectionWarning {
    /**
     * This state is used as an alternative for any HandsOnDetectionWarning value that is
     * defined in the platform. Ideally, implementations of
     * VehicleProperty#HANDS_ON_DETECTION_WARNING should not use this state. The framework
     * can use this field to remain backwards compatible if HandsOnDetectionWarning is
     * extended to include additional states.
     */
    OTHER = 0,
    /**
     * HOD is enabled and the driver's current safety does not warrant sending a warning. This
     * state is independent of whether the driver actually has their hands on or off the wheel.
     */
    NO_WARNING = 1,
    /**
     * HOD is enabled and the driver's hands have been off the wheel for too long a duration,
     * and the vehicle is sending a warning to the driver as a consequence of this.
     */
    WARNING = 2,
}