Feature/iap over bt #43

KhrystynaDubovyk · 2017-11-20T16:43:13Z

Provides the information for #1587

Proposal: Connectivity via iAP-BT and Transport Switch

This PR is ready for review.

Summary

TRS/iAP over BT/ folder was created
iAP_over_BT_data_resumption index was created
iAP_over_BT_handling_HMI_notifications_during_re-connection index was created
iAP_over_BT_re-connection index was created
detailed_docs/accessories/
Diagrams added
iAP transport change reconnection.png
iAP_over_BT_data_resumption.png
detailed_docs/iAP_over_BT/ folder was created
iAP_over_BT_handling_HMI_notif_during_reconnection_use_case index was created
iAP_over_BT_re-connection_use_case index was created

CLA

I have signed the CLA

iAP_over_BT_data_resumption index was created iAP_over_BT_handling_HMI_notifications_during_re-connection index was created iAP_over_BT_re-connection index was created detailed_docs/accessories/ Diagrams added iAP transport change reconnection.png iAP_over_BT_data_resumption.png detailed_docs/iAP_over_BT/ folder was created iAP_over_BT_handling_HMI_notif_during_reconnection_use_case index was created iAP_over_BT_re-connection_use_case index was created

AStasiuk · 2017-11-21T13:59:20Z

detailed_docs/iAP_over_BT/iAP_over_BT_re-connection_use_case.md

+8.1.b. SDL clears all resumption data related to this app **except** "AppIconsFolder"  
+8.1.c. SDL does **not** notify HMI about new registration (HMI continues to display app screen)
+
+**Use Case 2**  


@KhrystynaDubovyk, please provide a description for Use Case 2, as for Use Case 1.

@KhrystynaDubovyk, change Markdown style:

Use Case 2:

AStasiuk · 2017-11-21T13:59:37Z

detailed_docs/iAP_over_BT/iAP_over_BT_re-connection_use_case.md

+2. SDL does not start reconnection timer  
+3. SDL notifies HMI about app being unregistred
+
+**Use Case 3**  


@KhrystynaDubovyk, please provide a description for Use Case 3, as for Use Case 1.

@KhrystynaDubovyk, change Markdown style:

Use Case 3:

AStasiuk · 2017-11-21T14:10:17Z

detailed_docs/iAP_over_BT/iAP_over_BT_re-connection_use_case.md

+
+_Exception 1:_  
+7.1. **After** timer expires app sends **valid** "hashID" with `<RegisterAppInterface>` request  
+7.1.a. SDL notifies HMI about app being unregistred   


@KhrystynaDubovyk, typo 'unregistred', should be unregistered

Accepted. Done.

AStasiuk · 2017-11-21T14:11:52Z

detailed_docs/iAP_over_BT/iAP_over_BT_re-connection_use_case.md

+7. SDL receives `<RegisterAppInterface>` request **before** reconnection timer expires
+8. App sends **valid** "hashID" with `RegisterAppInterface` request 
+9. SDL sends succesful response to the app 
+10. SDL updates data in Policytable 


@KhrystynaDubovyk, Policytable - should be 2 separate words

Rejected.
I offer to write "PolicyTable" in favour of existing docs written in this way.

AStasiuk · 2017-11-21T14:21:57Z

detailed_docs/iAP_over_BT/iAP_over_BT_re-connection_use_case.md

+
+_Pre-conditions:_  
+a. iOS device is connected over USB  
+b. App from iOS device is registred and running on SDL  


@KhrystynaDubovyk, typo 'registred', should be registered

Accepted. Done.

AStasiuk · 2017-11-21T15:06:05Z

detailed_docs/TRS/iAP over BT/iAP_over_BT_re-connection.md

+send BC.OnAppUnregistered (appID, unexpectedDisconnect:true) to HMI for such application
+
+4.
+In case mobile application sends RegisterAppInterface during `<AppTransportChangeTimer> + <AppTransportChangeTimerAddition>*N` timer  


