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

Commit 4cf4323c authored by Yu Shan's avatar Yu Shan
Browse files

Update doc for HVAC_TEMPERATURE_DISPLAY_UNITS. 

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: Ic7688af5490e60d3de3adb01631bd48f30dee5ef
parent 03727f64

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

+1 −1
Original line number Diff line number Diff line
@@ -463,7 +463,7 @@ 
                    "VehicleUnit"

                ],

                "data_enum": "VehicleUnit",

                "description": "Temperature units for display\nIndicates whether the vehicle is displaying temperature to the user as Celsius or Fahrenheit. VehiclePropConfig.configArray is used to indicate the supported temperature display units. For example: configArray[0] = CELSIUS configArray[1] = FAHRENHEIT\nThis parameter MAY be used for displaying any HVAC temperature in the system. Values must be one of VehicleUnit.CELSIUS or VehicleUnit.FAHRENHEIT Note that internally, all temperatures are represented in floating point Celsius.\nIf updating HVAC_TEMPERATURE_DISPLAY_UNITS affects the values of other *_DISPLAY_UNITS properties, then their values must be updated and communicated to the AAOS framework as well.\nThis property is defined as VehiclePropertyAccess.READ_WRITE, but OEMs have the option to implement it as VehiclePropertyAccess.READ only."

                "description": "Temperature units for display\nIndicates whether the vehicle is displaying temperature to the user as Celsius or Fahrenheit.\nVehiclePropConfig.configArray is used to indicate the supported temperature display units.\nFor example: configArray[0] = CELSIUS configArray[1] = FAHRENHEIT\nIf {@code HasSupportedValueInfo} is not {@code null} for the global area ID (0): {@code VehicleAreaConfig.HasSupportedValueInfo.hasSupportedValuesList} for the global area ID (0) must be {@code true}. {@code getSupportedValuesLists} for [HVAC_TEMPERATURE_DISPLAY_UNITS, areaId=0] must return a {@code SupportedValuesListResult} that contains non-null {@code supportedValuesList}, e.g. [CELSIUS, FAHRENHEIT]. At boot, the values in the config array are equal to the supported values list.\nThis parameter MAY be used for displaying any HVAC temperature in the system. Values must be one of VehicleUnit.CELSIUS or VehicleUnit.FAHRENHEIT Note that internally, all temperatures are represented in floating point Celsius.\nIf updating HVAC_TEMPERATURE_DISPLAY_UNITS affects the values of other *_DISPLAY_UNITS properties, then their values must be updated and communicated to the AAOS framework as well.\nThis property is defined as VehiclePropertyAccess.READ_WRITE, but OEMs have the option to implement it as VehiclePropertyAccess.READ only."

            },

            {

                "name": "Actual fan speed",

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

+13 −2
Original line number Diff line number Diff line
@@ -1598,12 +1598,21 @@ enum VehicleProperty { 
    /**

     * Temperature units for display

     *

     * Indicates whether the vehicle is displaying temperature to the user as

     * Celsius or Fahrenheit.

     * Indicates whether the vehicle is displaying temperature to the user as Celsius or Fahrenheit.

     *

     * VehiclePropConfig.configArray is used to indicate the supported temperature display units.

     *

     * For example: configArray[0] = CELSIUS

     *              configArray[1] = FAHRENHEIT

     *

     * If {@code HasSupportedValueInfo} is not {@code null} for the global area ID (0):

     * {@code VehicleAreaConfig.HasSupportedValueInfo.hasSupportedValuesList} for the global area ID

     * (0) must be {@code true}.

     * {@code getSupportedValuesLists} for [HVAC_TEMPERATURE_DISPLAY_UNITS, areaId=0] must return a

     * {@code SupportedValuesListResult} that contains non-null {@code supportedValuesList},

     * e.g. [CELSIUS, FAHRENHEIT].

     * At boot, the values in the config array are equal to the supported values list.

     *

     * This parameter MAY be used for displaying any HVAC temperature in the system.

     * Values must be one of VehicleUnit.CELSIUS or VehicleUnit.FAHRENHEIT

     * Note that internally, all temperatures are represented in floating point Celsius.
@@ -1618,6 +1627,8 @@ enum VehicleProperty { 
     * @access VehiclePropertyAccess.READ_WRITE

     * @access VehiclePropertyAccess.READ

     * @data_enum VehicleUnit

     * @require_supported_values_list

     * @legacy_supported_values_in_config

     * @version 2

     */

    HVAC_TEMPERATURE_DISPLAY_UNITS = 0x050E + 0x10000000 + 0x01000000