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

Commit 21e8b225 authored by Yu Shan's avatar Yu Shan
Browse files

Update doc for HVAC_FAN_SPEED. 

Part of a large doc update. Add doc for new supported value range
APIs. For be backward compatible with older VHAL clients still
using deprecated fields, we still require the old fields to be
populated.

Test: None
Bug: 383184445
Flag: EXEMPT no code change
Change-Id: I07c18f946cff475d5bc866c5d665a2ba7582e058
parent 79da8526

automotive/vehicle/aidl/emu_metadata/android.hardware.automotive.vehicle-types-meta.json

+1 −1
Original line number Diff line number Diff line
@@ -385,7 +385,7 @@ 
            {

                "name": "Fan speed setting",

                "value": 356517120,

                "description": "Fan speed setting\nThe maxInt32Value and minInt32Value in VehicleAreaConfig must be defined. All integers between minInt32Value and maxInt32Value must be supported.\nThe minInt32Value indicates the lowest fan speed. The maxInt32Value indicates the highest fan speed.\nThis property is not in any particular unit but in a specified range of relative speeds.\nThis property is defined as VehiclePropertyAccess.READ_WRITE, but OEMs have the option to implement it as VehiclePropertyAccess.READ only."

                "description": "Fan speed setting\nThe maxInt32Value and minInt32Value in VehicleAreaConfig must be defined. All integers between minInt32Value and maxInt32Value must be supported.\nThe minInt32Value indicates the lowest fan speed. The maxInt32Value indicates the highest fan speed.\nIf {@code HasSupportedValueInfo} for a specific area ID is not {@code null}:\n{@code HasSupportedValueInfo.hasMinSupportedValue} and {@code HasSupportedValueInfo.hasMaxSupportedValue} must be {@code true} for the specific area ID.\n{@code MinMaxSupportedValueResult.minSupportedValue} indicates the lowest fan speed.\n{@code MinMaxSupportedValueResult.maxSupportedValue} indicates the highest fan speed.\nAll integers between minSupportedValue and maxSupportedValue must be supported.\nAt boot, minInt32Value is equal to minSupportedValue, maxInt32Value is equal to maxSupportedValue.\n\nThis property is not in any particular unit but in a specified range of relative speeds.\nThis property is defined as VehiclePropertyAccess.READ_WRITE, but OEMs have the option to implement it as VehiclePropertyAccess.READ only."

            },

            {

                "name": "Fan direction setting",

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

+17 −0
Original line number Diff line number Diff line
@@ -1234,6 +1234,22 @@ enum VehicleProperty { 
     * The minInt32Value indicates the lowest fan speed.

     * The maxInt32Value indicates the highest fan speed.

     *

     * If {@code HasSupportedValueInfo} for a specific area ID is not {@code null}:

     *

     * {@code HasSupportedValueInfo.hasMinSupportedValue} and

     * {@code HasSupportedValueInfo.hasMaxSupportedValue} must be {@code true} for the specific

     * area ID.

     *

     * {@code MinMaxSupportedValueResult.minSupportedValue} indicates the lowest fan speed.

     *

     * {@code MinMaxSupportedValueResult.maxSupportedValue} indicates the highest fan speed.

     *

     * All integers between minSupportedValue and maxSupportedValue must be supported.

     *

     * At boot, minInt32Value is equal to minSupportedValue, maxInt32Value is equal to

     * maxSupportedValue.

     *

     *

     * This property is not in any particular unit but in a specified range of relative speeds.

     *

     * This property is defined as VehiclePropertyAccess.READ_WRITE, but OEMs have the option to
@@ -1242,6 +1258,7 @@ enum VehicleProperty { 
     * @change_mode VehiclePropertyChangeMode.ON_CHANGE

     * @access VehiclePropertyAccess.READ_WRITE

     * @access VehiclePropertyAccess.READ

     * @require_min_max_supported_value

     * @version 2

     */

    HVAC_FAN_SPEED = 0x0500 + 0x10000000 + 0x05000000