Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

GetInteriorVehicleData

Type
Function
Sender
SDL
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 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.

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.
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 requestmoduleType. For example, if moduleType = CLIMATE, only return ClimateControlData and do not return RadioControlData.

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 and do not return RadioControlData.

If the parameter subscribe is set to true, the mobile application has requested to subscribe to the module data defined by the moduleType parameter.

Parameters

Name Type Mandatory Additional
moduleType Common.ModuleType true
subscribe Boolean false defvalue="false"

Response

HMI must return in GetInteriorVehicleData_response the current value of the display mode used in HMI if moduleType = HMI_SETTINGS .

Parameters

Name Type Mandatory Additional
moduleData Common.ModuleData true
isSubscribed Boolean false

Sequence Diagrams

Example Request

{
    "id": 122,
    "jsonrpc": "2.0",
    "method": "RC.GetInteriorVehicleData",
    "params": {
        "moduleType": "CLIMATE",
        "subscribe": true
    }
}

Example Response

{
    "id": 122,
    "jsonrpc": "2.0",
    "result": {
        "code": 0,
        "isSubscribed": true,
        "method": "RC.GetInteriorVehicleData",
        "moduleData": {
            "climateControlData": {
                "acEnable": true,
                "acMaxEnable": true,
                "autoModeEnable": true,
                "circulateAirEnable": true,
                "currentTemperature": {
                    "unit": "FAHRENHEIT",
                    "value": 20.1
                },
                "defrostZone": "FRONT",
                "desiredTemperature": {
                    "unit": "CELSIUS",
                    "value": 10.5
                },
                "dualModeEnable": true,
                "fanSpeed": 50,
                "ventilationMode": "BOTH"
            },
            "moduleType": "CLIMATE"
        }
    }
}

Example Error

{
    "error": {
        "code": 2,
        "data": {
            "method": "RC.GetInteriorVehicleData"
        },
        "message": "Unknown module type"
    },
    "id": 122,
    "jsonrpc": "2.0"
}
View on GitHub.com
Previous Section Next Section