Feature/0238 Keyboard Enhancements #10

KhrystynaDubovyk · 2020-12-07T14:00:59Z

Update Structs, Enums;
OnKeyboardInput - update add Notification MUST and NOTE sections in index; add new diagram KeyboardEventInputKeyMask and its source file;
SetGlobalProperties - update index; add new diagram SetGlobalPropertiesCustomizeKeys and its source file

OnKeyboardInput - update add Notification MUST and NOTE sections in index; add new diagram KeyboardEventInputKeyMask and its source file; SetGlobalProperties - update index; add new diagram SetGlobalPropertiesCustomizeKeys and its source file

LitvinenkoIra · 2020-12-11T11:22:18Z

docs/UI/SetGlobalProperties/index.md

+
+4. HMI displays the in-application menu for every active application upon the User's request. It must contain SDL-requested commands (UI.AddCommand) and sub-menus (UI.AddSubMenu). SDL provides the values for the name (`menuTitle` parameter) and for the icon (`menuIcon` parameter) of this in-application menu. The values for in-application menu and touchscreen keyboard are allowed by SDL Core for navigation type of application only.
+5. HMI must display the onscreen keyboard upon the User's request within the following condition: all `keyboardProperties` supported by HMI must be embodied in `HMI_capabilities.json file`. In this case SDL Core is able to compare `keyboardProperties` requested by the mobile device with actually supported `keyboardProperties` and send to HMI only those that are supported.
+6. HMI must use default `keyboardProperties` parameters, in case SDL Core transfers UI.SetGlobalProperties request with omitted or empty `keyboardProperties` parameters.


@KhrystynaDubovyk
keyboardCapabilities includes in the windowCapabilities that includes in DisplayCapability that includes in systemCapability struct.

SDL can receive systemCapability struct only via OnSystemCapabilityUpdated notification after the app registration.

SDL wouldn't save this data to the cache file, because it specific capabilities for the app. (the same logic as for DisplayCapability)

So I think that points 5. and 6. should be removed.

@dboltovskyi @ychernysheva please advise should we add some specific info related to the customizable keys processing?

May be just one notice:
In case if HMI does not provide number of customizable keys for some keyboard layout SDL will automatically populate zero for it.

removed p.5,6 in 09c6fad

docs/UI/OnKeyboardInput/assets/KeyboardEventInputKeyMask.txt

dboltovskyi · 2020-12-14T17:24:53Z

docs/UI/SetGlobalProperties/assets/SetGlobalPropertiesCustomizeKeys.txt

+HMI-->SDL:UI.SetGlobalProperties (SUCCESS)
+SDL-->App:SetGlobalProperties (SUCCESS)
+note over HMI:<align:center>Keyboard layout\ncustomizable keys are:\n**" # "** - customized value\n** " $ "** - customized value
+end


This scenario updates already available character '#' (default one)

updated in 856c2dd

dboltovskyi · 2020-12-14T17:26:45Z

docs/UI/SetGlobalProperties/assets/SetGlobalPropertiesCustomizeKeys.txt

+note over SDL:<align:center><customizeKeys> array\nhas more values than\ncustomizable keys allowed
+SDL-->App:<align:center>SetGlobalProperties\n(INVALID_DATA: "CustomizeKeys exceeds the number of customizable keys in this Layout")
+note over HMI:<align:center>Customizable keys' values\nare not changed
+end


I would add an information how HMI lets SDL know about max number of customizable characters.
And that's why we need docs/BasicCommunication/OnSystemCapabilityUpdated/index.md file updated within this PR

updated in 3c734d7

dboltovskyi · 2020-12-14T18:33:10Z

docs/UI/SetGlobalProperties/index.md

+7. HMI allows to customize special characters depending on the keyboard layout restrictions:
+    * `QWERTY` - 3 customizable keys
+    * `AZERTY` - 4 customizable keys
+    * `NUMERIC` - 2 customizable keys


Please notice there 4 layouts available, QWERTZ currently is missing

and how many customizable buttons allowed for QWERTZ ? three?

added in 09c6fad

dboltovskyi · 2020-12-14T18:36:02Z

docs/UI/SetGlobalProperties/index.md

+  * display the complete list of available VR commands (SDL-defined and HMI-defined ones) when the User activates VR.
+
+4. HMI displays the in-application menu for every active application upon the User's request. It must contain SDL-requested commands (UI.AddCommand) and sub-menus (UI.AddSubMenu). SDL provides the values for the name (`menuTitle` parameter) and for the icon (`menuIcon` parameter) of this in-application menu. The values for in-application menu and touchscreen keyboard are allowed by SDL Core for navigation type of application only.
+5. HMI must display the onscreen keyboard upon the User's request within the following condition: all `keyboardProperties` supported by HMI must be embodied in `HMI_capabilities.json file`. In this case SDL Core is able to compare `keyboardProperties` requested by the mobile device with actually supported `keyboardProperties` and send to HMI only those that are supported.


Please notice currently in hmi_capabilities.jsonthere is no information on KeyboardProperties

removed this in 09c6fad

dboltovskyi · 2020-12-14T18:37:39Z

