diff options
Diffstat (limited to 'src/components/interfaces/HMI_API.xml')
| -rw-r--r-- | src/components/interfaces/HMI_API.xml | 323 |
1 files changed, 303 insertions, 20 deletions
diff --git a/src/components/interfaces/HMI_API.xml b/src/components/interfaces/HMI_API.xml index 0281b50956..bdbb60f98a 100644 --- a/src/components/interfaces/HMI_API.xml +++ b/src/components/interfaces/HMI_API.xml @@ -335,6 +335,20 @@ <element name="CLEAR" /> <description>Clears the media clock timer (previously done through Show->mediaClock)</description> </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="SystemContext"> <description>Enumeration that describes possible contexts the application might be in on HU.</description> @@ -730,6 +744,33 @@ </enum> <!--IVI part--> +<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" /> @@ -1020,6 +1061,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" /> @@ -1041,6 +1083,7 @@ <element name="VEHICLEDATA_STEERINGWHEEL" /> <element name="VEHICLEDATA_FUELRANGE" /> <element name="VEHICLEDATA_ENGINEOILLIFE" /> + <element name="VEHICLEDATA_ELECTRONICPARKBRAKESTATUS" /> </enum> <enum name="WiperStatus"> @@ -1094,21 +1137,35 @@ <enum name="SamplingRate"> <description>Describes different sampling options for PerformAudioPassThru.</description> - <element name="8KHZ" internal_name="RATE_8KHZ"/> - <element name="16KHZ" internal_name="RATE_16KHZ"/> - <element name="22KHZ" internal_name="RATE_22KHZ"/> - <element name="44KHZ" internal_name="RATE_44KHZ"/> + <element name="8KHZ" internal_name="RATE_8KHZ"> + <description>Sampling rate of 8000 Hz.</description> + </element> + <element name="16KHZ" internal_name="RATE_16KHZ"> + <description>Sampling rate of 16000 Hz.</description> + </element> + <element name="22KHZ" internal_name="RATE_22KHZ"> + <description>Sampling rate of 22050 Hz.</description> + </element> + <element name="44KHZ" internal_name="RATE_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="RATE_8_BIT"/> - <element name="16_BIT" internal_name="RATE_16_BIT"/> + <element name="8_BIT" internal_name="RATE_8_BIT"> + <description>Audio sample is 8 bits wide, unsigned.</description> + </element> + <element name="16_BIT" internal_name="RATE_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> <enum name="KeyboardLayout"> @@ -1453,21 +1510,21 @@ <element name="UPDATING" /> <element name="UPDATE_NEEDED"/> </enum> - + <enum name="SystemError"> <element name="SYNC_REBOOTED"/> <element name="SYNC_OUT_OF_MEMMORY" /> </enum> - + <enum name="StatisticsType"> <element name="iAPP_BUFFER_FULL"/> </enum> - + <enum name="ConsentSource"> <element name="GUI"/> <element name="VUI" /> </enum> - + <enum name="DeviceState"> <element name="UNKNOWN"/> <element name="UNPAIRED"/> @@ -1480,7 +1537,7 @@ <param name="line2" type="String" mandatory="false"/> <param name="textBody" type="String" mandatory="false"/> </struct> - + <struct name="PermissionItem"> <param name="name" type="String" mandatory="true"> <description>Code of message of user-friendly text about functional group to be allowed/disallowed</description> @@ -1491,7 +1548,7 @@ <param name="allowed" type="Boolean" mandatory="false"> <description>Specifies whether functionality was allowed/disallowed. If ommited - no information about User Consent is yet found for app.</description> </param> - </struct> + </struct> <struct name="ServiceInfo"> <param name="url" type="String" mandatory="true"> <description>Get URL based on service type.</description> @@ -1523,7 +1580,133 @@ <enum name="ModuleType"> <element name="CLIMATE"/> <element name="RADIO"/> - </enum> + <element name="SEAT"/> +</enum> + + <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> <enum name="RadioBand"> <element name="AM"/> @@ -1791,6 +1974,8 @@ </param> <param name="climateControlData" type="Common.ClimateControlData" mandatory="false"> </param> + <param name="seatControlData" type="SeatControlData" mandatory="false"> + </param> </struct> <enum name="RCAccessMode"> @@ -1973,6 +2158,9 @@ <param name="deviceInfo" type="Common.DeviceInfo" mandatory="true"> <description>The ID, serial number, transport type the named-app's-device is connected over to HU.</description> </param> + <param name="secondaryDeviceInfo" type="Common.DeviceInfo" mandatory="false"> + <description>The ID, serial number, transport type that are acquired through Secondary Transport.</description> + </param> <param name="policyAppID" type="String" maxlength="50" minlength="1" mandatory="true"> <description>Policy ID(=the appID the application registers with) of registered application.</description> </param> @@ -2024,7 +2212,7 @@ </description> </param> <param name="dayColorScheme" type="Common.TemplateColorScheme" mandatory="false"></param> - <param name="nightColorScheme" type="Common.TemplateColorScheme" mandatory="false"></param> + <param name="nightColorScheme" type="Common.TemplateColorScheme" mandatory="false"></param> </struct> <struct name="MenuParams"> @@ -2222,6 +2410,7 @@ <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="Common.SamplingRate" mandatory="true"/> <param name="bitsPerSample" type="Common.BitsPerSample" mandatory="true"/> @@ -2292,6 +2481,22 @@ </struct> <!--IVI part--> +<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="false"> @@ -2602,7 +2807,7 @@ <struct name="DateTime"> <param name="millisecond" type="Integer" minvalue="0" maxvalue="999" mandatory="false"> - <description>Milliseconds </description> + <description>Milliseconds </description> </param> <param name="second" type="Integer" minvalue="0" maxvalue="60" mandatory="false"> <description>Seconds part of time</description> @@ -2740,6 +2945,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> <struct name="Rectangle"> @@ -2854,6 +3064,17 @@ </interface> <interface name="BasicCommunication" version="1.2.1" date="2017-08-02"> + <function name="GetSystemTime" messagetype="request"> + <description>Request from SDL to HMI to obtain current UTC time.</description> + </function> + <function name="GetSystemTime" messagetype="response"> + <param name="systemTime" type="Common.DateTime" mandatory="true"> + <description>Current UTC system time</description> + </param> + </function> + <function name="OnSystemTimeReady" messagetype="notification"> + <description>HMI must notify SDL about readiness to provide system time.</description> + </function> <function name="OnReady" messagetype="notification"> <description>HMI must notify SDL about its readiness to start communication. In fact, this has to be the first message between SDL and HMI.</description> </function> @@ -3572,6 +3793,9 @@ <param name="menuParams" type="Common.MenuParams" mandatory="true"> <description>Position and name of menu to be added. 'parent' field is omitted for this RPC. </description> </param> + <param name="menuIcon" type="Common.Image" mandatory="false"> + <description>The image field for AddSubMenu</description> + </param> <param name="appID" type="Integer" mandatory="true"> <description>ID of application that requested this RPC.</description> </param> @@ -3642,6 +3866,9 @@ <description>The update method of the media clock.</description> <description>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="Common.AudioStreamingIndicator" mandatory="false"> + <description>Indicates that a button press of the Play/Pause button would play, pause or Stop the current playback.</description> + </param> <param name="appID" type="Integer" mandatory="true"> <description>ID of application that requested this RPC.</description> </param> @@ -3788,7 +4015,7 @@ <description>ID of application related to this RPC.</description> </param> <param name="dayColorScheme" type="Common.TemplateColorScheme" mandatory="false"></param> - <param name="nightColorScheme" type="Common.TemplateColorScheme" mandatory="false"></param> + <param name="nightColorScheme" type="Common.TemplateColorScheme" mandatory="false"></param> </function> <function name="SetDisplayLayout" messagetype="response"> <param name="displayCapabilities" type="Common.DisplayCapabilities" mandatory="false"> @@ -3983,7 +4210,7 @@ </function> </interface> -<interface name="Navigation" version="1.5.0" date="2017-08-15"> +<interface name="Navigation" version="1.5.0" date="2017-08-15"> <function name="IsReady" messagetype="request"> <description>Method is invoked at system startup. Response must provide the information about presence of UI Navigation module and its readiness to cooperate with SDL.</description> @@ -4320,6 +4547,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> @@ -4359,6 +4589,9 @@ <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"> <description>Emergency Call notification and confirmation data</description> @@ -4402,6 +4635,9 @@ <param name="externalTemperature" type="Common.VehicleDataResult" mandatory="false"> <description>The external temperature in degrees celsius.</description> </param> + <param name="turnSignal" type="Common.VehicleDataResult" mandatory="false"> + <description>See TurnSignal</description> + </param> <param name="prndl" type="Common.VehicleDataResult" mandatory="false"> <description>See PRNDL</description> </param> @@ -4441,6 +4677,9 @@ <param name="engineOilLife" type="Common.VehicleDataResult" mandatory="false"> <description>The estimated percentage of remaining oil life of the engine.</description> </param> + <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> <!-- Ford Specific Data Items --> <param name="eCallInfo" type="Common.VehicleDataResult" mandatory="false"> <description>Emergency Call notification and confirmation data</description> @@ -4490,6 +4729,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> @@ -4529,6 +4771,9 @@ <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"> <description>Emergency Call notification and confirmation data</description> @@ -4572,6 +4817,9 @@ <param name="externalTemperature" type="Common.VehicleDataResult" mandatory="false"> <description>The external temperature in degrees celsius</description> </param> + <param name="turnSignal" type="Common.VehicleDataResult" mandatory="false"> + <description>See TurnSignal</description> + </param> <param name="prndl" type="Common.VehicleDataResult" mandatory="false"> <description>See PRNDL</description> </param> @@ -4611,6 +4859,9 @@ <param name="engineOilLife" type="Common.VehicleDataResult" mandatory="false"> <description>The estimated percentage of remaining oil life of the engine.</description> </param> + <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> <!-- Ford Specific Data Items --> <param name="eCallInfo" type="Common.VehicleDataResult" mandatory="false"> <description>Emergency Call notification and confirmation data</description> @@ -4655,6 +4906,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> @@ -4697,6 +4951,9 @@ <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> <param name="eCallInfo" type="Boolean" mandatory="false"> <description>Emergency Call notification and confirmation data</description> </param> @@ -4738,6 +4995,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="Common.TurnSignal" mandatory="false"> + <description>See TurnSignal</description> + </param> <param name="vin" type="String" maxlength="17" mandatory="false"> <description>Vehicle identification number</description> </param> @@ -4780,6 +5040,9 @@ <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="Common.ElectronicParkBrakeStatus" mandatory="false"> + <description>The status of the park brake as provided by Electric Park Brake (EPB) system.</description> + </param> <param name="eCallInfo" type="Common.ECallInfo" mandatory="false"> <description>Emergency Call notification and confirmation data</description> </param> @@ -4817,11 +5080,14 @@ <description>The instantaneous fuel consumption in microlitres</description> </param> <param name="fuelRange" type="Common.FuelRange" minsize="0" maxsize="100" array="true" mandatory="false"> - <description>The estimate range in KM the vehicle can travel based on fuel level and consumption</description> + <description>The estimate range in KM the vehicle can travel based on fuel level and consumption</description> </param> <param name="externalTemperature" type="Float" minvalue="-40" maxvalue="100" mandatory="false"> <description>The external temperature in degrees celsius</description> </param> + <param name="turnSignal" type="Common.TurnSignal" mandatory="false"> + <description>See TurnSignal</description> + </param> <param name="vin" type="String" maxlength="17" mandatory="false"> <description>Vehicle identification number.</description> </param> @@ -4837,6 +5103,9 @@ <param name="beltStatus" type="Common.BeltStatus" mandatory="false"> <description>The status of the seat belts</description> </param> + <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="bodyInformation" type="Common.BodyInformation" mandatory="false"> <description>The body information including power modes</description> </param> @@ -5091,7 +5360,7 @@ <param name="moduleType" type="Common.ModuleType" mandatory="true" > <description>The module data to retrieve from the vehicle for that type</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 send onInteriorVehicleData notifications for the module type</description> </param> <param name="appID" type="Integer" mandatory="true"> @@ -5141,5 +5410,19 @@ <description>The remote control access mode specified by the driver via HMI.</description> </param> </function> + +<function name="OnRCStatus" messagetype="notification"> + <description>Issued by SDL to notify HMI about remote control status change on SDL</description> + <param name="appID" type="Integer" mandatory="true"> + <description>ID of selected application.</description> + </param> + <param name="allocatedModules" type="Common.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="Common.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> + </interface> </interfaces> |