summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/parts/showOnscreen.svg84
-rw-r--r--doc/readme.md32
2 files changed, 116 insertions, 0 deletions
diff --git a/doc/parts/showOnscreen.svg b/doc/parts/showOnscreen.svg
new file mode 100644
index 0000000..6f4d3ea
--- /dev/null
+++ b/doc/parts/showOnscreen.svg
@@ -0,0 +1,84 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="application/ecmascript" contentStyleType="text/css" height="1362px" preserveAspectRatio="none" style="width:808px;height:1362px;" version="1.1" viewBox="0 0 808 1362" width="808px" zoomAndPan="magnify"><defs><filter height="300%" id="flevyh72bfgyv" width="300%" x="-1" y="-1"><feGaussianBlur result="blurOut" stdDeviation="2.0"/><feColorMatrix in="blurOut" result="blurOut2" type="matrix" values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 .4 0"/><feOffset dx="4.0" dy="4.0" in="blurOut2" result="blurOut3"/><feBlend in="SourceGraphic" in2="blurOut3" mode="normal"/></filter></defs><g><text fill="#000000" font-family="sans-serif" font-size="14" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="190" x="304.75" y="24.5332">show/hide onscreen phase</text><rect fill="#FFFFFF" filter="url(#flevyh72bfgyv)" height="178.5938" style="stroke: #000000; stroke-width: 2.0;" width="397.5" x="389" y="704.0078"/><rect fill="#FFFFFF" height="56.1875" style="stroke: none; stroke-width: 1.0;" width="397.5" x="389" y="826.4141"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="41" x2="41" y1="119.2188" y2="1274.1719"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="135" x2="135" y1="119.2188" y2="1274.1719"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="331" x2="331" y1="119.2188" y2="1274.1719"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="445.5" x2="445.5" y1="119.2188" y2="1274.1719"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 5.0,5.0;" x1="722.5" x2="722.5" y1="119.2188" y2="1274.1719"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="28" x="24" y="116.1426">user</text><ellipse cx="41" cy="44.6094" fill="#FEFECE" filter="url(#flevyh72bfgyv)" rx="8" ry="8" style="stroke: #A80036; stroke-width: 2.0;"/><path d="M41,52.6094 L41,79.6094 M28,60.6094 L54,60.6094 M41,79.6094 L28,94.6094 M41,79.6094 L54,94.6094 " fill="none" filter="url(#flevyh72bfgyv)" style="stroke: #A80036; stroke-width: 2.0;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="28" x="24" y="1287.7051">user</text><ellipse cx="41" cy="1300.7813" fill="#FEFECE" filter="url(#flevyh72bfgyv)" rx="8" ry="8" style="stroke: #A80036; stroke-width: 2.0;"/><path d="M41,1308.7813 L41,1335.7813 M28,1316.7813 L54,1316.7813 M41,1335.7813 L28,1350.7813 M41,1335.7813 L54,1350.7813 " fill="none" filter="url(#flevyh72bfgyv)" style="stroke: #A80036; stroke-width: 2.0;"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="128" x="68" y="116.1426">homescreen-service</text><ellipse cx="135" cy="85.6094" fill="#FEFECE" filter="url(#flevyh72bfgyv)" rx="12" ry="12" style="stroke: #A80036; stroke-width: 2.0;"/><line style="stroke: #A80036; stroke-width: 2.0;" x1="123" x2="147" y1="99.6094" y2="99.6094"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="128" x="68" y="1287.7051">homescreen-service</text><ellipse cx="135" cy="1306.7813" fill="#FEFECE" filter="url(#flevyh72bfgyv)" rx="12" ry="12" style="stroke: #A80036; stroke-width: 2.0;"/><line style="stroke: #A80036; stroke-width: 2.0;" x1="123" x2="147" y1="1320.7813" y2="1320.7813"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="25" x="315.5" y="116.1426">App</text><ellipse cx="331" cy="85.6094" fill="#FEFECE" filter="url(#flevyh72bfgyv)" rx="12" ry="12" style="stroke: #A80036; stroke-width: 2.0;"/><line style="stroke: #A80036; stroke-width: 2.0;" x1="319" x2="343" y1="99.6094" y2="99.6094"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="25" x="315.5" y="1287.7051">App</text><ellipse cx="331" cy="1306.7813" fill="#FEFECE" filter="url(#flevyh72bfgyv)" rx="12" ry="12" style="stroke: #A80036; stroke-width: 2.0;"/><line style="stroke: #A80036; stroke-width: 2.0;" x1="319" x2="343" y1="1320.7813" y2="1320.7813"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="83" x="401.5" y="116.1426">onscreenapp</text><ellipse cx="446" cy="85.6094" fill="#FEFECE" filter="url(#flevyh72bfgyv)" rx="12" ry="12" style="stroke: #A80036; stroke-width: 2.0;"/><line style="stroke: #A80036; stroke-width: 2.0;" x1="434" x2="458" y1="99.6094" y2="99.6094"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="83" x="401.5" y="1287.7051">onscreenapp</text><ellipse cx="446" cy="1306.7813" fill="#FEFECE" filter="url(#flevyh72bfgyv)" rx="12" ry="12" style="stroke: #A80036; stroke-width: 2.0;"/><line style="stroke: #A80036; stroke-width: 2.0;" x1="434" x2="458" y1="1320.7813" y2="1320.7813"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="101" x="669.5" y="116.1426">windowmanager</text><ellipse cx="723" cy="85.6094" fill="#FEFECE" filter="url(#flevyh72bfgyv)" rx="12" ry="12" style="stroke: #A80036; stroke-width: 2.0;"/><line style="stroke: #A80036; stroke-width: 2.0;" x1="711" x2="735" y1="99.6094" y2="99.6094"/><text fill="#000000" font-family="sans-serif" font-size="14" lengthAdjust="spacingAndGlyphs" textLength="101" x="669.5" y="1287.7051">windowmanager</text><ellipse cx="723" cy="1306.7813" fill="#FEFECE" filter="url(#flevyh72bfgyv)" rx="12" ry="12" style="stroke: #A80036; stroke-width: 2.0;"/><line style="stroke: #A80036; stroke-width: 2.0;" x1="711" x2="735" y1="1320.7813" y2="1320.7813"/><rect fill="#EEEEEE" filter="url(#flevyh72bfgyv)" height="3" style="stroke: #EEEEEE; stroke-width: 1.0;" width="793.5" x="3" y="150.3945"/><line style="stroke: #000000; stroke-width: 1.0;" x1="3" x2="796.5" y1="150.3945" y2="150.3945"/><line style="stroke: #000000; stroke-width: 1.0;" x1="3" x2="796.5" y1="153.3945" y2="153.3945"/><rect fill="#EEEEEE" filter="url(#flevyh72bfgyv)" height="24.3516" style="stroke: #000000; stroke-width: 2.0;" width="113" x="343.25" y="139.2188"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="95" x="349.25" y="156.7139">show onscreen</text><polygon fill="#A80036" points="319,191.5703,329,195.5703,319,199.5703,323,195.5703" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="41" x2="325" y1="195.5703" y2="195.5703"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="179" x="48" y="191.0654">the operation request onscreen</text><polygon fill="#A80036" points="146,221.9219,136,225.9219,146,229.9219,142,225.9219" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="140" x2="330" y1="225.9219" y2="225.9219"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="84" x="152" y="221.417">showWindow()</text><path d="M8,239.2734 L8,396.2734 L454,396.2734 L454,249.2734 L444,239.2734 L8,239.2734 " fill="#FBFB77" filter="url(#flevyh72bfgyv)" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M444,239.2734 L444,249.2734 L454,249.2734 L444,239.2734 " fill="#FBFB77" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="4" x="14" y="257.7686">{</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="185" x="46" y="274.1201">"application_id": "onscreenapp",</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="80" x="46" y="290.4717">"parameter": {</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="131" x="78" y="306.8232">"title": "onscreen title",</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="289" x="78" y="323.1748">"type": "critical,exclamation,question,information",</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="189" x="78" y="339.5264">"contents": "message contents",</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="361" x="78" y="355.8779">"buttons": ["button_name1", "button_name2", "button_name3"]</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="4" x="46" y="372.2295">}</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="4" x="14" y="388.5811">}</text><polygon fill="#A80036" points="434,423.4375,444,427.4375,434,431.4375,438,427.4375" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="135" x2="440" y1="427.4375" y2="427.4375"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="142" x="142" y="422.9326">push showWindow event</text><path d="M63,440.7891 L63,613.7891 L513,613.7891 L513,450.7891 L503,440.7891 L63,440.7891 " fill="#FBFB77" filter="url(#flevyh72bfgyv)" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M503,440.7891 L503,450.7891 L513,450.7891 L503,440.7891 " fill="#FBFB77" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="4" x="69" y="459.2842">{</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="185" x="101" y="475.6357">"application_id": "onscreenapp",</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="80" x="101" y="491.9873">"parameter": {</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="131" x="133" y="508.3389">"title": "onscreen title",</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="289" x="133" y="524.6904">"type": "critical,exclamation,question,information",</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="189" x="133" y="541.042">"contents": "message contents",</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="365" x="133" y="557.3936">"buttons": ["button_name1", "button_name2", "button_name3"],</text><text fill="#FF0000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="174" x="133" y="573.7451">"replyto":"caller application id"</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="4" x="101" y="590.0967">}</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="4" x="69" y="606.4482">}</text><line style="stroke: #A80036; stroke-width: 1.0;" x1="446" x2="488" y1="645.6563" y2="645.6563"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="488" x2="488" y1="645.6563" y2="658.6563"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="447" x2="488" y1="658.6563" y2="658.6563"/><polygon fill="#A80036" points="457,654.6563,447,658.6563,457,662.6563,453,658.6563" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="135" x="453" y="640.7998">get and save parameter</text><polygon fill="#A80036" points="711,684.6563,721,688.6563,711,692.6563,715,688.6563" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="446" x2="717" y1="688.6563" y2="688.6563"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="253" x="453" y="684.1514">activateWindow("onscreeapp", "on_screen")</text><path d="M389,704.0078 L450,704.0078 L450,712.0078 L440,722.0078 L389,722.0078 L389,704.0078 " fill="#EEEEEE" style="stroke: #000000; stroke-width: 1.0;"/><rect fill="none" height="178.5938" style="stroke: #000000; stroke-width: 2.0;" width="397.5" x="389" y="704.0078"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="16" x="404" y="718.5029">alt</text><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="61" x="465" y="717.4268">[can show]</text><polygon fill="#A80036" points="457,740.3594,447,744.3594,457,748.3594,453,744.3594" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="451" x2="722" y1="744.3594" y2="744.3594"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="123" x="463" y="739.8545">push syncDraw event</text><polygon fill="#A80036" points="711,770.7109,721,774.7109,711,778.7109,715,774.7109" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="446" x2="717" y1="774.7109" y2="774.7109"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="135" x="453" y="770.2061">endDraw("onscreeapp")</text><line style="stroke: #A80036; stroke-width: 1.0;" x1="446" x2="488" y1="805.4141" y2="805.4141"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="488" x2="488" y1="805.4141" y2="818.4141"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="447" x2="488" y1="818.4141" y2="818.4141"/><polygon fill="#A80036" points="457,814.4141,447,818.4141,457,822.4141,453,818.4141" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="196" x="453" y="800.5576">show onscreen as request pattern</text><line style="stroke: #000000; stroke-width: 1.0; stroke-dasharray: 2.0,2.0;" x1="389" x2="786.5" y1="827.4141" y2="827.4141"/><text fill="#000000" font-family="sans-serif" font-size="11" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="68" x="394" y="838.833">[can't show]</text><path d="M399,847.25 L399,873.25 L769,873.25 L769,857.25 L759,847.25 L399,847.25 " fill="#FBFB77" filter="url(#flevyh72bfgyv)" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M759,847.25 L759,857.25 L769,857.25 L759,847.25 " fill="#FBFB77" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="60" x="547.5" y="865.7451">do nothing</text><rect fill="#EEEEEE" filter="url(#flevyh72bfgyv)" height="3" style="stroke: #EEEEEE; stroke-width: 1.0;" width="793.5" x="3" y="910.7773"/><line style="stroke: #000000; stroke-width: 1.0;" x1="3" x2="796.5" y1="910.7773" y2="910.7773"/><line style="stroke: #000000; stroke-width: 1.0;" x1="3" x2="796.5" y1="913.7773" y2="913.7773"/><rect fill="#EEEEEE" filter="url(#flevyh72bfgyv)" height="24.3516" style="stroke: #000000; stroke-width: 2.0;" width="108" x="345.75" y="899.6016"/><text fill="#000000" font-family="sans-serif" font-size="13" font-weight="bold" lengthAdjust="spacingAndGlyphs" textLength="90" x="351.75" y="917.0967">hide onscreen</text><polygon fill="#A80036" points="434,951.9531,444,955.9531,434,959.9531,438,955.9531" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="41" x2="440" y1="955.9531" y2="955.9531"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="124" x="48" y="951.4482">tap onscreen's button</text><polygon fill="#A80036" points="711,982.3047,721,986.3047,711,990.3047,715,986.3047" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="446" x2="717" y1="986.3047" y2="986.3047"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="200" x="453" y="981.7998">deactivateWindow("onscreenapp");</text><line style="stroke: #A80036; stroke-width: 1.0;" x1="446" x2="488" y1="1017.0078" y2="1017.0078"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="488" x2="488" y1="1017.0078" y2="1030.0078"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="447" x2="488" y1="1030.0078" y2="1030.0078"/><polygon fill="#A80036" points="457,1026.0078,447,1030.0078,457,1034.0078,453,1030.0078" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="70" x="453" y="1012.1514">hide window</text><polygon fill="#A80036" points="146,1056.0078,136,1060.0078,146,1064.0078,142,1060.0078" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="140" x2="445" y1="1060.0078" y2="1060.0078"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="114" x="152" y="1055.5029">replyShowWindow()</text><path d="M81,1073.3594 L81,1181.3594 L498,1181.3594 L498,1083.3594 L488,1073.3594 L81,1073.3594 " fill="#FBFB77" filter="url(#flevyh72bfgyv)" style="stroke: #A80036; stroke-width: 1.0;"/><path d="M488,1073.3594 L488,1083.3594 L498,1083.3594 L488,1073.3594 " fill="#FBFB77" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="4" x="98.25" y="1091.8545">{</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="334" x="130.25" y="1108.2061">"application_id":"the application who called onscreenapp",</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="80" x="130.25" y="1124.5576">"parameter": {</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="178" x="162.25" y="1140.9092">"buttonName": "VOLUME_UP"</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="4" x="130.25" y="1157.2607">}</text><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="4" x="98.25" y="1173.6123">}</text><polygon fill="#A80036" points="319,1208.4688,329,1212.4688,319,1216.4688,323,1212.4688" style="stroke: #A80036; stroke-width: 1.0;"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="135" x2="325" y1="1212.4688" y2="1212.4688"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="172" x="142" y="1207.9639">push replyShowWindow event</text><line style="stroke: #A80036; stroke-width: 1.0;" x1="331" x2="373" y1="1243.1719" y2="1243.1719"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="373" x2="373" y1="1243.1719" y2="1256.1719"/><line style="stroke: #A80036; stroke-width: 1.0;" x1="332" x2="373" y1="1256.1719" y2="1256.1719"/><polygon fill="#A80036" points="342,1252.1719,332,1256.1719,342,1260.1719,338,1256.1719" style="stroke: #A80036; stroke-width: 1.0;"/><text fill="#000000" font-family="sans-serif" font-size="13" lengthAdjust="spacingAndGlyphs" textLength="101" x="338" y="1238.3154">call reply function</text><!--
+@startuml
+
+title show/hide onscreen phase
+
+actor user
+entity "homescreen-service" as hss
+entity App
+entity onscreenapp
+entity windowmanager as wm
+
+== show onscreen ==
+user->App: the operation request onscreen
+App->hss: showWindow()
+note over App,hss
+{
+ "application_id": "onscreenapp",
+ "parameter": {
+ "title": "onscreen title",
+ "type": "critical,exclamation,question,information",
+ "contents": "message contents",
+ "buttons": ["button_name1", "button_name2", "button_name3"]
+ }
+}
+end note
+
+hss->onscreenapp: push showWindow event
+note over hss,onscreenapp
+{
+ "application_id": "onscreenapp",
+ "parameter": {
+ "title": "onscreen title",
+ "type": "critical,exclamation,question,information",
+ "contents": "message contents",
+ "buttons": ["button_name1", "button_name2", "button_name3"],
+ <font color=red >"replyto":"caller application id"
+ }
+}
+end note
+
+onscreenapp->onscreenapp: get and save parameter
+onscreenapp->wm: activateWindow("onscreeapp", "on_screen")
+alt can show
+wm- ->onscreenapp: push syncDraw event
+onscreenapp->wm: endDraw("onscreeapp")
+onscreenapp->onscreenapp: show onscreen as request pattern
+
+else can't show
+note over onscreenapp,wm
+do nothing
+end note
+end
+
+== hide onscreen ==
+
+user->onscreenapp: tap onscreen's button
+onscreenapp->wm: deactivateWindow("onscreenapp");
+onscreenapp->onscreenapp: hide window
+
+onscreenapp->hss: replyShowWindow()
+note over onscreenapp,hss
+{
+ "application_id":"the application who called onscreenapp",
+ "parameter": {
+ "buttonName": "VOLUME_UP"
+ }
+}
+end note
+hss->App: push replyShowWindow event
+App->App: call reply function
+
+@enduml
+
+PlantUML version 1.2018.01(Mon Jan 29 02:08:22 CST 2018)
+(GPL source distribution)
+Java Runtime: Java(TM) SE Runtime Environment
+JVM: Java HotSpot(TM) 64-Bit Server VM
+Java Version: 1.8.0_45-b15
+Operating System: Windows 7
+OS Version: 6.1
+Default Encoding: MS932
+Language: ja
+Country: JP
+--></g></svg> \ No newline at end of file
diff --git a/doc/readme.md b/doc/readme.md
new file mode 100644
index 0000000..f9da853
--- /dev/null
+++ b/doc/readme.md
@@ -0,0 +1,32 @@
+
+usage of onscreenapp
+===
+
+## dependence
+
+- Onscreenapp depend on libhomescreen add agl-service-homescreen as below:
+ - libhomescreen must have 'showWindow/hideWindow/replyShowWindow' event
+ and 'showWindow/hideWindow/replyShowWindow' interface.
+ - agl-service-homescreen must have 'showWindow/hideWindow/replyShowWindow' verbs.
+
+## sequence
+
+show/hide onscreen sequence.
+- ![showOnscreen.svg](parts/showOnscreen.svg)
+
+## about sample 'onstestapp'
+onstestapp is a sample to use onscreenapp.
+
+### compile & install
+- compile
+ - when onscreenapp is compiled, this app's wgt file will exist at "onscreenapp/sample/package" which called onstestapp.wgt.
+
+- install
+ `afm-util install onstestapp.wgt;sync`
+
+### onstestapp usage
+- start onstestapp in launcher
+- select onscreen type in groupbox
+- press "Post" button
+
+After clicked onscreen's button,you will see reply information at top area of onstestapp.