doc/readme.md

   1
   2 usage of onscreenapp
   3 ===
   4
   5 ## dependence
   6
   7 - Onscreenapp depend on libhomescreen add agl-service-homescreen as below:
   8         - libhomescreen must have 'showWindow/hideWindow/replyShowWindow' event
   9                 and 'showWindow/hideWindow/replyShowWindow' interface.
  10         - agl-service-homescreen must have 'showWindow/hideWindow/replyShowWindow' verbs.
  11
  12 - Application need to deploy their onscreen qml file to "/usr/lib/qt5/qml/AGL/OnScreen/appid/" folder.
  13
  14 ## sequence
  15
  16 show/hide onscreen sequence.
  17 - ![showOnscreen.svg](parts/showOnscreen.svg)
  18
  19 ## about sample 'onstestapp'
  20 onstestapp is a sample to use onscreenapp.
  21
  22 ### compile & install
  23 - compile
  24         - when onscreenapp is compiled, this app's wgt file will exist at "onscreenapp/sample/package" which called onstestapp.wgt.
  25
  26 - install
  27                 `afm-util install onstestapp.wgt;sync`
  28
  29 ### onstestapp usage
  30
  31 Before start onstestapp you must copy all files in "qml" folder to "/usr/lib/qt5/qml/AGL/OnScreen/onstestapp/" on your board(R-car M3 etc.),
  32 then do as below:
  33
  34 1. start onstestapp in launcher
  35 2. select onscreen type
  36 3. press "Post" button
  37
  38 ### edit parameter with keyboard
  39
  40 You also can edit the text which will post to onscreen, do as below:
  41
  42 - comment below contents in /etc/xdg/weston/weston.ini
  43         - `#ivi-input-module=ivi-input-controller.so`
  44
  45 - before press "Post" button, touch text area to call keyboard and edit the text.
  46