1<?xml version="1.0" encoding="UTF-8"?> 2<protocol name="ivi_hmi_controller"> 3 4 <copyright> 5 Copyright (C) 2013 DENSO CORPORATION 6 Copyright (c) 2013 BMW Car IT GmbH 7 8 Permission is hereby granted, free of charge, to any person obtaining a 9 copy of this software and associated documentation files (the "Software"), 10 to deal in the Software without restriction, including without limitation 11 the rights to use, copy, modify, merge, publish, distribute, sublicense, 12 and/or sell copies of the Software, and to permit persons to whom the 13 Software is furnished to do so, subject to the following conditions: 14 15 The above copyright notice and this permission notice (including the next 16 paragraph) shall be included in all copies or substantial portions of the 17 Software. 18 19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 22 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 24 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 25 DEALINGS IN THE SOFTWARE. 26 </copyright> 27 28 <interface name="ivi_hmi_controller" version="1"> 29 <description summary="set up and control IVI style UI"/> 30 31 <request name="UI_ready"> 32 <description summary="inform the ready for drawing desktop." /> 33 </request> 34 35 <request name="workspace_control"> 36 <description summary="start controlling a surface by server"> 37 Reference protocol to control a surface by server. 38 To control a surface by server, it gives seat to the server 39 to e.g. control Home screen. Home screen has several workspaces 40 to group launchers of wayland application. These workspaces 41 are drawn on a horizontally long surface to be controlled 42 by motion of input device. E.g. A motion from right to left 43 happens, the viewport of surface is controlled in the ivi-shell 44 by using ivi-layout. client can recognizes the end of controlling 45 by event "workspace_end_control". 46 </description> 47 <arg name="seat" type="object" interface="wl_seat"/> 48 <arg name="serial" type="uint"/> 49 </request> 50 51 <enum name="layout_mode"> 52 <entry name="tiling" value="0"/> 53 <entry name="side_by_side" value="1"/> 54 <entry name="full_screen" value="2"/> 55 <entry name="random" value="3" /> 56 </enum> 57 58 <request name="switch_mode"> 59 <description summary="request mode switch of application layout"> 60 hmi-controller loaded to ivi-shall implements 4 types of layout 61 as a reference; tiling, side by side, full_screen, and random. 62 </description> 63 <arg name="layout_mode" type="uint"/> 64 </request> 65 66 <enum name="home"> 67 <entry name="off" value="0"/> 68 <entry name="on" value="1"/> 69 </enum> 70 71 <request name="home"> 72 <description summary="request displaying/undisplaying home screen"> 73 home screen is a reference implementation of launcher to launch 74 wayland applications. The home screen has several workspaces to 75 group wayland applications. By defining the following keys in 76 weston.ini, user can add launcher icon to launch a wayland application 77 to a workspace. 78 [ivi-launcher] 79 workspace-id=0 80 : id of workspace to add a launcher 81 icon-id=4001 82 : ivi id of ivi_surface to draw an icon 83 icon=/home/user/review/build-ivi-shell/data/icon_ivi_flower.png 84 : path to icon image 85 path=/home/user/review/build-ivi-shell/weston-dnd 86 : path to wayland application 87 </description> 88 <arg name="home" type="uint"/> 89 </request> 90 91 <event name="workspace_end_control"> 92 <description summary="notify controlling workspace end"/> 93 <arg name="is_controlled" type="int"/> 94 </event> 95 96 </interface> 97 98</protocol> 99
