Merge pull request #252 from LuxoftSDL/feature/0266_new_vehicle_data_…

…gear_status

Feature/0266 new vehicle data gear status

MOBILE_API.xml

@@ -545,7 +545,8 @@
         <element name="VEHICLEDATA_FUELCONSUMPTION" />
         <element name="VEHICLEDATA_EXTERNTEMP" />
         <element name="VEHICLEDATA_VIN" />
-        <element name="VEHICLEDATA_PRNDL" />
+        <element name="VEHICLEDATA_GEARSTATUS" since="7.0"/>
+        <element name="VEHICLEDATA_PRNDL" until="7.0"/>
         <element name="VEHICLEDATA_TIREPRESSURE" />
         <element name="VEHICLEDATA_ODOMETER" />
         <element name="VEHICLEDATA_BELTSTATUS" />
@@ -1193,7 +1194,7 @@
             <description>Longitude and latitude and altitude</description>
         </element>
     </enum>
-    
+
     <enum name="PRNDL" since="2.0">
         <description>The selected gear.</description>
         <element name="PARK">
@@ -1206,6 +1207,7 @@
             <description>No gear</description>
         </element>
         <element name="DRIVE">
+            <description>Regular Drive mode</description>
         </element>
         <element name="SPORT">
             <description>Drive Sport mode</description>
@@ -1229,12 +1231,44 @@
         </element>
         <element name="EIGHTH">
         </element>
+        <element name="NINTH" since="7.0">
+        </element>
+        <element name="TENTH" since="7.0">
+        </element>
         <element name="UNKNOWN">
         </element>
         <element name="FAULT">
         </element>
     </enum>
-
+
+    <enum name="TransmissionType" since="7.0">
+        <description>Type of transmission used in the vehicle.</description>
+        <element name="MANUAL">
+            <description>Manual transmission.</description>
+        </element>
+        <element name="AUTOMATIC">
+            <description>Automatic transmission.</description>
+        </element>
+        <element name="SEMI_AUTOMATIC">
+            <description>Semi automatic transmission.</description>
+        </element>
+        <element name="DUAL_CLUTCH">
+            <description>Dual clutch transmission.</description>
+        </element>
+        <element name="CONTINUOUSLY_VARIABLE">
+            <description>Continuously variable transmission(CVT).</description>
+        </element>
+        <element name="INFINITELY_VARIABLE">
+            <description>Infinitely variable transmission.</description>
+        </element>
+        <element name="ELECTRIC_VARIABLE">
+            <description>Electric variable transmission.</description>
+        </element>
+        <element name="DIRECT_DRIVE">
+            <description>Direct drive between engine and wheels.</description>
+        </element>
+    </enum>
+
     <enum name="ComponentVolumeStatus" since="2.0">
         <description>The volume status of a vehicle component.</description>
         <element name="UNKNOWN" internal_name="CVS_UNKNOWN">
@@ -4465,6 +4499,18 @@
         <param name="displayCapabilities" type="DisplayCapability" array="true" minsize="1" maxsize="1000" mandatory="false" since="6.0"/>
     </struct>
 
+    <struct name="GearStatus" since="7.0">
+        <param name="userSelectedGear" type="PRNDL" mandatory="false">
+            <description>Gear position selected by the user i.e. Park, Drive, Reverse</description>
+        </param>
+        <param name="actualGear" type="PRNDL" mandatory="false">
+            <description>Actual Gear in use by the transmission</description>
+        </param>
+        <param name="transmissionType" type="TransmissionType" mandatory="false">
+            <description>Tells the transmission type</description>
+        </param>
+    </struct>
+
     <!-- Requests/Responses -->
 
     <function name="RegisterAppInterface" functionID="RegisterAppInterfaceID" messagetype="request" since="1.0">
@@ -5884,8 +5930,14 @@
         <param name="turnSignal" type="Boolean" mandatory="false" since="5.0">
             <description>See TurnSignal</description>
         </param>
