Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
5515d99
Create OnServiceUpdate folder; update config json with OnServiceUpdate
KhrystynaDubovyk Feb 11, 2019
73a151e
Add ServiceType, ServiceEvent, ServiceUpdateReason enums
KhrystynaDubovyk Feb 11, 2019
37db219
fixing links, minor text formatting
KhrystynaDubovyk Feb 19, 2019
624285a
fix ServiceUpdateReason table syntax
KhrystynaDubovyk Feb 19, 2019
1ab2703
add assets folder
KhrystynaDubovyk Feb 19, 2019
bc7b1b9
replacing the note
KhrystynaDubovyk Feb 20, 2019
b497b75
Update diagram
KhrystynaDubovyk Feb 21, 2019
364eb9f
remove 'appropriate' to avoid ambiguity
KhrystynaDubovyk Mar 26, 2019
2c3dd65
Update index.md
KhrystynaDubovyk Mar 27, 2019
446ed52
rename enum ServiceUpdateReason into ServiceStatusUpdateReason
KhrystynaDubovyk May 20, 2019
f9b36c5
update ServiceUpdateReason into ServiceStatusUpdateReason
KhrystynaDubovyk May 20, 2019
638abaf
add `PROTECTION_ENFORCED`, `PROTECTION_DISABLED` to ServiceStatusUpda…
KhrystynaDubovyk Jun 12, 2019
628084d
added the source file for the included diagram
KhrystynaDubovyk Jun 12, 2019
6f1e112
Update docs/BasicCommunication/OnServiceUpdate/index.md
mked-luxoft Aug 21, 2019
fc7128f
Update docs/Common/Enums/index.md
mked-luxoft Aug 21, 2019
b50bdf8
Update docs/Common/Enums/index.md
mked-luxoft Aug 21, 2019
8aac9f3
Apply suggestions from code review
KhrystynaDubovyk Aug 22, 2019
765418c
Update docs/BasicCommunication/OnServiceUpdate/index.md
KhrystynaDubovyk Aug 22, 2019
9eb2e45
Update docs/BasicCommunication/OnServiceUpdate/index.md
KhrystynaDubovyk Aug 27, 2019
00f4bd0
Merge branch 'develop' into feature/service_status_update_to_hmi
KhrystynaDubovyk Aug 27, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions config.json
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,9 @@
},
{
"name": "GetFilePath"
},
{
"name": "OnServiceUpdate"
}
]
},
Expand Down

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
59 changes: 59 additions & 0 deletions docs/BasicCommunication/OnServiceUpdate/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
## OnServiceUpdate

Type
: Notification

Sender
: SDL

Purpose
: Update HMI with the status of a particular service

!!! may

Display a pop-up providing accurate feedback to the user on the status of the system or what steps to take in case of an error.

!!!

### Notification
When a mobile navigation application is activated and sends a request for the Video Service there is a series of steps taken.
These steps include:

* getting the current [system time](../getsystemtime)
* performing a policy table update
* decrypting certificates and ensuring validity of the certificates

Processing these steps SDL sends OnServiceUpdate notification to HMI to provide accurate feedback on the status of the system.

#### Parameters

|Name|Type|Mandatory|Additional|
|:---|:---|:--------|:---------|
|serviceType|[Common.ServiceType](../../common/enums/#servicetype)|true||
|serviceEvent|[Common.ServiceEvent](../../common/enums/#serviceevent)|false||
|reason|[Common.ServiceStatusUpdateReason](../../common/enums/#servicestatusupdatereason)|false||
|appID|Integer|false||

!!! note
The only time when SDL would not be able provide the `appID` would be during the first StartService request for the RPC service before RAI was sent.
!!!

### Sequence Diagrams

|||
OnServiceUpdate
![OnServiceUpdate](assets/OnServiceUpdate.png)
|||

#### JSON Example Notification

```json
{
"jsonrpc": "2.0",
"method": "BC.OnServiceUpdate",
"params": {
"serviceType": "RPC",
"serviceEvent":"REQUEST_RECEIVED"
}
}
```
26 changes: 26 additions & 0 deletions docs/Common/Enums/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -1242,3 +1242,29 @@
|:---|:----|:----------|
|DEFAULT_WINDOW|0|The default window is a main window pre-created on behalf of the app|
|PRIMARY_WIDGET|1|The primary widget of the app|

### ServiceType

|Name|Value|Description|
|:---|:----|:----------|
|VIDEO|0|Refers to the Video service.|
|AUDIO|1|Refers to the Audio service.|
|RPC|2|Refers to RPC service.|

### ServiceEvent

|Name|Value|Description|
|:---|:----|:----------|
|REQUEST_RECEIVED|0|When a request for a Service is received.|
|REQUEST_ACCEPTED|1|When a request for a Service is accepted.|
|REQUEST_REJECTED|2|When a request for a Service is rejected.|

### ServiceStatusUpdateReason

|Name|Value|Description|
|:---|:----|:----------|
|PTU_FAILED|0|When a Service is rejected because the system was unable to get a required Policy Table Update.|
|INVALID_CERT|1|When a Service is rejected because the security certificate is invalid/expired.|
|INVALID_TIME|2|When a Service is rejected because the system was unable to get a valid SystemTime from HMI, which is required for certificate authentication.|
|PROTECTION_ENFORCED|3|When a Service is rejected because the system configuration ini file requires the service must be protected, but the app asks for an unprotected service.|
|PROTECTION_DISABLED|4|When a mobile app requests a protected service, but the system starts an unprotected service instead.|