diff options
Diffstat (limited to 'src/components/interfaces/MOBILE_API.xml')
| -rw-r--r-- | src/components/interfaces/MOBILE_API.xml | 337 |
1 files changed, 321 insertions, 16 deletions
diff --git a/src/components/interfaces/MOBILE_API.xml b/src/components/interfaces/MOBILE_API.xml index f63cc097ab..2766bb48d0 100644 --- a/src/components/interfaces/MOBILE_API.xml +++ b/src/components/interfaces/MOBILE_API.xml @@ -361,6 +361,12 @@ <element name="ATTENUATED" /> <element name="NOT_AUDIBLE" /> </enum> + + <enum name="VideoStreamingState"> + <description>Enumeration that describes possible states of video streaming. </description> + <element name="STREAMABLE" /> + <element name="NOT_STREAMABLE" /> + </enum> <enum name="SystemAction"> <description>Enumeration that describes system actions that can be triggered.</description> @@ -441,6 +447,7 @@ <element name="LHPLUS_PHONEMES" /> <element name="PRE_RECORDED" /> <element name="SILENCE" /> + <element name="FILE" /> </enum> <enum name="VrCapabilities"> @@ -497,6 +504,7 @@ <element name="VEHICLEDATA_FUELLEVEL_STATE" /> <element name="VEHICLEDATA_FUELCONSUMPTION" /> <element name="VEHICLEDATA_EXTERNTEMP" /> + <element name="VEHICLEDATA_TURNSIGNAL" /> <element name="VEHICLEDATA_VIN" /> <element name="VEHICLEDATA_PRNDL" /> <element name="VEHICLEDATA_TIREPRESSURE" /> @@ -518,6 +526,7 @@ <element name="VEHICLEDATA_STEERINGWHEEL" /> <element name="VEHICLEDATA_FUELRANGE" /> <element name="VEHICLEDATA_ENGINEOILLIFE" /> + <element name="VEHICLEDATA_ELECTRONICPARKBRAKESTATUS" /> </enum> <enum name="ButtonName"> @@ -1094,6 +1103,61 @@ <element name="NOT_SUPPORTED" internal_name="CVS_NOT_SUPPORTED"> </element> </enum> + + <enum name="TPMS"> + <element name="UNKNOWN"> + <description>If set the status of the tire is not known.</description> + </element> + <element name="SYSTEM_FAULT"> + <description>TPMS does not function.</description> + </element> + <element name="SENSOR_FAULT"> + <description>The sensor of the tire does not function.</description> + </element> + <element name="LOW"> + <description>TPMS is reporting a low tire pressure for the tire.</description> + </element> + <element name="SYSTEM_ACTIVE"> + <description>TPMS is active and the tire pressure is monitored.</description> + </element> + <element name="TRAIN"> + <description>TPMS is reporting that the tire must be trained.</description> + </element> + <element name="TRAINING_COMPLETE"> + <description>TPMS reports the training for the tire is completed.</description> + </element> + <element name="NOT_TRAINED"> + <description>TPMS reports the tire is not trained.</description> + </element> + </enum> + + <enum name="ElectronicParkBrakeStatus"> + <element name="CLOSED"> + <description> + Park brake actuators have been fully applied. + </description> + </element> + <element name="TRANSITION"> + <description> + Park brake actuators are transitioning to either Apply/Closed or Release/Open state. + </description> + </element> + <element name="OPEN"> + <description> + Park brake actuators are released. + </description> + </element> + <element name="DRIVE_ACTIVE"> + <description> + When driver pulls the Electronic Park Brake switch while driving "at speed". + </description> + </element> + <element name="FAULT"> + <description> + When system has a fault or is under maintenance. + </description> + </element> + </enum> <enum name="FuelType"> <element name="GASOLINE" /> @@ -1129,6 +1193,12 @@ <param name="status" type="ComponentVolumeStatus" mandatory="true"> <description>See ComponentVolumeStatus.</description> </param> + <param name="tpms" type="TPMS" mandatory="false"> + <description>The status of TPMS according to the particular tire.</description> + </param> + <param name="pressure" type="Float" mandatory="false" minvalue="0" maxvalue="2000"> + <description>The pressure value of the particular tire in kilo pascal.</description> + </param> </struct> <enum name="WarningLightStatus"> @@ -1299,6 +1369,7 @@ <enum name="ModuleType"> <element name="CLIMATE"/> <element name="RADIO"/> + <element name="SEAT"/> </enum> <enum name="DefrostZone"> @@ -1724,6 +1795,23 @@ </param> </struct> + + <enum name="TurnSignal"> + <description>Enumeration that describes the status of the turn light indicator.</description> + <element name="OFF"> + <description>Turn signal is OFF</description> + </element> + <element name="LEFT"> + <description>Left turn signal is on</description> + </element> + <element name="RIGHT"> + <description>Right turn signal is on</description> + </element> + <element name="BOTH"> + <description>Both signals (left and right) are on.</description> + </element> + </enum> + <struct name="GPSData"> <description>Struct with the GPS data.</description> <param name="longitudeDegrees" type="Float" minvalue="-180" maxvalue="180" mandatory="true"> @@ -1946,6 +2034,9 @@ <param name="displayType" type="DisplayType" mandatory="true"> <description>The type of the display. See DisplayType</description> </param> + <param name="displayName" type="String" mandatory="false"> + <description>The name of the display the app is connected to.</description> + </param> <param name="textFields" type="TextField" minsize="1" maxsize="100" array="true" mandatory="true"> <description>A set of all fields that support text data. See TextField</description> </param> @@ -2061,15 +2152,15 @@ </param> </struct> <struct name="TTSChunk"> - <description>A TTS chunk, that consists of the text/phonemes to speak and the type (like text or SAPI)</description> + <description>A TTS chunk, that consists of text/phonemes to speak or the name of a file to play, and a TTS type (like text or SAPI)</description> <param name="text" minlength="0" maxlength="500" type="String" mandatory="true"> <description> - The text or phonemes to speak. + The text or phonemes to speak, or the name of the audio file to play. May not be empty. </description> </param> <param name="type" type="SpeechCapabilities" mandatory="true"> - <description>Describes, whether it is text or a specific phoneme set. See SpeechCapabilities</description> + <description>Describes whether the TTS chunk is plain text, a specific phoneme set, or an audio file. See SpeechCapabilities</description> </param> </struct> <struct name="Turn"> @@ -2186,6 +2277,7 @@ <element name="EMERGENCY" /> <element name="MEDIA" /> <element name="FOTA" /> + <element name="OEM_SPECIFIC" /> </enum> <enum name="AppHMIType"> <description>Enumeration listing possible app types.</description> @@ -2403,7 +2495,8 @@ <element name="OnHashChangeID" value="32782" hexvalue="800E" /> <element name="OnInteriorVehicleDataID" value="32783" hexvalue="800F" /> <element name="OnWayPointChangeID" value="32784" hexvalue="8010" /> - + <element name="OnRCStatusID" value="32785" hexvalue="8011" /> + <!-- Ford Specific Request / Response RPCs Range = 0x 0001 0000 - 0x 0001 7FFF @@ -2582,7 +2675,132 @@ </struct> <!---Remote control --> - + + <enum name="MassageZone"> + <description>List possible zones of a multi-contour massage seat.</description> + <element name="LUMBAR"> + <description>The back of a multi-contour massage seat. or SEAT_BACK</description> + </element> + <element name="SEAT_CUSHION"> + <description>The bottom a multi-contour massage seat. or SEAT_BOTTOM </description> + </element> + </enum> + + <enum name="MassageMode"> + <description>List possible modes of a massage zone.</description> + <element name="OFF"/> + <element name="LOW"/> + <element name="HIGH"/> + </enum> + + <struct name="MassageModeData"> + <description>Specify the mode of a massage zone.</description> + <param name="massageZone" type="MassageZone" mandatory="true"></param> + <param name="massageMode" type="MassageMode" mandatory="true"></param> + </struct> + + <enum name="MassageCushion"> + <description>List possible cushions of a multi-contour massage seat.</description> + <element name="TOP_LUMBAR"/> + <element name="MIDDLE_LUMBAR"/> + <element name="BOTTOM_LUMBAR"/> + <element name="BACK_BOLSTERS"/> + <element name="SEAT_BOLSTERS"/> + </enum> + + <struct name="MassageCushionFirmness"> + <description>The intensity or firmness of a cushion.</description> + <param name="cushion" type="MassageCushion" mandatory="true"></param> + <param name="firmness" type="Integer" minvalue="0" maxvalue="100" mandatory="true"></param> + </struct> + + <enum name="SeatMemoryActionType"> + <element name="SAVE"> + <description>Save current seat postions and settings to seat memory.</description> + </element> + <element name="RESTORE"> + <description>Restore / apply the seat memory settings to the current seat. </description> + </element> + <element name="NONE"> + <description>No action to be performed.</description> + </element> + </enum> + + <struct name="SeatMemoryAction"> + <param name="id" type="Integer" minvalue="1" maxvalue="10" mandatory="true"/> + <param name="label" type="String" maxlength="100" mandatory="false"/> + <param name="action" type="SeatMemoryActionType" mandatory="true"/> + </struct> + + <enum name="SupportedSeat"> + <description>List possible seats that is a remote controllable seat.</description> + <element name="DRIVER"/> + <element name="FRONT_PASSENGER"/> + </enum> + + <struct name="SeatControlData"> + <description>Seat control data corresponds to "SEAT" ModuleType. </description> + <param name="id" type="SupportedSeat" mandatory="true"></param> + + <param name="heatingEnabled" type="Boolean" mandatory="false"></param> + <param name="coolingEnabled" type="Boolean" mandatory="false"></param> + <param name="heatingLevel" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> + <param name="coolingLevel" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> + + <param name="horizontalPosition" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> + <param name="verticalPosition" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> + <param name="frontVerticalPosition" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> + <param name="backVerticalPosition" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> + <param name="backTiltAngle" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> + + <param name="headSupportHorizontalPosition" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> + <param name="headSupportVerticalPosition" type="Integer" minvalue="0" maxvalue="100" mandatory="false"></param> + + <param name="massageEnabled" type="Boolean" mandatory="false"></param> + <param name="massageMode" type="MassageModeData" minsize="1" maxsize="2" array="true" mandatory="false"></param> + <param name="massageCushionFirmness" type="MassageCushionFirmness" minsize="1" maxsize="5" array="true" mandatory="false"></param> + <param name="memory" type="SeatMemoryAction" mandatory="false"></param> + </struct> + + <struct name="SeatControlCapabilities"> + <param name="moduleName" type="String" maxlength="100" mandatory="true"> + <description> + The short friendly name of the light control module. + It should not be used to identify a module by mobile application. + </description> + </param> + <param name="heatingEnabledAvailable" type="Boolean" mandatory="false"> + </param> + <param name="coolingEnabledAvailable" type="Boolean" mandatory="false"> + </param> + <param name="heatingLevelAvailable" type="Boolean" mandatory="false"> + </param> + <param name="coolingLevelAvailable" type="Boolean" mandatory="false"> + </param> + <param name="horizontalPositionAvailable" type="Boolean" mandatory="false"> + </param> + <param name="verticalPositionAvailable" type="Boolean" mandatory="false"> + </param> + <param name="frontVerticalPositionAvailable" type="Boolean" mandatory="false"> + </param> + <param name="backVerticalPositionAvailable" type="Boolean" mandatory="false"> + </param> + <param name="backTiltAngleAvailable" type="Boolean" mandatory="false"> + </param> + <param name="headSupportHorizontalPositionAvailable" type="Boolean" mandatory="false"> + </param> + <param name="headSupportVerticalPositionAvailable" type="Boolean" mandatory="false"> + </param> + <param name="massageEnabledAvailable" type="Boolean" mandatory="false"> + </param> + <param name="massageModeAvailable" type="Boolean" mandatory="false"> + </param> + <param name="massageCushionFirmnessAvailable" type="Boolean" mandatory="false"> + </param> + <param name="memoryAvailable" type="Boolean" mandatory="false"> + </param> + </struct> + <struct name="Temperature"> <param name="unit" type="TemperatureUnit" mandatory="true"> <description>Temperature Unit</description> @@ -2671,16 +2889,6 @@ </param> </struct> - <struct name="ModuleData"> - <description>The moduleType indicates which type of data should be changed and identifies which data object exists in this struct. For example, if the moduleType is CLIMATE then a "climateControlData" should exist</description> - <param name="moduleType" type="ModuleType" mandatory="true"> - </param> - <param name="radioControlData" type="RadioControlData" mandatory="false"> - </param> - <param name="climateControlData" type="ClimateControlData" mandatory="false"> - </param> - </struct> - <struct name="RadioControlCapabilities"> <description>Contains information about a radio control module's capabilities.</description> <!-- need an ID in the future --> @@ -2819,6 +3027,18 @@ </param> </struct> + <struct name="ModuleData"> + <description>The moduleType indicates which type of data should be changed and identifies which data object exists in this struct. For example, if the moduleType is CLIMATE then a "climateControlData" should exist</description> + <param name="moduleType" type="ModuleType" mandatory="true"> + </param> + <param name="radioControlData" type="RadioControlData" mandatory="false"> + </param> + <param name="climateControlData" type="ClimateControlData" mandatory="false"> + </param> + <param name="seatControlData" type="SeatControlData" mandatory="false"> + </param> + </struct> + <struct name="RemoteControlCapabilities"> <param name="climateControlCapabilities" type="ClimateControlCapabilities" mandatory="false" minsize="1" maxsize="100" array="true"> <description>If included, the platform supports RC climate controls. For this baseline version, maxsize=1. i.e. only one climate control module is supported.</description > @@ -2829,6 +3049,11 @@ <param name="buttonCapabilities" type="ButtonCapabilities" mandatory="false" minsize="1" maxsize="100" array="true" > <description>If included, the platform supports RC button controls with the included button names.</description > </param> + <param name="seatControlCapabilities" type="SeatControlCapabilities" mandatory="false" minsize="1" maxsize="100" array="true"> + <description> + If included, the platform supports seat controls. + </description > + </param> </struct> <!-- End of RC --> @@ -3409,6 +3634,9 @@ <param name="menuName" maxlength="500" type="String" mandatory="true"> <description>Text to show in the menu for this sub menu.</description> </param> + <param name="menuIcon" type="Image" mandatory="false"> + <description>The image field for AddSubMenu</description> + </param> </function> <function name="AddSubMenu" functionID="AddSubMenuID" messagetype="response"> @@ -4132,6 +4360,9 @@ <param name="externalTemperature" type="Boolean" mandatory="false"> <description>The external temperature in degrees celsius</description> </param> + <param name="turnSignal" type="Boolean" mandatory="false"> + <description>See TurnSignal</description> + </param> <param name="prndl" type="Boolean" mandatory="false"> <description>See PRNDL</description> </param> @@ -4171,6 +4402,10 @@ <param name="engineOilLife" type="Boolean" mandatory="false"> <description>The estimated percentage of remaining oil life of the engine.</description> </param> + <param name="electronicParkBrakeStatus" type="Boolean" mandatory="false"> + <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> + </param> + <!-- Ford Specific Data Items --> <param name="eCallInfo" type="Boolean" mandatory="false"> @@ -4241,6 +4476,9 @@ <param name="externalTemperature" type="VehicleDataResult" mandatory="false"> <description>The external temperature in degrees celsius.</description> </param> + <param name="turnSignal" type="VehicleDataResult" mandatory="false"> + <description>See TurnSignal</description> + </param> <param name="prndl" type="VehicleDataResult" mandatory="false"> <description>See PRNDL</description> </param> @@ -4280,6 +4518,10 @@ <param name="engineOilLife" type="VehicleDataResult" mandatory="false"> <description>The estimated percentage of remaining oil life of the engine.</description> </param> + <param name="electronicParkBrakeStatus" type="VehicleDataResult" mandatory="false"> + <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> + </param> + <!-- Ford Specific Data Items --> <param name="eCallInfo" type="VehicleDataResult" mandatory="false"> @@ -4328,6 +4570,9 @@ <param name="externalTemperature" type="Boolean" mandatory="false"> <description>The external temperature in degrees celsius.</description> </param> + <param name="turnSignal" type="Boolean" mandatory="false"> + <description>See TurnSignal</description> + </param> <param name="prndl" type="Boolean" mandatory="false"> <description>See PRNDL</description> </param> @@ -4367,6 +4612,10 @@ <param name="engineOilLife" type="Boolean" mandatory="false"> <description>The estimated percentage of remaining oil life of the engine.</description> </param> + <param name="electronicParkBrakeStatus" type="Boolean" mandatory="false"> + <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> + </param> + <!-- Ford Specific Data Items --> <param name="eCallInfo" type="Boolean" mandatory="false"> @@ -4435,6 +4684,9 @@ <param name="externalTemperature" type="VehicleDataResult" mandatory="false"> <description>The external temperature in degrees celsius</description> </param> + <param name="turnSignal" type="VehicleDataResult" mandatory="false"> + <description>See TurnSignal</description> + </param> <param name="prndl" type="VehicleDataResult" mandatory="false"> <description>See PRNDL</description> </param> @@ -4474,6 +4726,10 @@ <param name="engineOilLife" type="VehicleDataResult" mandatory="false"> <description>The estimated percentage of remaining oil life of the engine.</description> </param> + <param name="electronicParkBrakeStatus" type="VehicleDataResult" mandatory="false"> + <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> + </param> + <!-- Ford Specific Data Items --> <param name="eCallInfo" type="VehicleDataResult" mandatory="false"> @@ -4522,6 +4778,9 @@ <param name="externalTemperature" type="Boolean" mandatory="false"> <description>The external temperature in degrees celsius</description> </param> + <param name="turnSignal" type="Boolean" mandatory="false"> + <description>See TurnSignal</description> + </param> <param name="vin" type="Boolean" mandatory="false"> <description>Vehicle identification number</description> </param> @@ -4564,6 +4823,10 @@ <param name="engineOilLife" type="Boolean" mandatory="false"> <description>The estimated percentage of remaining oil life of the engine.</description> </param> + <param name="electronicParkBrakeStatus" type="Boolean" mandatory="false"> + <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> + </param> + <!-- Ford Specific Data Items --> <param name="eCallInfo" type="Boolean" mandatory="false"> @@ -4633,6 +4896,9 @@ <param name="externalTemperature" type="Float" minvalue="-40" maxvalue="100" mandatory="false"> <description>The external temperature in degrees celsius</description> </param> + <param name="turnSignal" type="TurnSignal" mandatory="false"> + <description>See TurnSignal</description> + </param> <param name="vin" type="String" maxlength="17" mandatory="false"> <description>Vehicle identification number</description> </param> @@ -4675,6 +4941,10 @@ <param name="engineOilLife" type="Float" minvalue="0" maxvalue="100" mandatory="false"> <description>The estimated percentage of remaining oil life of the engine.</description> </param> + <param name="electronicParkBrakeStatus" type="ElectronicParkBrakeStatus" mandatory="false"> + <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> + </param> + <!-- Ford Specific Data Items --> <param name="eCallInfo" type="ECallInfo" mandatory="false"> @@ -5408,6 +5678,11 @@ Note that Proprietary requests should forward the binary data to the known proprietary module on the system. </description> </param> + <param name="requestSubType" type="String" maxlength="255" mandatory="false"> + <description> + This parameter is filled for supporting OEM proprietary data exchanges. + </description> + </param> <param name="fileName" type="String" maxlength="255" mandatory="false"> <description> Filename of HTTP data to store in predefined system staging area. @@ -5584,7 +5859,7 @@ In the future, this should be the Identification of a module. </description> </param> - <param name="subscribe" type="Boolean" mandatory="false" defvalue="false"> + <param name="subscribe" type="Boolean" mandatory="false"> <description> If subscribe is true, the head unit will register onInteriorVehicleData notifications for the requested moduelType. If subscribe is false, the head unit will unregister onInteriorVehicleData notifications for the requested moduelType. @@ -5808,6 +6083,9 @@ <param name="systemContext" type="SystemContext" mandatory="true"> <description>See SystemContext</description> </param> + <param name="videoStreamingState" type="VideoStreamingState" mandatory="true"> + <description>See VideoStreamingState. If it is NOT_STREAMABLE, the app must stop streaming video to SDL.</description> + </param> </function> <function name="OnAppInterfaceUnregistered" functionID="OnAppInterfaceUnregisteredID" messagetype="notification"> @@ -5864,6 +6142,9 @@ <param name="externalTemperature" type="Float" minvalue="-40" maxvalue="100" mandatory="false"> <description>The external temperature in degrees celsius</description> </param> + <param name="turnSignal" type="TurnSignal" mandatory="false"> + <description>See TurnSignal</description> + </param> <param name="vin" type="String" maxlength="17" mandatory="false"> <description>Vehicle identification number.</description> </param> @@ -5906,6 +6187,10 @@ <param name="engineOilLife" type="Float" minvalue="0" maxvalue="100" mandatory="false"> <description>The estimated percentage of remaining oil life of the engine.</description> </param> + <param name="electronicParkBrakeStatus" type="ElectronicParkBrakeStatus" mandatory="false"> + <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> + </param> + <!-- Ford Specific Vehicle Data --> <param name="eCallInfo" type="ECallInfo" mandatory="false"> @@ -6007,6 +6292,11 @@ <param name="requestType" type="RequestType" mandatory="true"> <description>The type of system request.</description> </param> + <param name="requestSubType" type="String" maxlength="255" mandatory="false"> + <description> + This parameter is filled for supporting OEM proprietary data exchanges. + </description> + </param> <param name="url" type="String" maxlength="1000" mandatory="false"> <description> Optional URL for HTTP requests. @@ -6052,6 +6342,21 @@ <param name="moduleData" type="ModuleData" mandatory="true"> </param> </function> + + <function name="OnRCStatus" functionID="OnRCStatusID" messagetype="notification"> + <description>Issued by SDL to notify the application about remote control status change on SDL</description> + <param name="allowed" type="Boolean" mandatory="false"> + <description> + If "true" - RC is allowed; if "false" - RC is disallowed. + </description> + </param> + <param name="allocatedModules" type="ModuleData" minsize="0" maxsize="100" array="true" mandatory="true"> + <description>Contains a list (zero or more) of module types that are allocated to the application.</description> + </param> + <param name="freeModules" type="ModuleData" minsize="0" maxsize="100" array="true" mandatory="true"> + <description>Contains a list (zero or more) of module types that are free to access for the application.</description> + </param> + </function> <!-- ~~~~~~~~~~~~~~~~~~ --> <!-- Ford Specific APIs --> |