diff options
author | ShobhitAd <adlakhshobhit@gmail.com> | 2018-11-01 15:58:40 -0500 |
---|---|---|
committer | ShobhitAd <adlakhshobhit@gmail.com> | 2018-11-01 15:58:40 -0500 |
commit | 3d2eb5f2d7c49f0dacfb6c480de9a8fd0d8b0c10 (patch) | |
tree | 777b0a10a7e68cd6441436bb67dfd60c1018a132 /src | |
parent | 83e5ba4f27d98528823730225efb411ab5b355a1 (diff) | |
download | sdl_core-3d2eb5f2d7c49f0dacfb6c480de9a8fd0d8b0c10.tar.gz |
Added description for param to MOBILE and HMI API files
Diffstat (limited to 'src')
-rw-r--r-- | src/components/interfaces/HMI_API.xml | 36 | ||||
-rw-r--r-- | src/components/interfaces/MOBILE_API.xml | 34 |
2 files changed, 53 insertions, 17 deletions
diff --git a/src/components/interfaces/HMI_API.xml b/src/components/interfaces/HMI_API.xml index 4c4a01ed9d..2d256423bd 100644 --- a/src/components/interfaces/HMI_API.xml +++ b/src/components/interfaces/HMI_API.xml @@ -4951,6 +4951,10 @@ <param name="electronicParkBrakeStatus" type="Boolean" mandatory="false"> <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> </param> + <param name="cloudAppVehicleID" type="Boolean" mandatory="false"> + <description>Parameter used by cloud apps to identify a head unit</description> + </param> + <!-- Ford Specific Data Items --> <param name="eCallInfo" type="Boolean" mandatory="false"> <description>Emergency Call notification and confirmation data</description> @@ -4968,7 +4972,6 @@ <description>Information related to the MyKey feature</description> </param> <!-- / Ford Specific Data Items --> - <param name="cloudAppVehicleID" type="Boolean" mandatory="false"></param> </function> <function name="SubscribeVehicleData" messagetype="response"> @@ -5041,6 +5044,10 @@ <param name="electronicParkBrakeStatus" type="Common.VehicleDataResult" mandatory="false"> <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> </param> + <param name="cloudAppVehicleID" type="Common.VehicleDataResult" mandatory="false"> + <description>Parameter used by cloud apps to identify a head unit</description> + </param> + <!-- Ford Specific Data Items --> <param name="eCallInfo" type="Common.VehicleDataResult" mandatory="false"> <description>Emergency Call notification and confirmation data</description> @@ -5059,7 +5066,6 @@ </param> <!-- / Ford Specific Data Items --> - <param name="cloudAppVehicleID" type="Common.VehicleDataResult" mandatory="false"></param> </function> <function name="UnsubscribeVehicleData" messagetype="request"> <description> @@ -5137,6 +5143,10 @@ <param name="electronicParkBrakeStatus" type="Boolean" mandatory="false"> <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> </param> + <param name="cloudAppVehicleID" type="Boolean" mandatory="false"> + <description>Parameter used by cloud apps to identify a head unit</description> + </param> + <!-- Ford Specific Data Items --> <param name="eCallInfo" type="Boolean" mandatory="false"> <description>Emergency Call notification and confirmation data</description> @@ -5154,7 +5164,7 @@ <description>Information related to the MyKey feature</description> </param> <!-- / Ford Specific Data Items --> - <param name="cloudAppVehicleID" type="Boolean" mandatory="false"></param> + </function> <function name="UnsubscribeVehicleData" messagetype="response"> <param name="gps" type="Common.VehicleDataResult" mandatory="false"> @@ -5226,6 +5236,10 @@ <param name="electronicParkBrakeStatus" type="Common.VehicleDataResult" mandatory="false"> <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> </param> + <param name="cloudAppVehicleID" type="Common.VehicleDataResult" mandatory="false"> + <description>Parameter used by cloud apps to identify a head unit</description> + </param> + <!-- Ford Specific Data Items --> <param name="eCallInfo" type="Common.VehicleDataResult" mandatory="false"> <description>Emergency Call notification and confirmation data</description> @@ -5243,7 +5257,6 @@ <description>Information related to the MyKey feature</description> </param> <!-- / Ford Specific Data Items --> - <param name="cloudAppVehicleID" type="Common.VehicleDataResult" mandatory="false"></param> </function> <function name="GetVehicleData" messagetype="request"> @@ -5320,6 +5333,10 @@ <param name="electronicParkBrakeStatus" type="Boolean" mandatory="false"> <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> </param> + <param name="cloudAppVehicleID" type="Boolean" mandatory="false"> + <description>Parameter used by cloud apps to identify a head unit</description> + </param> + <!-- Ford Specific Data Items --> <param name="eCallInfo" type="Boolean" mandatory="false"> <description>Emergency Call notification and confirmation data</description> @@ -5337,7 +5354,6 @@ <description>Information related to the MyKey feature</description> </param> <!-- / Ford Specific Data Items --> - <param name="cloudAppVehicleID" type="Boolean" mandatory="false"></param> </function> <function name="GetVehicleData" messagetype="response"> @@ -5413,6 +5429,10 @@ <param name="electronicParkBrakeStatus" type="Common.ElectronicParkBrakeStatus" mandatory="false"> <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> </param> + <param name="cloudAppVehicleID" type="String" mandatory="false"> + <description>Parameter used by cloud apps to identify a head unit</description> + </param> + <!-- Ford Specific Data Items --> <param name="eCallInfo" type="Common.ECallInfo" mandatory="false"> <description>Emergency Call notification and confirmation data</description> @@ -5430,7 +5450,6 @@ <description>Information related to the MyKey feature</description> </param> <!-- / Ford Specific Data Items --> - <param name="cloudAppVehicleID" type="String" mandatory="false"></param> </function> <function name="OnVehicleData" messagetype="notification"> @@ -5504,6 +5523,10 @@ <param name="steeringWheelAngle" type="Float" minvalue="-2000" maxvalue="2000" mandatory="false"> <description>Current angle of the steering wheel (in deg)</description> </param> + <param name="cloudAppVehicleID" type="String" mandatory="false"> + <description>Parameter used by cloud apps to identify a head unit</description> + </param> + <!-- Ford Specific Data Items --> <param name="eCallInfo" type="Common.ECallInfo" mandatory="false"> <description>Emergency Call notification and confirmation data</description> @@ -5521,7 +5544,6 @@ <description>Information related to the MyKey feature</description> </param> <!-- / Ford Specific Data Items --> - <param name="cloudAppVehicleID" type="String" mandatory="false"></param> </function> </interface> diff --git a/src/components/interfaces/MOBILE_API.xml b/src/components/interfaces/MOBILE_API.xml index a23414df75..0be8e15162 100644 --- a/src/components/interfaces/MOBILE_API.xml +++ b/src/components/interfaces/MOBILE_API.xml @@ -542,7 +542,7 @@ <element name="VEHICLEDATA_FUELRANGE" since="5.0" /> <element name="VEHICLEDATA_ENGINEOILLIFE" since="5.0" /> <element name="VEHICLEDATA_ELECTRONICPARKBRAKESTATUS" since="5.0" /> - <element name="VEHICLEDATA_CLOUDAPPVEHICLEID" since="5.0"/> + <element name="VEHICLEDATA_CLOUDAPPVEHICLEID" since="5.1"/> </enum> <enum name="ButtonName" since="1.0"> @@ -4940,7 +4940,10 @@ <param name="electronicParkBrakeStatus" type="Boolean" mandatory="false" since="5.0"> <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> </param> - + <param name="cloudAppVehicleID" type="Boolean" mandatory="false"> + <description>Parameter used by cloud apps to identify a head unit</description> + </param> + <!-- Ford Specific Data Items --> <param name="eCallInfo" type="Boolean" mandatory="false"> <description>Emergency Call notification and confirmation data</description> @@ -4960,7 +4963,6 @@ <!-- / Ford Specific Data Items --> - <param name="cloudAppVehicleID" type="Boolean" mandatory="false"></param> </function> <function name="SubscribeVehicleData" functionID="SubscribeVehicleDataID" messagetype="response" since="2.0"> @@ -5056,7 +5058,10 @@ <param name="electronicParkBrakeStatus" type="VehicleDataResult" mandatory="false" since="5.0"> <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> </param> - + <param name="cloudAppVehicleID" type="VehicleDataResult" mandatory="false"> + <description>Parameter used by cloud apps to identify a head unit</description> + </param> + <!-- Ford Specific Data Items --> <param name="eCallInfo" type="VehicleDataResult" mandatory="false"> <description>Emergency Call notification and confirmation data</description> @@ -5075,7 +5080,6 @@ </param> <!-- / Ford Specific Data Items --> - <param name="cloudAppVehicleID" type="VehicleDataResult" mandatory="false"></param> </function> <function name="UnsubscribeVehicleData" functionID="UnsubscribeVehicleDataID" messagetype="request" since="2.0"> @@ -5150,6 +5154,9 @@ <param name="electronicParkBrakeStatus" type="Boolean" mandatory="false" since="5.0"> <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> </param> + <param name="cloudAppVehicleID" type="Boolean" mandatory="false"> + <description>Parameter used by cloud apps to identify a head unit</description> + </param> <!-- Ford Specific Data Items --> <param name="eCallInfo" type="Boolean" mandatory="false"> @@ -5169,7 +5176,6 @@ </param> <!-- / Ford Specific Data Items --> - <param name="cloudAppVehicleID" type="Boolean" mandatory="false"></param> </function> <function name="UnsubscribeVehicleData" functionID="UnsubscribeVehicleDataID" messagetype="response" since="2.0"> @@ -5264,6 +5270,9 @@ <param name="electronicParkBrakeStatus" type="VehicleDataResult" mandatory="false" since="5.0"> <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> </param> + <param name="cloudAppVehicleID" type="VehicleDataResult" mandatory="false"> + <description>Parameter used by cloud apps to identify a head unit</description> + </param> <!-- Ford Specific Data Items --> <param name="eCallInfo" type="VehicleDataResult" mandatory="false"> @@ -5283,7 +5292,6 @@ </param> <!-- / Ford Specific Data Items --> - <param name="cloudAppVehicleID" type="VehicleDataResult" mandatory="false"></param> </function> <function name="GetVehicleData" functionID="GetVehicleDataID" messagetype="request" since="2.0"> @@ -5361,6 +5369,9 @@ <param name="electronicParkBrakeStatus" type="Boolean" mandatory="false" since="5.0"> <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> </param> + <param name="cloudAppVehicleID" type="Boolean" mandatory="false"> + <description>Parameter used by cloud apps to identify a head unit</description> + </param> <!-- Ford Specific Data Items --> <param name="eCallInfo" type="Boolean" mandatory="false"> @@ -5380,7 +5391,6 @@ </param> <!-- / Ford Specific Data Items --> - <param name="cloudAppVehicleID" type="Boolean" mandatory="false"></param> </function> <function name="GetVehicleData" functionID="GetVehicleDataID" messagetype="response" since="2.0"> @@ -5479,6 +5489,9 @@ <param name="electronicParkBrakeStatus" type="ElectronicParkBrakeStatus" mandatory="false" since="5.0"> <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> </param> + <param name="cloudAppVehicleID" type="String" mandatory="false"> + <description>Parameter used by cloud apps to identify a head unit</description> + </param> <!-- Ford Specific Data Items --> <param name="eCallInfo" type="ECallInfo" mandatory="false"> @@ -5498,7 +5511,6 @@ </param> <!-- / Ford Specific Data Items --> - <param name="cloudAppVehicleID" type="String" mandatory="false"></param> </function> <function name="ReadDID" functionID="ReadDIDID" messagetype="request" since="2.0"> @@ -6739,6 +6751,9 @@ <param name="electronicParkBrakeStatus" type="ElectronicParkBrakeStatus" mandatory="false" since="5.0"> <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> </param> + <param name="cloudAppVehicleID" type="String" mandatory="false"> + <description>Parameter used by cloud apps to identify a head unit</description> + </param> <!-- Ford Specific Vehicle Data --> <param name="eCallInfo" type="ECallInfo" mandatory="false"> @@ -6758,7 +6773,6 @@ </param> <!-- / Ford Specific Vehicle Data --> - <param name="cloudAppVehicleID" type="String" mandatory="false"></param> </function> <function name="OnCommand" functionID="OnCommandID" messagetype="notification" since="1.0"> |