@KhrystynaDubovyk , maybe better to use an 'app' instead of 'applications' as made in all rest of files?
It's for whole iAP_over_BT_re-connection.md

Rejected.
changed 'app' into 'application' throughout the document in favour of existing TRS documents written with 'application' (embedded_navi, RC, iAP_over_BT_data_resumptionTRS, ).

AStasiuk · 2017-11-21T15:10:41Z

detailed_docs/TRS/iAP over BT/iAP_over_BT_re-connection.md

+SDL must:
+- consider such app as re-registered app
+- update data in PolicyTable (`<device_identifier>` section)
+- send UpdataDeviceList to HMI


@KhrystynaDubovyk , type 'UpdataDeviceList', correct - 'UpdateDeviceList'.

Accept. Done.

AStasiuk · 2017-11-21T15:12:39Z

detailed_docs/TRS/iAP over BT/iAP_over_BT_re-connection.md

+_Note:_ In case of USB connection loss SDL must proceed with unexpected disconnect flow
+
+## Non-Functional Requirements
+New parameters "AppTransportChangeTimer" , "AppTransportChangeTimerAddition"   must be added to .ini file -> [MAIN] section


@KhrystynaDubovyk, suggested to indicate directly: smartdevicelink.ini file

AStasiuk · 2017-11-21T15:17:19Z

detailed_docs/TRS/iAP over BT/iAP_over_BT_handling_HMI_notifications_during_re-connection.md

+discard all responses to such `appID` from HMI
+
+## Non-Functional Requirements
+New parameters "AppTransportChangeTimer" , "AppTransportChangeTimerAddition"   must be added to .ini file -> [MAIN] section


@KhrystynaDubovyk, suggested to indicate directly: smartdevicelink.ini file

Accepted. Done.

AStasiuk · 2017-11-21T15:20:47Z

detailed_docs/TRS/iAP over BT/iAP_over_BT_data_resumption.md

+behave according to existing Data Resumption rules 
+
+## Non-Functional Requirements
+New parameters "AppTransportChangeTimer" , "AppTransportChangeTimerAddition"   must be added to .ini file -> [MAIN] section


@KhrystynaDubovyk, suggested to indicate directly: smartdevicelink.ini file

Accepted. Done.

changing ".ini file" into "smartdevicelink.ini file"

changed .ini file into smartdevicelink.ini file

fix typo change .ini file into smartdevicelink.ini file

Minor text formatting; smoothing 'app'/'application' usage throughout the document

Minor text formatting app -> application Policytable -> PolicyTable fixing typos

edit headers fot UC2, 3 add titles for UC2, 3

KhrystynaDubovyk · 2017-12-26T10:48:40Z

@robinmk, please review

robinmk · 2017-12-28T23:04:34Z

detailed_docs/TRS/iAP over BT/iAP_over_BT_data_resumption.md

