Skip to content

Commit

Permalink
Merge pull request #266 from smartdevicelink/develop
Browse files Browse the repository at this point in the history
Release 8.2.0
  • Loading branch information
jacobkeeler authored Oct 26, 2022
2 parents 2ae1f0f + a3d2d09 commit a89289d
Show file tree
Hide file tree
Showing 11 changed files with 236 additions and 240 deletions.
2 changes: 1 addition & 1 deletion docs/BasicCommunication/OnAppDeactivated/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Sender
Purpose
: Inform the application it is no longer active on the HMI

SDL requires this notification in order to keep the mobile application from sending RPC's related to the HMI's functionality (e.g. adding commands for <abbr title="Voice Recognition">VR</abbr>, starting an interaction with the user, speaking text via <abbr title="Text To Speech">TTS</abbr>, etc).
SDL requires this notification in order to keep the mobile application from sending RPCs related to the HMI's functionality (e.g. adding commands for <abbr title="Voice Recognition">VR</abbr>, starting an interaction with the user, speaking text via <abbr title="Text To Speech">TTS</abbr>, etc).


In the event a navigation application is in `FULL` and the HMI sends `OnAppDeactivated`, SDL must set the navigation application to `LIMITED` with the AudioStreamingState set to `AUDIBLE`, VideoStreamingState `STREAMABLE`.
Expand Down
2 changes: 1 addition & 1 deletion docs/BasicCommunication/OnExitApplication/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Purpose
1. Provide the possibility for the user to exit any of the registered applications.
2. Track if an application is active or running in the background, and complies with the driver distraction rules of the system.
3. Track that the transport type that corresponds to the application running. For example, navigation applications are not allowed to be run over a bluetooth connection.
4. Ignore all SDL RPC's related to an application that are defined as prohibited for a specific transport type.
4. Ignore all SDL RPCs related to an application that are defined as prohibited for a specific transport type.
5. Track the application performance issues such as high CPU load or memory constraint warnings.
6. Send `OnExitApplication` notification to SDL if an application conflicts with any of the rules above (i.e. Users requests to exit, driver distraction rules violated, navigation app connected over bluetooth, or the application has performance issues).