-        <param name="prndl" type="Boolean" mandatory="false">
-            <description>See PRNDL</description>
+        <param name="gearStatus" type="Boolean" mandatory="false" since="7.0">
+            <description>See GearStatus</description>
+        </param>
+        <param name="prndl" type="Boolean" mandatory="false" deprecated="true" since="7.0">
+            <description>See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`</description>
+            <history>
+                <param name="prndl" type="Boolean" mandatory="false" since="2.0" until="7.0"/>
+            </history>
         </param>
         <param name="tirePressure" type="Boolean" mandatory="false">
             <description>See TireStatus</description>
@@ -6009,8 +6061,14 @@
         <param name="turnSignal" type="VehicleDataResult" mandatory="false" since="5.0">
             <description>See TurnSignal</description>
         </param>
-        <param name="prndl" type="VehicleDataResult" mandatory="false">
-            <description>See PRNDL</description>
+        <param name="gearStatus" type="VehicleDataResult" mandatory="false" since="7.0">
+            <description>See GearStatus</description>
+        </param>
+        <param name="prndl" type="VehicleDataResult" mandatory="false" deprecated="true" since="7.0">
+            <description>See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`</description>
+            <history>
+                <param name="prndl" type="VehicleDataResult" mandatory="false" since="2.0" until="7.0"/>
+            </history>
         </param>
         <param name="tirePressure" type="VehicleDataResult" mandatory="false">
             <description>See TireStatus</description>
@@ -6113,8 +6171,14 @@
         <param name="turnSignal" type="Boolean" mandatory="false" since="5.0">
             <description>See TurnSignal</description>
         </param>
-        <param name="prndl" type="Boolean" mandatory="false">
-            <description>See PRNDL</description>
+        <param name="gearStatus" type="Boolean" mandatory="false" since="7.0">
+            <description>See GearStatus</description>
+        </param>
+        <param name="prndl" type="Boolean" mandatory="false" deprecated="true" since="7.0">
+            <description>See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`</description>
+            <history>
+                <param name="prndl" type="Boolean" mandatory="false" since="2.0" until="7.0"/>
+            </history>
         </param>
         <param name="tirePressure" type="Boolean" mandatory="false">
             <description>See TireStatus</description>
@@ -6237,8 +6301,14 @@
         <param name="turnSignal" type="VehicleDataResult" mandatory="false" since="5.0">
             <description>See TurnSignal</description>
         </param>
-        <param name="prndl" type="VehicleDataResult" mandatory="false">
-            <description>See PRNDL</description>
+        <param name="gearStatus" type="VehicleDataResult" mandatory="false" since="7.0">
+            <description>See GearStatus</description>
+        </param>
+        <param name="prndl" type="VehicleDataResult" mandatory="false" deprecated="true" since="7.0">
+            <description>See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`</description>
+            <history>
+                <param name="prndl" type="VehicleDataResult" mandatory="false" since="2.0" until="7.0"/>
+            </history>
         </param>
         <param name="tirePressure" type="VehicleDataResult" mandatory="false">
             <description>See TireStatus</description>
@@ -6344,8 +6414,14 @@
         <param name="vin" type="Boolean" mandatory="false">
             <description>Vehicle identification number</description>
         </param>
-        <param name="prndl" type="Boolean" mandatory="false">
-            <description>See PRNDL</description>
+        <param name="gearStatus" type="Boolean" mandatory="false" since="7.0">
+            <description>See GearStatus</description>
+        </param>
+        <param name="prndl" type="Boolean" mandatory="false" deprecated="true" since="7.0">
+            <description>See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`</description>
+            <history>
+                <param name="prndl" type="Boolean" mandatory="false" since="2.0" until="7.0"/>
+            </history>
         </param>
         <param name="tirePressure" type="Boolean" mandatory="false">
             <description>See TireStatus</description>
@@ -6472,8 +6548,14 @@
         <param name="vin" type="String" maxlength="17" mandatory="false">
             <description>Vehicle identification number</description>
         </param>
-        <param name="prndl" type="PRNDL" mandatory="false">
-            <description>See PRNDL</description>
+        <param name="gearStatus" type="GearStatus" mandatory="false" since="7.0">
+            <description>See GearStatus</description>
+        </param>
+        <param name="prndl" type="PRNDL" mandatory="false" deprecated="true" since="7.0">
+            <description>See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`</description>
+            <history>
+                <param name="prndl" type="PRNDL" mandatory="false" since="2.0" until="7.0"/>
+            </history>
         </param>
         <param name="tirePressure" type="TireStatus" mandatory="false">
             <description>See TireStatus</description>
