Feature/Remote Control - Allow Multiple Modules per Module Type

config.json

@@ -488,6 +488,9 @@
             },
             {
               "name": "OnRCStatus"
+            },
+            {
+              "name": "SetGlobalProperties"
             }
           ]
         },

docs/Buttons/ButtonPress/index.md

@@ -30,6 +30,7 @@ The system shall list all available RC radio buttons and RC climate buttons in t
 |Name|Type|Mandatory|Additional|Description|
 |:---|:----------|:---|:---------|:---------|
 |moduleType|[Common.ModuleType](../../common/enums/#moduletype)|true| |The module where the button should be pressed|
+|moduleId|String|false|maxlength="100"|Id of a module, published by System Capability.|
 |buttonName|[Common.ButtonName](../../common/enums/#buttonname)|true| | |
 |buttonPressMode|[Common.ButtonPressMode](../../common/enums/#buttonpressmode)|true| |Indicates whether this is a LONG or SHORT button press event.|
 |appID|Integer|true| |Internal SDL-assigned ID of the related application|

docs/Common/Enums/index.md

@@ -1145,13 +1145,6 @@
 |RESTORE|1|Restore / apply the seat memory settings to the current seat.|
 |NONE|2|No action to be performed.|
 
-### SupportedSeat
-
-|Name|Value|Description|
-|:---|:----|:----------|
-|DRIVER|0|List possible seats that is a remote controllable seat.|
-|FRONT_PASSENGER|1|List possible seats that is a remote controllable seat.|
-
 ### DeliveryMode
 |Name|Value|Description|
 |:---|:----|:----------|
@@ -1187,6 +1180,7 @@
 |REMOTE_CONTROL|3||
 |APP_SERVICES|4||
 |DISPLAYS|5||
+|SEAT_LOCATION|6||
 
 ### MediaType
 

docs/Common/Structs/index.md

@@ -1,4 +1,4 @@
-## Structs
+## Structs
 
 ### ImageResolution
 
@@ -269,6 +269,7 @@
 |shortPressAvailable|Boolean|true|||
 |longPressAvailable|Boolean|true|||
 |upDownAvailable|Boolean|true|||
+|moduleInfo|Common.ModuleInfo|false||Information about a RC module, including its id.|
 
 ### VrHelpItem
 
@@ -495,6 +496,7 @@
 |Name|Type|Mandatory|Additional|Description|
 |:---|:---|:--------|:---------|:----------|
 |moduleType|Common.ModuleType|true||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|
+|moduleId|String|false|maxlength: 100|Id of a module, published by System Capability.|
 |radioControlData|Common.RadioControlData|false|||
 |climateControlData|Common.ClimateControlData|false|||
 |audioControlData|Common.AudioControlData|false|||
@@ -591,6 +593,7 @@
 |Name|Type|Mandatory|Additional|Description|
 |:---|:---|:--------|:---------|:----------|
 |moduleName|String|true|maxlength: 100|The short friendly name of the climate control module. It should not be used to identify a module by mobile application.|
+|moduleInfo|Common.ModuleInfo|false||Information about a RC module, including its id.|
 |fanSpeedAvailable|Boolean|false||Availability of the control of fan speed <br> True: Available, False: Not Available, Not present: Not Available.|
 |desiredTemperatureAvailable|Boolean|false||Availability of the control of desired temperature. <br> True: Available, False: Not Available, Not present: Not Available.|
 |acEnableAvailable|Boolean|false||Availability of the control of turn on/off AC. <br> True: Available, False: Not Available, Not present: Not Available.|
@@ -613,6 +616,7 @@
 |Name|Type|Mandatory|Additional|Description|
 |:---|:---|:--------|:---------|:----------|
 |moduleName|String|true|maxlength="100"|The short friendly name of the light control module. <br> It should not be used to identify a module by mobile application.|
+|moduleInfo|Common.ModuleInfo|false||Information about a RC module, including its id.|
 |sourceAvailable|Boolean|false||Availability of the control of audio source.|
 |keepContextAvailable|Boolean|false||Availability of the parameter keepContext.|
 |volumeAvailable|Boolean|false||Availability of the control of audio volume.|
@@ -652,6 +656,7 @@
 |Name|Type|Mandatory|Additional|Description|
 |:---|:---|:--------|:---------|:----------|
 |moduleName|String|true|maxlength="100"|The short friendly name of the light control module. <br> It should not be used to identify a module by mobile application.|
+|moduleInfo|Common.ModuleInfo|false||Information about a RC module, including its id.|
 |supportedLights|Common.LightCapabilities|true|minsize="1" <br> maxsize="100" <br> array="true"| An array of available LightCapabilities that are controllable.|
 
 
@@ -677,6 +682,7 @@
 |Name|Type|Mandatory|Additional|Description|
 |:---|:---|:--------|:---------|:----------|
 |moduleName|String|true|maxlength="100"|The short friendly name of the hmi setting module. <br> It should not be used to identify a module by mobile application.|
+|moduleInfo|Common.ModuleInfo|false||Information about a RC module, including its id.|
 |distanceUnitAvailable|Boolean|false||Availability of the control of distance unit.|
 |temperatureUnitAvailable|Boolean|false||Availability of the control of temperature unit.|
 |displayModeUnitAvailable|Boolean|false||Availability of the control of HMI display mode.|
@@ -695,6 +701,7 @@
 |Name|Type|Mandatory|Additional|Description|
 |:---|:---|:--------|:---------|:----------|
 |moduleName|String|true|maxlength: 100| The short friendly name of the climate control module. <br> It should not be used to identify a module by mobile application.|
+|moduleInfo|Common.ModuleInfo|false||Information about a RC module, including its id.|
 |radioEnableAvailable|Boolean|false||Availability of the control of enable/disable radio. <br> True: Available, False: Not Available, Not present: Not Available.|
 |radioBandAvailable|Boolean|false||Availability of the control of radio band. <br> True: Available, False: Not Available, Not present: Not Available.|
 |radioFrequencyAvailable|Boolean|false||Availability of the control of radio frequency. <br> True: Available, False: Not Available, Not present: Not Available.|
@@ -764,7 +771,7 @@
 
 |Name|Type|Mandatory|Additional|Description|
 |:---|:---|:--------|:---------|:----------|
-|id|Common.SupportedSeat|true|||
+|id|Common.SupportedSeat|false||
 |heatingEnabled|Boolean|false||
 |coolingEnabled|Boolean|false||
 |heatingLevel|Integer|false|minvalue="0" <br> maxvalue="100"||
@@ -786,6 +793,7 @@
 |Name|Type|Mandatory|Additional|Description|
 |:---|:---|:--------|:---------|:----------|
 |moduleName|String|true|maxlength="100"|The short friendly name of the light control module. <br> It should not be used to identify a module by mobile application.|
+|moduleInfo|Common.ModuleInfo|false||Information about a RC module, including its id.|
 |heatingEnabledAvailable|Boolean|false|||
 |coolingEnabledAvailable|Boolean|false|||
 |heatingLevelAvailable|Boolean|false|||
@@ -895,6 +903,7 @@
 |videoStreamingCapability|Common.VideoStreamingCapability|false||Describes extended capabilities of the module's phone feature|
 |remoteControlCapability|Common.RemoteControlCapabilities|false||Describes extended capabilities of the module's phone feature|
 |appServicesCapabilities|Common.AppServicesCapabilities|false||An array of currently available services. If this is an update to the capability the affected services will include an update reason in that item|
+|seatLocationCapability|Common.SeatLocationCapability|false||Contains information about the locations of each seat|
 
 ### MediaServiceManifest
 
@@ -1043,3 +1052,34 @@ There are no defined parameters for this struct.
 |numCustomPresetsAvailable|Integer|false|minvalue: 1 <br>maxvalue: 100|The number of on-window custom presets available (if any); otherwise omitted.|
 |buttonCapabilities|Common.ButtonCapabilities|false|array: true<br>minsize: 1<br>maxsize: 100|The number of buttons and the capabilities of each on-window button.|
 |softButtonCapabilities|Common.SoftButtonCapabilities|false|array: true<br>minsize: 1<br>maxsize: 100|The number of soft buttons available on-window and the capabilities for each button.|
+
+### ModuleInfo
+|Name|Type|Mandatory|Additional|Description|
+|:---|:---|:--------|:---------|:----------|
+|moduleId|String|true|maxlength: 100|uuid of a module. "moduleId + moduleType" uniquely identify a module.| 
+|location|Common.Grid|false||Location of a module.|
+|serviceArea|Common.Grid|false||Service area of a module.|
+|allowMultipleAccess|Boolean|false|defValue: true|allow multiple users/apps to access the module or not|
+
+### Grid
+|Name|Type|Mandatory|Additional|Description|
+|:---|:---|:--------|:---------|:----------|
+|col|Integer|true|minvalue: -1 <br>maxvalue: 100|Describes a location (origin coordinates and span) of a vehicle component.|
+|row|Integer|true|minvalue: -1 <br>maxvalue: 100|Describes a location (origin coordinates and span) of a vehicle component.|
+|level|Integer|false|minvalue: -1 <br> maxvalue: 100 <br> defvalue: 0|Describes a location (origin coordinates and span) of a vehicle component.|
+|colspan|Integer|false|minvalue: 1 <br> maxvalue: 100 <br> defvalue: 1|Describes a location (origin coordinates and span) of a vehicle component.|
+|rowspan|Integer|false|minvalue: 1 <br> maxvalue: 100 <br> defvalue: 1|Describes a location (origin coordinates and span) of a vehicle component.|
+|levelspan|Integer|false|minvalue: 1 <br> maxvalue: 100 <br> defvalue: 1|Describes a location (origin coordinates and span) of a vehicle component.|
+
+### SeatLocationCapability
+|Name|Type|Mandatory|Additional|Description|
+|:---|:---|:--------|:---------|:----------|
+|rows|Integer|false|minvalue: 1 <br>maxvalue: 100|Contains information about the locations of each seat.|
+|columns|Integer|false|minvalue: 1 <br>maxvalue: 100|Contains information about the locations of each seat.|
+|levels|Integer|false|minvalue: 1 <br>maxvalue: 100 <br> defvalue:1|Contains information about the locations of each seat.|
+|seats|Common.SeatLocation|false|array: true|Contains a list of SeatLocation in the vehicle, the first element is the driver's seat|
+
+### SeatLocation
+|Name|Type|Mandatory|Additional|Description|
+|:---|:---|:--------|:---------|:----------|
+|grid|Common.Grid|false||Describes the location of a seat. HMI shall include this parameter when publishing seat locations in capabilities.|

docs/RC/GetCapabilities/index.md

@@ -19,12 +19,21 @@ The [`RemoteControlCapabilities`](../../common/structs/#remotecontrolcapabilitie
 This RPC has no additional parameter requirements
 
 ### Response
+!!! must 
+
+1. Provide `moduleInfo` with `moduleID` for each module of all module types in GetCapabilities_respose to SDL if it supports multiple modules per module type.  
+2. Determine and provide default `moduleID` for the moduleType and publish it as the first item in RemoteControlCapabilities.
+3. Publish how many rows, columns and levels are available for the vehicle and the list of modules in properly defined grids.
+
+!!!
+
 
 #### Parameters
 
 |Name|Type|Mandatory|Additional|
 |:---|:---|:--------|:---------|
 |remoteControlCapability|[Common.RemoteControlCapabilities](../../common/structs/#remotecontrolcapabilities)|false|See RemoteControlCapabilities, all available RC modules and buttons shall be returned|
+|seatLocationCapability|[Common.SeatLocationCapability](../../common/structs/#seatlocationcapability)|false|See SeatLocationCapability, all available seat locations shall be returned.|
 
 ### Sequence Diagrams
 

docs/RC/GetInteriorVehicleData/index.md

@@ -10,29 +10,33 @@ Purpose
 : To read RC module status data. The same function is used to subscribe/unsubscribe to RC module status/setting change notifications.
 
 GetInteriorVehicleData is a request originated by a Remote Control Mobile Application.  
-If the parameter `subscribe` is set to `true`, the mobile application has requested to subscribe to the module data defined by the [`moduleType`](../../common/enums/#moduletype) parameter.  
-SDL maintains the `moduleType` subscription status as a whole. SDL needs to subscribe to a module if there is at least one app that subscribes to the module. SDL needs to unsubscribe from a module if no apps subscribe to the module.  
+If the parameter `subscribe` is set to `true`, the mobile application has requested to subscribe to the module data defined by `moduleId` + `moduleType` parameters.  
+SDL core allocates resources by a module (`moduleId` + `moduleType`).
+SDL needs to subscribe to a module if there is at least one app that subscribes to the module. SDL needs to unsubscribe from a module if no apps subscribe to the module.  
 
-SDL forwards a GetInteriorVehicleData request to HMI only if there is no cached data available for the requested `moduleType` or it needs to unsubscribe to the module from HMI.  
+SDL forwards a GetInteriorVehicleData request to HMI only if there is no cached data available for the requested module (`moduleId` + `moduleType`) or it needs to subscribe to/unsubscribe from the module from HMI.  
 Otherwise, SDL responds to the request with the cached data without forwarding it to HMI.
 
-The HMI should only return interior vehicle data that corresponds to the request`moduleType`. For example, if `moduleType = CLIMATE`, only return [`ClimateControlData`](../../common/structs/#climatecontroldata) and do not return [`RadioControlData`](../../common/structs/#radiocontroldata). 
+The HMI should return interior vehicle data that corresponds to the requested module (`moduleId` + `moduleType`).
 
 ### Request  
 
-GetInteriorVehicleData is a request originated by a Remote Control Mobile Application. The HMI should only return interior vehicle data that corresponds to the request module type.  
-For example, if `moduleType = CLIMATE`, only return [`ClimateControlData`](../../common/structs/#climatecontroldata) and do not return [`RadioControlData`](../../common/structs/#radiocontroldata).  
+GetInteriorVehicleData is a request originated by a Remote Control Mobile Application. 
+If the optional `moduleId` is not provided in a GetInteriorVehicleData_request from a Remote Control Mobile Application, and if there is at least one module (published by capabilities) of the same moduleType, SDL core will use the default `moduleId` (the moduleId of first module provided in RC capabilities for requested `moduleType`) when processing the request.
 
 If the parameter `subscribe` is set to true, the mobile application has requested to subscribe to the module data defined by the [`moduleType`](../../common/enums/#moduletype) parameter.
 
 #### Parameters
 
-|Name|Type|Mandatory|Additional|
-|:---|:---|:--------|:---------|
-|moduleType|[Common.ModuleType](../../common/enums/#moduletype)|true||
-|subscribe|Boolean|false|defvalue="false"|
+|Name|Type|Mandatory|Additional|Description|
+|:---|:---|:--------|:---------|:---------------|
+|moduleType|[Common.ModuleType](../../common/enums/#moduletype)|true||The type of a RC module to retrieve module data from the vehicle. <br> In the future, this should be the Identification of a module.|
+|moduleId|String|false|maxlength: 100|Id of a module, published by System Capability.|
+|subscribe|Boolean|false||If subscribe is true, the head unit will register OnInteriorVehicleData notifications for the requested module (moduleId and moduleType). <br> If subscribe is false, the head unit will unregister OnInteriorVehicleData notifications for the requested module (moduleId and moduleType). <br> If subscribe is not included, the subscription status of the app for the requested module (moduleId and moduleType) will remain unchanged.|
 
 ### Response
+
+HMI must provide optional `moduleId` param  in GetInteriorVehicleData_response.
 HMI must return in GetInteriorVehicleData_response the current value of the display mode used in HMI if `moduleType = HMI_SETTINGS` .
 
 #### Parameters

docs/RC/GetInteriorVehicleDataConsent/index.md

@@ -26,14 +26,15 @@ The driver is expected to have an ability to grant or deny the permission.
 |Name|Type|Mandatory|Additional|Description|
 |:---|:---|:--------|:---------|:----------|
 |moduleType|[Common.ModuleType](../../common/enums/#moduletype)|true| |The module type that the app requests to control|
+|moduleIds|String|false|array: true<br>maxlength: 100|Ids of a module of same type, published by System Capability|
 |appID|Integer|true| |ID of the application that triggers the permission prompt|
 
 ### Response
 
 #### Parameters
 |Name|Type|Mandatory|Additional|Description|
 |:---|:---|:--------|:---------|:----------|
-|allowed|Boolean|true| |"true" - if the driver grants the permission for controlling to the named app; <br> "false" - in case the driver denies the permission for controlling to the named app.|
+|allowed|Boolean|true|array: true|"true" - if the driver grants the permission for controlling to the named app; <br> "false" - in case the driver denies the permission for controlling to the named app.|
 
 ### Sequence Diagrams
 

docs/RC/OnInteriorVehicleData/index.md

@@ -9,12 +9,17 @@ Sender
 Purpose
 : Inform SDL about any changes in RC module settings.
 
-!!! must
+
 
 The HMI must send RC.OnInteriorVehicleData notification to SDL when module settings were changed in case of button press event or after SetInteriorVehicledata request was processed.
 
+!!! MUST
+
+The HMI must always include a `moduleId` for a `ModuleData` in OnInteriorVehicleData notification.
+
 The HMI must send RC.OnInteriorVehicleData notification with the current display mode to all mobile RC applications that are subscribed to the HMI settings  
 if the driver (or other applications) or HMI itself change the display mode in the HMI settings.
+
 !!!
 
 ### Notification

docs/RC/OnRCStatus/index.md

@@ -18,6 +18,8 @@ SDL must send OnRCStatus notification when:
     * A module is de-allocated from an application (the module is freed when application exits, disconnects, goes to HMI level NONE)
     * An application no longer has the right to control the module (for example, a policy update can revoke the application's access to a module)
 
+SDL must always include `moduleId` for each and every `ModuleData` in `allocatedModules` and `freeModules` in OnRCStatus notification.
+
 #### Parameters
 
 |Name|Type|Mandatory|Additional|

docs/RC/SetGlobalProperties/index.md

@@ -0,0 +1,96 @@
+## SetGlobalProperties
+
+Type
+: Function
+
+Sender
+: SDL
+
+Purpose
+: Inform HMI of user location properties set by the application for RC modules allocation purposes
+
+### Description
+SDL requests to set the value of user location sent by a RC application. The default `userLocation` should be `DRIVER`.  
+The driver's application should be able to control any free module that is allowed by policies(even if the driver's seat is outside the service area of a module).
+
+### Request
+#### Behavior
+
+!!! MUST   
+
+1. Store the userLocation and associate it with appID.
+
+!!!
+
+#### Parameters
+|Name|Type|Mandatory|Additional|
+|:---|:---|:--------|:---------|
+|userLocation|[Common.SeatLocation](../../common/structs/#seatlocation)|false||
+|appID|Integer|true||
+
+
+### Response
+#### Parameters
+This RPC has no additional parameter requirements
+
+### Sequence Diagrams
+
+|||
+SetGlobalProperties
+![SetGlobalProperties](assets/RC_SetGlobalProperties.png)
+|||
+
+### Example Request
+
+```json
+{
+  "id":22,
+  "jsonrpc":"2.0",
+  "method":"RC.SetGlobalProperties",
+  "params":{
+     "appID":600980185,
+     "userLocation":{
+        "grid":{
+           "col":2,
+           "colspan":1,
+           "level":0,
+           "levelspan":1,
+           "row":0,
+           "rowspan":1
+        }
+     }
+  }
+}
+```
+
+### Example Response
+
+```json
+{
+  "id" : 22,
+  "jsonrpc" : "2.0",
+  "result" :
+  {
+    "code" : 0,
+    "method" : "RC.SetGlobalProperties"
+  }
+}
+```
+
+### Example Error
+
+```json
+{
+  "id" : 22,
+  "jsonrpc" : "2.0",
+  "error" :
+  {
+    "code" : 22,
+    "message" : "During API call the unknown error has occurred",
+    "data" :
+    {
+      "method" : "RC.SetGlobalProperties"
+    }
+  }
+}
+```