docs/UI/SetGlobalProperties/index.md

+  * display the complete list of available VR commands (SDL-defined and HMI-defined ones) when the User activates VR.
+
+4. HMI displays the in-application menu for every active application upon the User's request. It must contain SDL-requested commands (UI.AddCommand) and sub-menus (UI.AddSubMenu). SDL provides the values for the name (`menuTitle` parameter) and for the icon (`menuIcon` parameter) of this in-application menu. The values for in-application menu and touchscreen keyboard are allowed by SDL Core for navigation type of application only.
+5. HMI must display the onscreen keyboard upon the User's request within the following condition: all `keyboardProperties` supported by HMI must be embodied in `HMI_capabilities.json file`. In this case SDL Core is able to compare `keyboardProperties` requested by the mobile device with actually supported `keyboardProperties` and send to HMI only those that are supported.


In this case SDL Core is able to compare keyboardProperties requested by the mobile device with actually supported keyboardProperties and send to HMI only those that are supported.

I'm not sure is this actually true.
Unfortunately there is no direct mapping between keyboard "capabilities" provided by HMI and keyboard "properties" that app try to set through SetGP.
That's why in current implementation of the proposal we decided to move responsibility to check parameters to HMI.
It means SDL does not "verify" new parameters maskInputCharacters and customizeKeys and pass them to HMI as is (except of the case for number of customizable keys).

dboltovskyi · 2020-12-14T19:00:02Z

docs/UI/SetGlobalProperties/index.md

+
+4. HMI displays the in-application menu for every active application upon the User's request. It must contain SDL-requested commands (UI.AddCommand) and sub-menus (UI.AddSubMenu). SDL provides the values for the name (`menuTitle` parameter) and for the icon (`menuIcon` parameter) of this in-application menu. The values for in-application menu and touchscreen keyboard are allowed by SDL Core for navigation type of application only.
+5. HMI must display the onscreen keyboard upon the User's request within the following condition: all `keyboardProperties` supported by HMI must be embodied in `HMI_capabilities.json file`. In this case SDL Core is able to compare `keyboardProperties` requested by the mobile device with actually supported `keyboardProperties` and send to HMI only those that are supported.
+6. HMI must use default `keyboardProperties` parameters, in case SDL Core transfers UI.SetGlobalProperties request with omitted or empty `keyboardProperties` parameters.


May be just one notice:
In case if HMI does not provide number of customizable keys for some keyboard layout SDL will automatically populate zero for it.

…ers info

ychernysheva · 2020-12-17T10:46:55Z

docs/BasicCommunication/OnSystemCapabilityUpdated/index.md


+2. In case HMI sends `KeyboardCapabilities` without information about `numConfigurableKeys` within OnSystemCapabilityUpdated notification, SDL would provide `KeyboardCapabilities` to app with `numConfigurableKeys` set to zero.


Maybe, I will be better to highlight, that numConfigurableKeys will be set to zero only for supported layouts (if they are provided in KeyboardCapabilities struct).

And one more clarification: if KeyboardCapabilities struct doesn't have any information about supported layouts (supportedKeyboardLayouts param is omitted), corresponding requests will use configurableKeys param as is.

@dboltovskyi, @ychernysheva
shall I change wording in p.2 like this

In case HMI sends OnSystemCapabilityUpdated notification with KeyboardCapabilities, supportedKeyboardLayouts and without information about numConfigurableKeys , SDL would provide KeyboardCapabilities to app with numConfigurableKeys set to zero.

Looks Ok for me

done in 6391778

dboltovskyi · 2020-12-17T22:31:37Z

docs/BasicCommunication/OnSystemCapabilityUpdated/index.md

