diff options
Diffstat (limited to 'src/components/interfaces/MOBILE_API.xml')
| -rw-r--r-- | src/components/interfaces/MOBILE_API.xml | 320 |
1 files changed, 300 insertions, 20 deletions
diff --git a/src/components/interfaces/MOBILE_API.xml b/src/components/interfaces/MOBILE_API.xml index 8b8da6a63a..97bc33ceae 100644 --- a/src/components/interfaces/MOBILE_API.xml +++ b/src/components/interfaces/MOBILE_API.xml @@ -302,6 +302,20 @@ <description>Clears the media clock timer (previously done through Show->mediaClock)</description> </element> </enum> + <enum name="AudioStreamingIndicator"> + <element name="PLAY_PAUSE"> + <description>Default playback indicator.</description> + </element> + <element name="PLAY"> + <description>Indicates that a button press of the Play/Pause button would start the playback.</description> + </element> + <element name="PAUSE"> + <description>Indicates that a button press of the Play/Pause button would pause the current playback.</description> + </element> + <element name="STOP"> + <description>Indicates that a button press of the Play/Pause button would stop the current playback.</description> + </element> + </enum> <enum name="TimerMode"> <element name="UP" > @@ -466,27 +480,42 @@ <enum name="SamplingRate"> <description>Describes different sampling options for PerformAudioPassThru.</description> - <element name="8KHZ" internal_name="SamplingRate_8KHZ"/> - <element name="16KHZ" internal_name="SamplingRate_16KHZ"/> - <element name="22KHZ" internal_name="SamplingRate_22KHZ"/> - <element name="44KHZ" internal_name="SamplingRate_44KHZ"/> + <element name="8KHZ" internal_name="SamplingRate_8KHZ"> + <description>Sampling rate of 8000 Hz.</description> + </element> + <element name="16KHZ" internal_name="SamplingRate_16KHZ"> + <description>Sampling rate of 16000 Hz.</description> + </element> + <element name="22KHZ" internal_name="SamplingRate_22KHZ"> + <description>Sampling rate of 22050 Hz.</description> + </element> + <element name="44KHZ" internal_name="SamplingRate_44KHZ"> + <description>Sampling rate of 44100 Hz.</description> + </element> </enum> <enum name="BitsPerSample"> <description>Describes different quality options for PerformAudioPassThru.</description> - <element name="8_BIT" internal_name="BitsPerSample_8_BIT"/> - <element name="16_BIT" internal_name="BitsPerSample_16_BIT"/> + <element name="8_BIT" internal_name="BitsPerSample_8_BIT"> + <description>Audio sample is 8 bits wide, unsigned.</description> + </element> + <element name="16_BIT" internal_name="BitsPerSample_16_BIT"> + <description>Audio sample is 16 bits wide, signed, and in little endian.</description> + </element> </enum> <enum name="AudioType"> <description>Describes different audio type options for PerformAudioPassThru.</description> - <element name="PCM" /> + <element name="PCM"> + <description>Linear PCM.</description> + </element> </enum> <struct name="AudioPassThruCapabilities"> <description> Describes different audio type configurations for PerformAudioPassThru. e.g. {8kHz,8-bit,PCM} + The audio is recorded in monaural. </description> <param name="samplingRate" type="SamplingRate" mandatory="true"/> <param name="bitsPerSample" type="BitsPerSample" mandatory="true"/> @@ -504,6 +533,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" /> @@ -525,6 +555,7 @@ <element name="VEHICLEDATA_STEERINGWHEEL" /> <element name="VEHICLEDATA_FUELRANGE" /> <element name="VEHICLEDATA_ENGINEOILLIFE" /> + <element name="VEHICLEDATA_ELECTRONICPARKBRAKESTATUS" /> </enum> <enum name="ButtonName"> @@ -1129,6 +1160,34 @@ </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" /> <element name="DIESEL" /> @@ -1339,6 +1398,7 @@ <enum name="ModuleType"> <element name="CLIMATE"/> <element name="RADIO"/> + <element name="SEAT"/> </enum> <enum name="DefrostZone"> @@ -1764,6 +1824,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"> @@ -2447,7 +2524,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 @@ -2626,7 +2704,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> @@ -2715,16 +2918,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 --> @@ -2863,6 +3056,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 > @@ -2873,6 +3078,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 --> @@ -3453,6 +3663,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"> @@ -3967,6 +4180,9 @@ In case of pause, resume, or clear, the start time value is ignored and shall be left out. For resume, the time continues with the same value as it was when paused. </description> </param> + <param name="audioStreamingIndicator" type="AudioStreamingIndicator" mandatory="false"> + <description>Indicates that a button press of the Play/Pause button would play, pause or Stop the current playback.</description> + </param> </function> <function name="SetMediaClockTimer" functionID="SetMediaClockTimerID" messagetype="response"> @@ -4176,6 +4392,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> @@ -4215,6 +4434,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"> @@ -4285,6 +4508,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> @@ -4324,6 +4550,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"> @@ -4372,6 +4602,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> @@ -4411,6 +4644,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"> @@ -4479,6 +4716,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> @@ -4518,6 +4758,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"> @@ -4566,6 +4810,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> @@ -4608,6 +4855,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"> @@ -4677,6 +4928,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> @@ -4719,6 +4973,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"> @@ -5633,7 +5891,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. @@ -5916,6 +6174,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> @@ -5958,6 +6219,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"> @@ -6109,6 +6374,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 --> |