@@ -8178,8 +8260,14 @@
         <param name="vin" type="String" maxlength="17" mandatory="false">
             <description>Vehicle identification number.</description>
         </param>
-        <param name="prndl" type="PRNDL" mandatory="false">
-            <description>See PRNDL</description>
+        <param name="gearStatus" type="GearStatus" mandatory="false" since="7.0">
+            <description>See GearStatus</description>
+        </param>
+        <param name="prndl" type="PRNDL" mandatory="false" deprecated="true" since="7.0">
+            <description>See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`</description>
+            <history>
+                <param name="prndl" type="PRNDL" mandatory="false" since="2.0" until="7.0"/>
+            </history>
         </param>
         <param name="tirePressure" type="TireStatus" mandatory="false">
             <description>See TireStatus</description>

README.md

@@ -387,6 +387,7 @@ Defines the data types that can be published and subscribed to.
 |`VEHICLEDATA_FUELCONSUMPTION`||
 |`VEHICLEDATA_EXTERNTEMP`||
 |`VEHICLEDATA_VIN`||
+|`VEHICLEDATA_GEARSTATUS`||
 |`VEHICLEDATA_PRNDL`||
 |`VEHICLEDATA_TIREPRESSURE`||
 |`VEHICLEDATA_ODOMETER`||
@@ -761,7 +762,7 @@ The selected gear.
 |`PARK`|Parking|
 |`REVERSE`|Reverse gear|
 |`NEUTRAL`|No gear|
-|`DRIVE`||
+|`DRIVE`|Regular Drive mode|
 |`SPORT`|Drive Sport mode|
 |`LOWGEAR`|1st gear hold|
 |`FIRST`||
@@ -772,10 +773,29 @@ The selected gear.
 |`SIXTH`||
 |`SEVENTH`||
 |`EIGHTH`||
+|`NINTH`||
+|`TENTH`||
 |`UNKNOWN`||
 |`FAULT`||
 
 
+### TransmissionType
+Type of transmission used in the vehicle.
+
+##### Elements
+
+| Value | Description | 
+| ---------- |:-----------:|
+|`MANUAL`|Manual transmission.|
+|`AUTOMATIC`|Automatic transmission.|
+|`SEMI_AUTOMATIC`|Semi automatic transmission.|
+|`DUAL_CLUTCH`|Dual clutch transmission.|
+|`CONTINUOUSLY_VARIABLE`|Continuously variable transmission(CVT).|
+|`INFINITELY_VARIABLE`|Infinitely variable transmission.|
+|`ELECTRIC_VARIABLE`|Electric variable transmission.|
+|`DIRECT_DRIVE`|Direct drive between engine and wheels.|
+
+
 ### ComponentVolumeStatus
 The volume status of a vehicle component.
 
@@ -3133,6 +3153,16 @@ The systemCapabilityType identifies which data object exists in this struct. For
 |`displayCapabilities`|DisplayCapability[]|False||
 
 
+### GearStatus
+##### Parameters
+
+| Value |  Type | Mandatory | Description | 
+| ---------- | ---------- |:-----------: |:-----------:|
+|`userSelectedGear`|PRNDL|False|Gear position selected by the user i.e. Park, Drive, Reverse|
+|`actualGear`|PRNDL|False|Actual Gear in use by the transmission|
+|`transmissionType`|TransmissionType|False|Tells the transmission type|
+
+
 
 <div style="page-break-after: always;"></div>
 
@@ -3775,7 +3805,8 @@ Subscribes for specific published data items. The data will be only sent if it h
 |`fuelRange`|Boolean|False|The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.|
 |`externalTemperature`|Boolean|False|The external temperature in degrees celsius|
 |`turnSignal`|Boolean|False|See TurnSignal|
-|`prndl`|Boolean|False|See PRNDL|
+|`gearStatus`|Boolean|False|See GearStatus|
+|`prndl`|Boolean|False|See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`|
 |`tirePressure`|Boolean|False|See TireStatus|
 |`odometer`|Boolean|False|Odometer in km|
 |`beltStatus`|Boolean|False|The status of the seat belts|