@@ -18,11 +18,13 @@ Purpose
    * `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.
+5. HMI sends `KeyboardCapabilities` and max number of customizable keys within OnSystemCapabilityUpdated notification to SDL.


I would say HMI may send KeyboardCapabilities within OnSystemCapabilityUpdated notification which may include maskInputCharactersSupported, supportedKeyboardLayouts and configurableKeys parameters.

done in 66efcf6

dboltovskyi · 2020-12-17T22:32:00Z

docs/BasicCommunication/OnSystemCapabilityUpdated/index.md


+2. In case HMI sends `KeyboardCapabilities` without information about `numConfigurableKeys` within OnSystemCapabilityUpdated notification, SDL would provide `KeyboardCapabilities` to app with `numConfigurableKeys` set to zero.


Looks Ok for me

docs/UI/OnKeyboardInput/assets/KeyboardEventInputKeyMask.txt

dboltovskyi · 2020-12-17T22:46:12Z

docs/UI/SetGlobalProperties/assets/SetGlobalPropertiesResumptionKeyboardProperties.txt

+
+SDL-->App: RegisterAppInterface (SUCCESS)
+
+SDL->>HMI: BC.OnAppRegistered(appName; appID)


This notification is sent before UI.SetGlobalProperties request

done in 66efcf6

…Updated index

…KeyboardProperties after demo

…cements_revision SDL-0238 update per proposal revision

Co-authored-by: Jacob Keeler <jacob.keeler@livioradio.com>

Update Structs, Enums;

4687748

OnKeyboardInput - update add Notification MUST and NOTE sections in index; add new diagram KeyboardEventInputKeyMask and its source file; SetGlobalProperties - update index; add new diagram SetGlobalPropertiesCustomizeKeys and its source file

KhrystynaDubovyk requested review from AKalinich-Luxoft, LitvinenkoIra and Ypostolov December 7, 2020 14:01

LitvinenkoIra reviewed Dec 11, 2020

View reviewed changes

LitvinenkoIra requested review from ychernysheva and removed request for Ypostolov December 11, 2020 11:24

dboltovskyi reviewed Dec 14, 2020

View reviewed changes

KhrystynaDubovyk added 2 commits December 16, 2020 14:23

Upd OnSystemCapabilityUpdated with max number of customizable charact…

3c734d7

…ers info

Upd SetGlobalProperties - remove p.5,6; add QWERTZ

09c6fad

ychernysheva reviewed Dec 17, 2020

View reviewed changes

KhrystynaDubovyk added 3 commits December 17, 2020 18:53

Upd OnkeyboardInput diagram after the review comments

4b431d5

Upd SetGlobalProperties diagram per review comment

856c2dd

add SetGlobalPropertiesResumptionKeyboardProperties diagram

799bb6d

dboltovskyi requested changes Dec 17, 2020

View reviewed changes

KhrystynaDubovyk added 2 commits December 18, 2020 12:43

upd OnkeyboardInput, SetGlobalProperties diagrams; OnSystemCapability…

66efcf6

…Updated index

change wording in OnSystemCapabilityUpdated note

6391778

ychernysheva approved these changes Dec 18, 2020

View reviewed changes

dboltovskyi approved these changes Dec 18, 2020

View reviewed changes

upd diagrams KeyboardEventInputKeyMask, SetGlobalPropertiesResumption…

30e6913

…KeyboardProperties after demo

AKalinich-Luxoft approved these changes Jan 5, 2021

View reviewed changes

KhrystynaDubovyk and others added 9 commits February 8, 2021 13:28

update per proposal revision

bdf9042

upd p5 of OnSystemCapabilityUpdated index

7bf061d

remove p.2 from NOTE section

b1deb58

Merge pull request #13 from LuxoftSDL/feature/sdl_0238_keyboard_enhan…

0149963

…cements_revision SDL-0238 update per proposal revision

Merge branch 'develop' into feature/sdl_0238_keyboard_enhancements

6bb323b

Apply suggestions from code review

6a12ab4

Co-authored-by: Jacob Keeler <jacob.keeler@livioradio.com>

upd KeyboardEventInputKeyMask.png

282b84d

remove examples' values from SetGlobalProperties index

9215059

replace MUST section of SetGlobalProperties index

966f454

KhrystynaDubovyk and others added 4 commits February 10, 2021 15:48

add the deleted link to SetGlobalProperties_TTS_UI_VR diagram

4258a72

Apply suggestions from code review

c7734de

Co-authored-by: Jacob Keeler <jacob.keeler@livioradio.com>

upd KeyboardEventInputKeyMask diagram

7956763

Merge branch 'develop' into feature/sdl_0238_keyboard_enhancements

5d25e16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/0238 Keyboard Enhancements #10

Feature/0238 Keyboard Enhancements #10

KhrystynaDubovyk commented Dec 7, 2020

LitvinenkoIra Dec 11, 2020

dboltovskyi Dec 14, 2020

KhrystynaDubovyk Dec 16, 2020

dboltovskyi Dec 14, 2020

KhrystynaDubovyk Dec 17, 2020

dboltovskyi Dec 14, 2020

KhrystynaDubovyk Dec 16, 2020

dboltovskyi Dec 14, 2020

KhrystynaDubovyk Dec 15, 2020

KhrystynaDubovyk Dec 16, 2020

dboltovskyi Dec 14, 2020

KhrystynaDubovyk Dec 16, 2020

dboltovskyi Dec 14, 2020

dboltovskyi Dec 14, 2020

ychernysheva Dec 17, 2020

ychernysheva Dec 17, 2020

KhrystynaDubovyk Dec 17, 2020

dboltovskyi Dec 17, 2020

KhrystynaDubovyk Dec 18, 2020

dboltovskyi Dec 17, 2020

KhrystynaDubovyk Dec 18, 2020

dboltovskyi Dec 17, 2020

dboltovskyi Dec 17, 2020

KhrystynaDubovyk Dec 18, 2020


		2. In case HMI sends `KeyboardCapabilities` without information about `numConfigurableKeys` within OnSystemCapabilityUpdated notification, SDL would provide `KeyboardCapabilities` to app with `numConfigurableKeys` set to zero.


		SDL-->App: RegisterAppInterface (SUCCESS)

		SDL->>HMI: BC.OnAppRegistered(appName; appID)

Feature/0238 Keyboard Enhancements #10

Are you sure you want to change the base?

Feature/0238 Keyboard Enhancements #10

Conversation

KhrystynaDubovyk commented Dec 7, 2020

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

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