Revise 0255-Enhance BodyInformation vehicle data

[atiwari9]

Introduction

This revision adds roofStatuses param to BodyInformation struct along with supporting enums and structs. These additions would enhance existing doorStatuses param as well. Also the original proposal needs to be updated to remove deprecated field from params in BodyInformation struct in HMI API as it is not applicable there. The deprecated field and information is kept in MOBILE API.

Motivation

BodyInformation is missing the details for roof, convertible, sunroof/moonroof, removable roof etc. Current DoorStatusType enum also needs some more elements to support additional possible values for status.

Proposed solution

New Struct RoofStatus is needed:

<struct name="RoofStatus">
	<description>
		Describes the status of a parameter of removable roof/convertible roof/sunroof/moonroof etc.
		If roof is open(AJAR), state will determine percentage of roof open.
	</description>
	<param name="location" type="Grid" mandatory="true"/>
	<param name="status" type="DoorStatusType" mandatory="true"/>
	<param name="state" type="WindowState" mandatory="false"/>
</struct>

We can use the same grid method to locate the roof and decide its span, e.g.:

• Convertible roof - location grid would span entire rows and columns and roof status could be CLOSED or AJAR with corresponding state.
• Sunroof/Moonroof - location grid would span just actual location of sunroof/moonroof. status could be CLOSED or AJAR with corresponding state.
• Entire roof - location grid would span entire rows and columns and roof status would beREMOVED or CLOSED/LOCKED. state can be omitted.

Enum DoorStatusType is updated:

<enum name="DoorStatusType">
	<element name="CLOSED"/>
	<element name="LOCKED"/>
	<element name="AJAR"/>
+	<element name="REMOVED"/>
</enum>

Then BodyInformation struct would be updated as:

<struct name="BodyInformation" since="2.0">
	<param name="parkBrakeActive" type="Boolean" mandatory="true">
		<description>If mechanical park brake is active, true. Otherwise false.</description>
	</param>
	<param name="ignitionStableStatus" type="IgnitionStableStatus" mandatory="true">
		<description>Provides information on status of ignition stable switch. See IgnitionStableStatus.</description>
	</param>
	<param name="ignitionStatus" type="IgnitionStatus" mandatory="true">
		<description>Provides information on current ignitiion status. See IgnitionStatus.</description>
	</param>
	<param name="driverDoorAjar" type="Boolean" mandatory="false" deprecated="true" since="X.x">
		<description>References signal "DrStatDrv_B_Actl". Deprecated starting with RPC Spec X.x.x.</description>
	</param>
	<param name="passengerDoorAjar" type="Boolean" mandatory="false" deprecated="true" since="X.x">
		<description>References signal "DrStatPsngr_B_Actl". Deprecated starting with RPC Spec X.x.x.</description>
	</param>
	<param name="rearLeftDoorAjar" type="Boolean" mandatory="false" deprecated="true" since="X.x">
		<description>References signal "DrStatRl_B_Actl". Deprecated starting with RPC Spec X.x.x.</description>
	</param>
	<param name="rearRightDoorAjar" type="Boolean" mandatory="false" deprecated="true" since="X.x">
		<description>References signal "DrStatRr_B_Actl". Deprecated starting with RPC Spec X.x.x.</description>
	</param>
	<param name="doorStatuses" type="DoorStatus" array="true" minsize="0" maxsize="100" mandatory="false" since="X.x">
		<description>Provides status for doors if Ajar/Closed/Locked</description>
	</param>	
	<param name="gateStatuses" type="GateStatus" array="true" minsize="0" maxsize="100" mandatory="false" since="X.x">
		<description>Provides status for trunk/hood/etc. if Ajar/Closed/Locked</description>
	</param>
+	<param name="roofStatuses" type="RoofStatus" array="true" minsize="0" maxsize="100" mandatory="false" since="X.x">
+		<description>Provides status for roof/convertible roof/moonroof/sunroof etc. if Closed/Ajar/Removed etc.</description>
+	</param>
</struct>

Potential downsides

None

Impact on existing code

Same as original proposal

Alternatives considered

None

[atiwari9]

@theresalech - Ready for review.

[theresalech]

@atiwari9 I've left a few suggested changes. Please let me know if you have any questions or concerns with addressing.

Additionally, as this is a proposal to revise an already accepted proposal, please update the description of your PR accordingly. Here's an example: #775. Additional information about Revising Previously Accepted Proposals can be found in the SDL Evolution Process document.

Thanks!

[atiwari9]

@theresalech - Updated the PR and description as per your comments.

[theresalech]

Thanks, @atiwari9! I've found one more sunroof/moonroof reference that should be updated for consistency, and wanted to make sure removing deprecation information is called out in the PR description. I also noticed a few typos within your PR description that should be fixed:

• Open parenthesis in Motivation section doesn't have a corresponding close parenthesis
• "removeable" in Motivation section should be fixed to "removable"
• "sun roof/moon roof" in Proposed solution section should be updated to "sunroof/moonroof"
• description for roofStatuses in BodyInformation struct (Proposed solution section) should match what's included in .md file.

Let me know if you have any questions. Thanks!

[atiwari9]

@theresalech - Updated PR description and proposal revision.

[atiwari9]

@theresalech - Updated PR description and proposal SDL-0255 with changes agreed in this comment

[theresalech]

Hi @atiwari9, I've found some typos and provided suggested changes. Please let me know if you have any questions or concerns with addressing. Thanks!

[atiwari9]

@theresalech - Updated the PR