@@ -3817,7 +3848,8 @@ Message Type: **response**
 |`fuelRange`|VehicleDataResult|False|The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.|
 |`externalTemperature`|VehicleDataResult|False|The external temperature in degrees celsius.|
 |`turnSignal`|VehicleDataResult|False|See TurnSignal|
-|`prndl`|VehicleDataResult|False|See PRNDL|
+|`gearStatus`|VehicleDataResult|False|See GearStatus|
+|`prndl`|VehicleDataResult|False|See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`|
 |`tirePressure`|VehicleDataResult|False|See TireStatus|
 |`odometer`|VehicleDataResult|False|Odometer in km|
 |`beltStatus`|VehicleDataResult|False|The status of the seat belts|
@@ -3858,7 +3890,8 @@ This function is used to unsubscribe the notifications from the subscribeVehicle
 |`fuelRange`|Boolean|False|The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.|
 |`externalTemperature`|Boolean|False|The external temperature in degrees celsius.|
 |`turnSignal`|Boolean|False|See TurnSignal|
-|`prndl`|Boolean|False|See PRNDL|
+|`gearStatus`|Boolean|False|See GearStatus|
+|`prndl`|Boolean|False|See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`|
 |`tirePressure`|Boolean|False|See TireStatus|
 |`odometer`|Boolean|False|Odometer in km|
 |`beltStatus`|Boolean|False|The status of the seat belts|
@@ -3900,7 +3933,8 @@ Message Type: **response**
 |`fuelRange`|VehicleDataResult|False|The fuel type, estimated range in KM, fuel level/capacity and fuel level state for the vehicle. See struct FuelRange for details.|
 |`externalTemperature`|VehicleDataResult|False|The external temperature in degrees celsius|
 |`turnSignal`|VehicleDataResult|False|See TurnSignal|
-|`prndl`|VehicleDataResult|False|See PRNDL|
+|`gearStatus`|VehicleDataResult|False|See GearStatus|
+|`prndl`|VehicleDataResult|False|See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`|
 |`tirePressure`|VehicleDataResult|False|See TireStatus|
 |`odometer`|VehicleDataResult|False|Odometer in km|
 |`beltStatus`|VehicleDataResult|False|The status of the seat belts|
@@ -3942,7 +3976,8 @@ Non periodic vehicle data read request.
 |`externalTemperature`|Boolean|False|The external temperature in degrees celsius|
 |`turnSignal`|Boolean|False|See TurnSignal|
 |`vin`|Boolean|False|Vehicle identification number|
-|`prndl`|Boolean|False|See PRNDL|
+|`gearStatus`|Boolean|False|See GearStatus|
+|`prndl`|Boolean|False|See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`|
 |`tirePressure`|Boolean|False|See TireStatus|
 |`odometer`|Boolean|False|Odometer in km|
 |`beltStatus`|Boolean|False|The status of the seat belts|
@@ -3985,7 +4020,8 @@ Message Type: **response**
 |`externalTemperature`|Float|False|The external temperature in degrees celsius|
 |`turnSignal`|TurnSignal|False|See TurnSignal|
 |`vin`|String|False|Vehicle identification number|
-|`prndl`|PRNDL|False|See PRNDL|
+|`gearStatus`|GearStatus|False|See GearStatus|
+|`prndl`|PRNDL|False|See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`|
 |`tirePressure`|TireStatus|False|See TireStatus|
 |`odometer`|Integer|False|Odometer in km|
 |`beltStatus`|BeltStatus|False|The status of the seat belts|
@@ -5032,7 +5068,8 @@ Callback for the periodic and non periodic vehicle data read function.
 |`externalTemperature`|Float|False|The external temperature in degrees celsius|
 |`turnSignal`|TurnSignal|False|See TurnSignal|
 |`vin`|String|False|Vehicle identification number.|
-|`prndl`|PRNDL|False|See PRNDL|
+|`gearStatus`|GearStatus|False|See GearStatus|
+|`prndl`|PRNDL|False|See PRNDL. This parameter is deprecated and it is now covered in `gearStatus`|
 |`tirePressure`|TireStatus|False|See TireStatus|
 |`odometer`|Integer|False|Odometer in km|
 |`beltStatus`|BeltStatus|False|The status of the seat belts|