Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature/sdl 0255 enhance body information vehicle data #9

Open
wants to merge 8 commits into
base: develop
Choose a base branch
from
Open

Feature/sdl 0255 enhance body information vehicle data #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
db3241c
add BodyInformation vehicle data params
KhrystynaDubovyk Nov 16, 2020
4ae3a22
Apply suggestions from code review
KhrystynaDubovyk Nov 24, 2020
3690ab2
Merge branch 'develop' into feature/sdl_0255_enhance_bodyInformation_…
KhrystynaDubovyk Nov 24, 2020
82d254e
edit referense links to -> Enums/#doorstatustype
KhrystynaDubovyk Dec 11, 2020
97f29e0
Apply suggestions from code review
KhrystynaDubovyk Jan 6, 2021
b760e50
apply the suggestion from review
KhrystynaDubovyk Jan 12, 2021
44a41db
Place Roof status selection note in getvehicledata indextry again.
KhrystynaDubovyk Jan 13, 2021
295df8c
Apply suggestions from code review
KhrystynaDubovyk Jan 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/Common/Enums/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1337,3 +1337,12 @@
|LITERS|0||
|KILOWATTHOURS|1||
|KILOGRAMS|2||

### DoorStatusType

|Name|Value|Description|
|:---|:----|:----------|
|CLOSED|0|The status is selected if a door is closed and unlocked or <br> if a door is closed and unknown locked state|
|LOCKED|1|The status is selected if a door is closed and locked|
|AJAR|2|The status is selected if a door is open|
|REMOVED|3|The status is selected if a door is physically removed|
41 changes: 34 additions & 7 deletions docs/Common/Structs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,13 +299,16 @@

|Name|Type|Mandatory|Additional|Description|
|:---|:---|:--------|:---------|:----------|
|parkBrakeActive|Boolean|true|||
|ignitionStableStatus|[Common.IgnitionStableStatus](../enums/#ignitionstablestatus)|true|||
|ignitionStatus|[Common.IgnitionStatus](../enums/#ignitionstatus)|true|||
|driverDoorAjar|Boolean|false|||
|passengerDoorAjar|Boolean|false|||
|rearLeftDoorAjar|Boolean|false|||
|rearRightDoorAjar|Boolean|false|||
|parkBrakeActive|Boolean|true||If mechanical park brake is active, true. Otherwise false.|
|ignitionStableStatus|[Common.IgnitionStableStatus](../enums/#ignitionstablestatus)|true||Provides information on status of ignition stable switch. See IgnitionStableStatus.|
|ignitionStatus|[Common.IgnitionStatus](../enums/#ignitionstatus)|true||Provides information on current ignitiion status. See IgnitionStatus.|
|driverDoorAjar|Boolean|false||References signal "DrStatDrv_B_Actl". Deprecated starting with RPC Spec 7.1.0|
|passengerDoorAjar|Boolean|false||References signal "DrStatPsngr_B_Actl". Deprecated starting with RPC Spec 7.1.0|
|rearLeftDoorAjar|Boolean|false||References signal "DrStatRl_B_Actl". Deprecated starting with RPC Spec 7.1.0|
|rearRightDoorAjar|Boolean|false||References signal "DrStatRr_B_Actl". Deprecated starting with RPC Spec 7.1.0|
|doorStatuses|Common.DoorStatus|false|array: true<br>minsize: 0<br>maxsize: 100|Provides status for doors if Ajar/Closed/Locked|
|gateStatuses|Common.GateStatus|false|array: true<br>minsize: 0<br>maxsize: 100|Provides status for trunk/hood/etc. if Ajar/Closed/Locked|
|roofStatuses|Common.RoofStatus|false|array: true<br>minsize: 0<br>maxsize: 100|Provides status for roof/convertible roof/sunroof/moonroof etc., if Closed/Ajar/Removed etc.|

### BeltStatus

Expand Down Expand Up @@ -1179,3 +1182,27 @@ There are no defined parameters for this struct
|:---|:---|:--------|:---------|:----------|
|location|Common.Grid|true|||
|state|Common.WindowState|true|||

### DoorStatus

|Name|Type|Mandatory|Additional|Description|
|:---|:---|:--------|:---------|:----------|
|location|Common.Grid|true||Describes the status of a location of a door.|
|status|[Common.DoorStatusType](../enums/#doorstatustype)|true||Describes the status of a door.|

### GateStatus

|Name|Type|Mandatory|Additional|Description|
|:---|:---|:--------|:---------|:----------|
|location|Common.Grid|true||Describes the status of location of trunk/hood/etc.|
|status|[Common.DoorStatusType](../enums/#doorstatustype)|true||Describes the status of trunk/hood/etc.|

### RoofStatus

|Name|Type|Mandatory|Additional|Description|
|:---|:---|:--------|:---------|:----------|
|location|Common.Grid|true||Describes the status of a parameter of roof, convertible roof, sunroof/moonroof etc.<br>If roof is open (AJAR), state will determine percentage of roof open.|
|status|[Common.DoorStatusType](../enums/#doorstatustype)|true||Describes the status of a parameter of roof, convertible roof, sunroof/moonroof etc.<br>If roof is open (AJAR), state will determine percentage of roof open.|
|state|Common.WindowState|false||Describes the status of a parameter of roof, convertible roof, sunroof/moonroof etc.<br>If roof is open (AJAR), state will determine percentage of roof open.|


18 changes: 18 additions & 0 deletions docs/VehicleInfo/GetVehicleData/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,24 @@ The HMI will have to update this field if the user chooses to reset this value (

!!!

!!! note

#### Roof Status Selection
* 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 be `REMOVED` or `CLOSED/LOCKED`. `state` can be omitted.
* Other type of roof - `location` grid would span actual location of the roof as per physical location. `status` and `state` would be as per table below:

| Roof condition | status | state |
| ------------- | ------------- | ------------- |
| Roof is closed and locked | LOCKED | `approximatePosition` = 0 & `deviation` = 0 |
| Roof is closed and unlocked | CLOSED | `approximatePosition` = 0 & `deviation` = 0 |
| Roof is closed and unknown locked state | CLOSED | `approximatePosition` = 0 & `deviation` = 0 |
| Roof is open | AJAR | actual values of `approximatePosition` & `deviation` |
| Roof is physically removed | REMOVED | can be omitted OR `approximatePosition` = 0 & `deviation` = 0 |

!!!

### Request

#### Parameters
Expand Down