Expand Down
6 changes: 3 additions & 3 deletions docs/BasicCommunication/OnIgnitionCycleOver/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ Send `BC.OnIgnitionCycleOver` together with `BC.OnExitAllApplications(IGNITION_O
!!! note

1. `BC.OnIgnitionCycleOver` dependencies:
* SDL expects `BC.OnIgnitionCycleOver` _only in case_ it's built with `"-DEXTENDED_POLICY: ON"` flag. _Otherwise_ SDL needs `BC.OnExitAllApplications(IGNITION_OFF)` only.
* By getting `BC.OnIgnitionCycleOver`SDL increments the `"ignition_cycles_since_last_exchange"` counter in Local Policies Table
* Once the value of `"ignition_cycles_since_last_exchange"` gets equal to the value of `"exchange_after_x_ignition_cycles"`, SDL triggers a Policy Table Update
* SDL expects `BC.OnIgnitionCycleOver` _only in case_ policies are enabled. _Otherwise_ SDL only needs `BC.OnExitAllApplications(IGNITION_OFF)`.
2. By getting `BC.OnIgnitionCycleOver` SDL increments the `"ignition_cycles_since_last_exchange"` counter in Local Policies Table
3. Once the value of `"ignition_cycles_since_last_exchange"` gets equal to the value of `"exchange_after_x_ignition_cycles"`, SDL triggers a Policy Table Update

!!!

Expand Down
2 changes: 1 addition & 1 deletion docs/BasicCommunication/OnSystemCapabilityUpdated/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Purpose
4. If the application changes template to `WEB_VIEW`, HMI should send OnSystemCapabilityUpdated with the following `textFields` restrictions in `WindowCapability`:
* `menuName` and `templateTitle` should be included, if they are visible on HMI.
* `mainField1-4`, `statusBar` and `mediaTrack` should not be included if OEM implemented the `WEB_VIEW` template without these text fields.
* `availabletemplates`, `buttonCapabilities` and `imageTypeSupported` should reflect the general capabilities of the window/system.
* `templatesAvailable`, `buttonCapabilities` and `imageTypeSupported` should reflect the general capabilities of the window/system.
5. HMI sends OnSystemCapabilityUpdated(VIDEO_STREAMING) notification to notify a subscribed mobile application that video streaming resolution has switched.

!!! NOTE
Expand Down
4 changes: 2 additions & 2 deletions docs/BasicCommunication/PolicyUpdate/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ Sender
Purpose
: Inform HMI about the Policy Table Update (PTU) mechanism is triggered on SDL

In case SDL is built with **"-DEXTENDED_POLICY: HTTP" flag**, SDL supports PolicyTableUpdate flow **without HMI-related logic**.
In case SDL is built with **"-DEXTENDED_POLICY=HTTP" flag**, SDL supports PolicyTableUpdate flow **without HMI-related logic**.

### Request

``BC.PolicyUpdate`` represents SDL-generated request to start the PTU sequence.
In case SDL is built with **"-DEXTENDED_POLICY: PROPRIETARY"** or **"-DEXTENDED_POLICY: EXTERNAL_PROPRIETARY"** flag and PolicyTableUpdate is required, SDL internally creates PT snapshot and sends BC.PolicyUpdate(path_to_PTS) to HMI to start PTU sequence.
In case SDL is built with **"-DEXTENDED_POLICY=PROPRIETARY"** or **"-DEXTENDED_POLICY=EXTERNAL_PROPRIETARY"** flag and PolicyTableUpdate is required, SDL internally creates PT snapshot and sends BC.PolicyUpdate(path_to_PTS) to HMI to start PTU sequence.


!!! MUST
Expand Down
2 changes: 1 addition & 1 deletion docs/Buttons/SubscribeButton/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The request may come for the application being whatever active or in background
During Resumption SDL should restore all button subscriptions for application and send required `SubscribeButton` requests to HMI.

!!! NOTE
SDL transfers `Buttons.SubscibeButton(CUSTOM_BUTTON)` request from an application to HMI **only if** `CUSTOM_BUTTON` is supported by HMI (`Buttons[capabilities]` section of `hmi_capabilities.json`).
SDL transfers `Buttons.SubscribeButton(CUSTOM_BUTTON)` request from an application to HMI **only if** `CUSTOM_BUTTON` is supported by HMI (`Buttons[capabilities]` section of `hmi_capabilities.json`).
!!!

#### Parameters
Expand Down
2 changes: 1 addition & 1 deletion docs/Buttons/UnsubscribeButton/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Purpose
and SDL responds GENERIC_ERROR to mobile app
and then HMI responds that the button has been successfully subscribed,
then SDL sends `UnsubscribeButton` request to HMI, so that the application and HMI are in sync.
2. When an application disconnects unexpectedely, SDL sends `UnsubscribeButton` request for all button names subscribed only by the application just disconnected.
2. When an application disconnects unexpectedly, SDL sends `UnsubscribeButton` request for all button names subscribed only by the application just disconnected.
!!!

#### Parameters
Expand Down
4 changes: 2 additions & 2 deletions docs/Common/Enums/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -651,8 +651,8 @@
|Name|Value|Description|
|:---|:----|:----------|
|NO_FIX|0|No <abbr title="Global Positioning System">GPS</abbr> at all|
|2D|1|Longitude and lattitude|
|3D|2|Longitude and lattitude and altitude|
|2D|1|Longitude and latitude|
|3D|2|Longitude and latitude and altitude|

### ImageType

Expand Down
4 changes: 2 additions & 2 deletions docs/SDL/OnReceivedPolicyUpdate/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ Purpose

!!! NOTE
1. _SDL.OnReceivedPolicyUpdate_ dependencies:
- SDL expects _SDL.OnReceivedPolicyUpdate_ _only in case_ it's built with `"-DEXTENDED_POLICY: PROPRIETARY" flag or without this flag` and `-DEXTENDED_POLICY: EXTERNAL_PROPRIETARY` flag. _Otherwise_ SDL handles the entire PTU flow by itself.
- SDL will not use Updated PT until notified by HMI.
- SDL expects _SDL.OnReceivedPolicyUpdate_ _only in case_ it's built with `"-DEXTENDED_POLICY=PROPRIETARY" flag or without this flag` and `-DEXTENDED_POLICY=EXTERNAL_PROPRIETARY` flag. _Otherwise_ SDL handles the entire PTU flow by itself.
- SDL will not use Updated PT until notified by HMI.

2. After getting _OnReceivedPolicyUpdate (policyFile)_ from HMI, _SDL must_ stop timeout started by _OnSystemRequest_ and validate the Policy Table Update (policyFile) of optional, required, or omitted:
- validation must reject Policy Table updates if it include fields with a status of ‘omitted.’
Expand Down
Loading

0 comments on commit a89289d

Please sign in to comment.