automotive/vehicle/aidl_property/android/hardware/automotive/vehicle/ErrorState.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 possible error states. For version 2 of this interface, ErrorState is used
 * by ADAS STATE properties, but its use may be expanded in future releases.
 */
@VintfStability
@Backing(type="int")
enum ErrorState {

    /**
     * This state is used as an alternative to any ErrorState value that is not defined in the
     * platform. Ideally, implementations of vehicle properties should not use this state. The
     * framework can use this field to remain backwards compatible if this enum is extended to
     * include additional states.
     */
    OTHER_ERROR_STATE = -1,
    /**
     * Vehicle property is not available because the feature is disabled.
     */
    NOT_AVAILABLE_DISABLED = -2,
    /**
     * Vehicle property is not available because the vehicle speed is too low to use this feature.
     */
    NOT_AVAILABLE_SPEED_LOW = -3,
    /**
     * Vehicle property is not available because the vehicle speed is too high to use this feature.
     */
    NOT_AVAILABLE_SPEED_HIGH = -4,
    /**
     * Vehicle property is not available because sensor or camera visibility is insufficient to use
     * this feature. For example, this can be caused by bird poop blocking the camera, poor weather
     * conditions such as snow or fog, or by any object obstructing the required sensors.
     */
    NOT_AVAILABLE_POOR_VISIBILITY = -5,
    /**
     * Vehicle property is not available because there is a safety risk that makes this feature
     * unavailable to use presently. For example, this can be caused by someone blocking the trunk
     * door while it is closing, or by the system being in a faulty state.
     */
    NOT_AVAILABLE_SAFETY = -6,
}