From 1df399beed9b523323240fb5fe7fcc9309669d2b Mon Sep 17 00:00:00 2001 From: "Andrii Kalinich (GitHub)" Date: Thu, 22 Jul 2021 09:59:04 -0400 Subject: adding the interface name to the types in HMI_API.xml (#3742) Co-authored-by: Roman Reznichenko --- src/components/interfaces/HMI_API.xml | 144 +++++++++++++++++----------------- 1 file changed, 72 insertions(+), 72 deletions(-) (limited to 'src') diff --git a/src/components/interfaces/HMI_API.xml b/src/components/interfaces/HMI_API.xml index 92806e7372..b185b88ada 100644 --- a/src/components/interfaces/HMI_API.xml +++ b/src/components/interfaces/HMI_API.xml @@ -1809,10 +1809,10 @@ uuid of a module. "moduleId + moduleType" uniquely identify a module. - + Location of a module. - + Service area of a module. @@ -1832,7 +1832,7 @@ - + Contains a list of SeatLocation in the vehicle @@ -1880,8 +1880,8 @@ Specify the mode of a massage zone. - - + + @@ -1895,7 +1895,7 @@ The intensity or firmness of a cushion. - + @@ -1914,7 +1914,7 @@ - + @@ -1925,7 +1925,7 @@ Seat control data corresponds to "SEAT" ModuleType. - + @@ -1941,9 +1941,9 @@ - - - + + + @@ -1953,7 +1953,7 @@ It should not be used to identify a module by mobile application. - + Information about a RC module, including its id. @@ -2107,13 +2107,13 @@ Identifies the 4-alpha-character station call sign plus an optional (-FM) extension - + Used for network Application. Consists of Country Code and FCC Facility ID. Identifies the station call sign or other identifying information in the long format. - + Provides the 3-dimensional geographic station location. @@ -2157,7 +2157,7 @@ - + Read-only Station Information Service (SIS) data provides basic information about the station such as call sign, as well as information not displayable to the consumer such as the station identification number @@ -2167,7 +2167,7 @@ The short name or a short description of the radio control module. - + Information about a RC module, including its id. @@ -2293,7 +2293,7 @@ - + @@ -2322,7 +2322,7 @@ The short name or a short description of the climate control module. - + Information about a RC module, including its id. @@ -2437,7 +2437,7 @@ - + In a getter response or a notification, it is the current primary audio source of the system. In a setter request, it is the target audio source that the system shall switch to. @@ -2456,7 +2456,7 @@ Reflects the volume of audio, from 0%-100%. - + Defines the list of supported channels (band) and their current/desired settings on HMI @@ -2468,7 +2468,7 @@ It should not be used to identify a module by mobile application. - + Information about a RC module, including its id. @@ -2605,7 +2605,7 @@ - + Indicates if the status (ON/OFF) can be set remotely. App shall not use read-only values (RAMP_UP/RAMP_DOWN/UNKNOWN/INVALID) in a setInteriorVehicleData request. @@ -2630,25 +2630,25 @@ It should not be used to identify a module by mobile application. - + Information about a RC module, including its id. - + An array of available light names that are controllable. - + The name of a light or a group of lights. - + - + - + An array of LightNames and their current or desired status. No change to the status of the LightNames that are not listed in the array. @@ -2665,9 +2665,9 @@ Corresponds to "HMI_SETTINGS" ModuleType - - - + + + @@ -2677,7 +2677,7 @@ It should not be used to identify a module by mobile application. - + Information about a RC module, including its id. @@ -2702,13 +2702,13 @@ - + - + - + - + @@ -2744,7 +2744,7 @@ The name of the Button from the ButtonName enum - + Information about a RC module, including its id. @@ -2886,8 +2886,8 @@ Currently only predefined window template layouts are defined. - - + + @@ -3280,7 +3280,7 @@ The status of component volume. See ComponentVolumeStatus. - + The status of TPMS according to the particular tire. @@ -3638,7 +3638,7 @@ - + Latitude/Longitude of the location. @@ -3653,10 +3653,10 @@ Phone number of location / establishment. - + Image / icon of intended location. - + Address to be used by navigation engines for search @@ -3708,24 +3708,24 @@ The preferred frame rate per second of the head unit. The mobile application / app library may take other factors into account that constrain the frame rate lower than this value, but it should not perform streaming at a higher frame rate than this value. - + - + Used as a descriptor of what data to expect in this struct. The corresponding param to this enum should be included and the only other param included. - + Describes supported capabilities for video streaming - + An array of ImageFieldName values for which the system supports sending OnFileUpdate notifications. If you send an Image struct for that image field with a name without having uploaded the image data using PutFile that matches that name, the system will request that you upload the data with PutFile at a later point when the HMI needs it. The HMI will then display the image in the appropriate field. If not sent, assume false. @@ -3743,7 +3743,7 @@ Describes the capabilities of a single keyboard layout. - + Number of keys available for special characters, App can customize as per their needs. @@ -3753,7 +3753,7 @@ Availability of capability to mask input characters using keyboard. True: Available, False: Not Available - + Capabilities of supported keyboard layouts by HMI. @@ -3765,13 +3765,13 @@ or omitted for the main window on the main display. - + A set of all fields that support text data. See TextField - + A set of all fields that support images. See ImageField - + Provides information about image types supported by the system. @@ -3780,19 +3780,19 @@ The number of on-window custom presets available (if any); otherwise omitted. - + The number of buttons and the capabilities of each on-window button. - + The number of soft buttons available on-window and the capabilities for each button. An array of available menu layouts. If this parameter is not provided, only the `LIST` layout is assumed to be available - + Contains the head unit's capabilities for dynamic updating features declaring if the module will send dynamic update RPCs. - + See KeyboardCapabilities @@ -3800,12 +3800,12 @@ Contains information about the display capabilities. - + Informs the application how many windows the app is allowed to create per type. - + Contains a list of capabilities of all windows related to the app. Once the app has registered the capabilities of all windows are provided. @@ -3830,39 +3830,39 @@ - + - + - + - + Describes capabilities when the driver is distracted - + If included, the platform supports RC climate controls. For this baseline version, maxsize=1. i.e. only one climate control module is supported. - + If included, the platform supports RC radio controls. For this baseline version, maxsize=1. i.e. only one climate control module is supported. - + If included, the platform supports RC button controls with the included button names. - + If included, the platform supports seat controls. - + If included, the platform supports audio controls. - + If included, the platform supports hmi setting controls. - + If included, the platform supports light controls. @@ -4395,10 +4395,10 @@ - + Contains information about the locations of each seat - + Describes capabilities when the driver is distracted @@ -4471,7 +4471,7 @@ The seek next / skip previous subscription buttons' content - + If the type is TIME, this number of seconds may be present alongside the skip indicator. -- cgit v1.2.1