smartdevicelink / sdl_requirements

Collection of requirements/technical tasks for new sdl_core features
BSD 3-Clause "New" or "Revised" License
2 stars 7 forks source link

[RC-SDL] - Interior Vehicle Data Subscription Management and Data Caching in SDL #91

Open KhrystynaDubovyk opened 6 years ago

KhrystynaDubovyk commented 6 years ago

GetInteriorVehicleData

Description:

As a mobile application, I want immediately get responses to GetInteriorVehicleData requests getting module data, module subscription status.

Detailed description:

Parameter appID is no longer needed in HMI API.

<function name="GetInteriorVehicleData" messagetype="request">
  <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">
    <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">
-    <description>Internal SDL-assigned ID of the related application</description>
-  </param>
</function>

When there is no cache available and before SDL forwards a GetInteriorVehicleData request to HMI, SDL shall apply a rate limitation scheme. SDL allows x number of GetVehicleData requests per second. The number x is 5 and it can be configured in smartDeviceLink.ini file. Similarly, SDL allows y number of GetInteriorVehicleData requests to forward to HMI. The number y shall be configurable in ini file.

[MAIN]
; Limitation for a number of GetVehicleData requests (the 1st value) per (the 2nd value) seconds
GetVehicleDataRequest = 5, 1
+; Limitation for a number of GetInteriorVehicleDataRequest requests (the 1st value) per (the 2nd value) seconds
+GetInteriorVehicleDataRequest = 20, 1

Diagram:

N/A

Links: