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

Commit f05f01d1 authored by Yu Shan's avatar Yu Shan
Browse files

Update doc for HVAC_TEMPERATURE_SET. 

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: Ie961e227cf977845aa4069b4691a6c5f26722d49
parent 84b14e04

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

+10 −10

File changed.

Preview size limit exceeded, changes collapsed.

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

+16 −36
Original line number Diff line number Diff line
@@ -620,22 +620,17 @@ enum VehicleProperty { 
     * }

     *

     * 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 area ID.

     *

     * {@code MinMaxSupportedValueResult.minSupportedValue} represents the lower bound of the

     * recommended tire pressure for the tire at the specified area ID.

     *

     * {@code MinMaxSupportedValueResult.maxSupportedValue} represents the upper bound of the

     * recommended tire pressure for the tire at the specified area ID.

     *

     * For example, if the recommended tire pressure of left_front tire is from 200.0 KILOPASCAL to

     * 240.0 KILOPASCAL, {@code getMinMaxSupportedValue} for

     * [propId=TIRE_PRESSURE, areaId=VehicleAreaWheel::LEFT_FRONT] must return a

     * {@code MinMaxSupportedValueResult} with OK status, 200.0 as minSupportedValue, 240.0 as

     * maxSupportedValue.

     *

     * At boot, minFloatValue is equal to minSupportedValue, maxFloatValue is equal to

     * maxSupportedValue.

     *
@@ -784,10 +779,8 @@ enum VehicleProperty { 
     * unless all bit flags of ImpactSensorLocation are supported.

     *

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

     *

     * {@code getSupportedValuesList} must return a {@code SupportedValuesListResult} that contains

     * supported values unless all bit flags of ImpactSensorLocation are supported.

     *

     * At boot, supportedEnumValues is equal to the supported values list.

     *

     * @change_mode VehiclePropertyChangeMode.ON_CHANGE
@@ -825,22 +818,17 @@ enum VehicleProperty { 
     * selected by the driver instead of simply GEAR_DRIVE.

     *

     * 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 getSupportedValuesList} for [GEAR_SELECTION, areaId=0] must return a

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

     *

     * The supportedValues must represent the list of supported gears for this vehicle. For example,

     * for an automatic transmission, the list can be {GEAR_NEUTRAL, GEAR_REVERSE, GEAR_PARK,

     * GEAR_DRIVE, GEAR_1, GEAR_2,...} and for manual transmission it can be {GEAR_NEUTRAL,

     * GEAR_REVERSE, GEAR_1, GEAR_2,...}.

     *

     * In the case of an automatic transmission vehicle that allows the driver to select specific

     * gears on demand (i.e. "manual mode"), the GEAR_SELECTION property value must be set to the

     * specific gear selected by the driver instead of simply GEAR_DRIVE.

     *

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

     *

     * @change_mode VehiclePropertyChangeMode.ON_CHANGE
@@ -866,20 +854,16 @@ enum VehicleProperty { 
     * same as that of the supported gears reported in GEAR_SELECTION.

     *

     * 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 getSupportedValuesList} for [GEAR_SELECTION, areaId=0] must return a

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

     *

     * The supported values list must represent the list of supported gears

     * for this vehicle.  For example, for an automatic transmission, this list can be

     * {GEAR_NEUTRAL, GEAR_REVERSE, GEAR_PARK, GEAR_1, GEAR_2,...}

     * and for manual transmission the list can be

     * {GEAR_NEUTRAL, GEAR_REVERSE, GEAR_1, GEAR_2,...}. This list need not be the

     * same as that of the supported gears reported in GEAR_SELECTION.

     *

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

     *

     * @change_mode VehiclePropertyChangeMode.ON_CHANGE
@@ -935,20 +919,15 @@ enum VehicleProperty { 
     * All values between min and max supported value must be supported.

     *

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

     *

     * {@code HasSupportedValueInfo.hasMinSupportedValue} and

     * {@code HasSupportedValueInfo.hasMaxSupportedValue} must be {@code true} for global area ID(0)

     *

     * {@code MinMaxSupportedValueResult.minSupportedValue} must be 0.

     *

     * {@code MinMaxSupportedValueResult.maxSupportedValue} indicates the setting for the maximum

     * amount of energy regenerated from braking. The minSupportedValue indicates the setting for no

     * regenerative braking.

     *

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

     * maxSupportedValue.

     *

     *

     * This property is a more granular form of EV_REGENERATIVE_BRAKING_STATE. It allows the user to

     * set a more specific level of regenerative braking if the states in EvRegenerativeBrakingState

     * are not granular enough for the OEM.
@@ -1054,14 +1033,11 @@ enum VehicleProperty { 
     * all enum values of EvStoppingMode are supported.

     *

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

     *

     * For the global area ID (0), {@code getSupportedValuesList}

     * must return a {@code SupportedValuesListResult} that contains supported values unless all

     * enum values of EvStoppingMode are supported.

     *

     * At boot, supportedEnumValues is equal to the supported values list.

     *

     *

     * The EvStoppingMode enum may be extended to include more states in the future.

     *

     * This property is defined as VehiclePropertyAccess.READ_WRITE, but OEMs have the option to
@@ -1109,12 +1085,10 @@ enum VehicleProperty { 
     * recommended) and ErrorState are supported.

     *

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

     *

     * For the global area ID (0), {@code getSupportedValuesList}

     * must return a {@code SupportedValuesListResult} that contains supported values unless all

     * states of both ElectronicStabilityControlState (including OTHER, which is not

     * recommended) and ErrorState are supported.

     *

     * At boot, supportedEnumValues is equal to the supported values list.

     *

     * @change_mode VehiclePropertyChangeMode.ON_CHANGE
@@ -1235,21 +1209,15 @@ enum VehicleProperty { 
     * 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
@@ -1336,6 +1304,21 @@ enum VehicleProperty { 
     *

     * Any value set in between a valid value should be rounded to the closest valid value.

     *

     * 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 minimum temperature

     * setting in Celsius.

     * {@code MinMaxSupportedValueResult.maxSupportedValue} indicates the maximum temperature

     * setting in Celsius.

     * If not all the values between minSupportedValue and maxSupportedValue are supported,

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

     * specified area ID. At boot, supportedValuesList must be equal to what is described in

     * config array.

     * At boot, minFloatValue is equal to minSupportedValue, maxFloatValue is equal to

     * maxSupportedValue.

     *

     * It is highly recommended that the OEM also implement the HVAC_TEMPERATURE_VALUE_SUGGESTION

     * vehicle property because it provides applications a simple method for determining temperature

     * values that can be set for this vehicle and for converting values between Celsius and
@@ -1348,6 +1331,7 @@ enum VehicleProperty { 
     * @access VehiclePropertyAccess.READ_WRITE

     * @access VehiclePropertyAccess.READ

     * @unit VehicleUnit.CELSIUS

     * @require_min_max_supported_value

     * @version 2

     */

    HVAC_TEMPERATURE_SET = 0x0503 + 0x10000000 + 0x05000000
@@ -1920,17 +1904,13 @@ enum VehicleProperty { 
     *              configArray[2] = KILOMETERS_PER_HOUR

     *

     * 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 [VEHICLE_SPEED_DISPLAY_UNITS, areaId=0] must return a

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

     * e.g. [METER_PER_SEC, MILES_PER_HOUR, KILOMETERS_PER_HOUR].

     *

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

     *

     *

     * If updating VEHICLE_SPEED_DISPLAY_UNITS affects the values of other *_DISPLAY_UNITS

     * properties, then their values must be updated and communicated to the AAOS framework as well.

     *