+New parameters "AppTransportChangeTimer" , "AppTransportChangeTimerAddition"   must be added to smartdevicelink.ini file -> [MAIN] section
+
+```
+[MAIN] 


I think the comment for "AppTransportChangeTimer" can be rewritten as
Defines the timeout period SDL Core will wait for an application to re-register via alternate transport during 'transport switch'. If the application fails to re-register within this time, SDL Core shall inform HMI that the application has unregistered.

Done.
"AppTransportChangeTimer" description was rewritten.

robinmk · 2017-12-28T23:05:30Z

detailed_docs/TRS/iAP over BT/iAP_over_BT_data_resumption.md

+
+## Diagram
+Data resumption
+![Data resumption](https://github.com/smartdevicelink/sdl_requirements/blob/feature/iap_over_bt/detailed_docs/accessories/iAP_over_BT_data_resumption.png)


For the diagram, it would be very useful to indicate the event which causes SDL core to start the timer (AppTransportChangeTimer + AppTransportChangeTimerAddition*N)

The diagram is updated

robinmk · 2017-12-28T23:33:39Z

detailed_docs/iAP_over_BT/iAP_over_BT_re-connection_use_case.md

+_Expected:_  
+
+2. SDL receives signal with `<UUID>` about USB connection of the same device 
+3. SDL compares `<UUID>` of BT device connection with `<UUID>` of USB connection  


Isn't the HMI responsible for doing the UUID check and informing SDL to perform transport switch? Please make sure to correct this entire flow accordingly

The flow was corrected accordingly

robinmk · 2017-12-28T23:34:01Z

detailed_docs/iAP_over_BT/iAP_over_BT_re-connection_use_case.md

+7.1.c. SDL performs data resumption for this application  
+7.1.d. SDL **notifies** HMI about fresh application registration 
+
+_Exception 2:_  


What is the difference in case between Exception 2 and Exception 3?

Exception 2 describes the flow when invalid or omitted hashID is received after timer expires;
Exception 3 describes the flow when invalid or omitted hashID is received before timer expires

robinmk · 2017-12-28T23:34:36Z

detailed_docs/iAP_over_BT/iAP_over_BT_re-connection_use_case.md

+ 1. User connects the same device over USB
+ 2. SDL receives signal with `<UUID>` via IOSDeviceConnectInfo
+ 3. SDL connects USB device
+ 4. SDL disconnects Bluetooth


Step4- What is meant by "SDL disconnects BT" - From my understanding it is the HMI layer which disconnects the iAP channel over BT transport (Please note that the BT transport itself is not closed, only the iAP channel over the BT transport is closed)

Accepted, updated.

robinmk · 2017-12-28T23:35:02Z

detailed_docs/iAP_over_BT/iAP_over_BT_re-connection_use_case.md

+ 1.1. User connects another device over Bluetooth  
+ 1.1.a SDL receives signal with `<UUID_1>` about USB connection of the same device  
+ 1.1.b SDL receives signal with `<UUID_2>` about Bluetooth connection of another device  
+ 1.1.c SDL opens hub EAP protocol for `<UUID_1>` USB session  


1.1.c and 1.1.e- I think it is better to say that SDL opens appropriate EAP protocols and not be specific to HUB protocol because SDL should also be opening the dedicated EAP protocols as well (like com.smartdevicelink.multisession)

robinmk · 2017-12-28T23:35:16Z

detailed_docs/iAP_over_BT/iAP_over_BT_re-connection_use_case.md

+ 1.1.d SDL closes active EAP session opened for `<UUID_1>` Bluetooth  
+ 1.1.e SDL opens hub EAP protocol for `<UUID_2>` Bluetooth session  
+ 1.1.f SDL starts reconnection timer for `<UUID_1>`  
+ 1.1.g `<app_1>` from device `<UUID_2>` sends RegisterAppInterface (params)  


1.1.g - I am not sure I understand the case being described here. It seems like an app is requesting registration from the device which is connected over BT. But it is not clear why its registration request is being rejected. Please re-write this case with more clarity.

robinmk · 2017-12-28T23:36:34Z

@KhrystynaDubovyk , I've provided the review comments.
Is this for requirements documentation?

Changed **Non-Functional Requirements** `AppTransportChangeTimer` description.

Update according to comment ## Use Case 3: Multiple connection _Exception 1:_ 1.1.c 1.1.e

Update Use Case 1, Use Case 3 according to comments.

KhrystynaDubovyk force-pushed the feature/iap_over_bt branch from 078c8be to 8751ba4 Compare November 21, 2017 10:38

AStasiuk suggested changes Nov 21, 2017

View reviewed changes

KhrystynaDubovyk added 6 commits November 22, 2017 12:20

Update iAP_over_BT_data_resumption index

3065c7d

changing ".ini file" into "smartdevicelink.ini file"

Update iAP_over_BT_handling_HMI_notifications_during_re-connection index

0cab0ae

changed .ini file into smartdevicelink.ini file

Update iAP_over_BT_re-connection index

b4be896

fix typo change .ini file into smartdevicelink.ini file

Update iAP_over_BT_re-connection index

7bd3b3b

Minor text formatting; smoothing 'app'/'application' usage throughout the document

Update iAP_over_BT_re-connection_use_case

bac77d3

Minor text formatting app -> application Policytable -> PolicyTable fixing typos

Update iAP_over_BT_re-connection_use_case index

b6775fa

edit headers fot UC2, 3 add titles for UC2, 3

KhrystynaDubovyk requested a review from robinmk November 23, 2017 11:06

AStasiuk approved these changes Nov 29, 2017

View reviewed changes

robinmk reviewed Dec 28, 2017

View reviewed changes

KhrystynaDubovyk added 8 commits January 29, 2018 17:16

Updated iAP_over_BT_data_resumption

5871c4a

Changed **Non-Functional Requirements** `AppTransportChangeTimer` description.

change description 'AppTransportChangeTimer'

66557ac

change 'AppTransportChangeTimer' description

9b508a6

Update iAP_over_BT_re-connection_use_case

316cdbb

Update according to comment ## Use Case 3: Multiple connection _Exception 1:_ 1.1.c 1.1.e

Delete iAP_over_BT_data_resumption.png

35fd3ee

Upload updated iAP_over_BT_data_resumption.png

4a62343

Update iAP_over_BT_re-connection_use_case

78aa6c0

Update Use Case 1, Use Case 3 according to comments.

Update iAP_over_BT_re-connection_use_case.md

81c52b9

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/iap over bt #43

Feature/iap over bt #43

KhrystynaDubovyk commented Nov 20, 2017 •

edited

Loading

AStasiuk Nov 21, 2017

AStasiuk Nov 21, 2017

AStasiuk Nov 21, 2017

AStasiuk Nov 21, 2017

AStasiuk Nov 21, 2017

KhrystynaDubovyk Nov 22, 2017

AStasiuk Nov 21, 2017

KhrystynaDubovyk Nov 22, 2017

AStasiuk Nov 21, 2017

KhrystynaDubovyk Nov 22, 2017

AStasiuk Nov 21, 2017

KhrystynaDubovyk Nov 22, 2017

AStasiuk Nov 21, 2017

KhrystynaDubovyk Nov 22, 2017

AStasiuk Nov 21, 2017

AStasiuk Nov 21, 2017

KhrystynaDubovyk Nov 22, 2017

AStasiuk Nov 21, 2017

KhrystynaDubovyk Nov 22, 2017

KhrystynaDubovyk commented Dec 26, 2017

robinmk Dec 28, 2017 •

edited

Loading

KhrystynaDubovyk Jan 29, 2018

robinmk Dec 28, 2017

KhrystynaDubovyk Feb 2, 2018

robinmk Dec 28, 2017

KhrystynaDubovyk Mar 20, 2018

robinmk Dec 28, 2017

KhrystynaDubovyk Jan 29, 2018

robinmk Dec 28, 2017

KhrystynaDubovyk Mar 20, 2018

robinmk Dec 28, 2017

KhrystynaDubovyk Feb 2, 2018

robinmk Dec 28, 2017

robinmk commented Dec 28, 2017

Feature/iap over bt #43

Are you sure you want to change the base?

Feature/iap over bt #43

Conversation

KhrystynaDubovyk commented Nov 20, 2017 • edited Loading

Summary

CLA

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Use Case 2:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Use Case 3:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KhrystynaDubovyk commented Dec 26, 2017

robinmk Dec 28, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robinmk commented Dec 28, 2017

KhrystynaDubovyk commented Nov 20, 2017 •

edited

Loading

robinmk Dec 28, 2017 •

edited

Loading