resource/csdk/connectivity/src/bt_le_adapter/linux/bluez.xml

   1 <!--
   2     Copyright 2015 Intel Corporation All Rights Reserved.
   3
   4     Licensed under the Apache License, Version 2.0 (the "License");
   5     you may not use this file except in compliance with the License.
   6     You may obtain a copy of the License at
   7
   8          http://www.apache.org/licenses/LICENSE-2.0
   9
  10     Unless required by applicable law or agreed to in writing, software
  11     distributed under the License is distributed on an "AS IS" BASIS,
  12     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13     See the License for the specific language governing permissions and
  14     limitations under the License.
  15
  16     ******************************************************************
  17
  18     The introspection XML found in this file is used to generate GDBus
  19     skeleton code that will be used by the IoTivity BlueZ-based GATT
  20     Service (OIC Transport Profile) implementation.
  21
  22     See the GATT and LE Advertisement API documentation in the BlueZ
  23     gatt-api.txt and advertisement-api.txt documents, respectively for
  24     further details.
  25 -->
  26
  27 <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
  28 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
  29 <node name="/org/iotivity/gatt/service">
  30
  31   <!--
  32       ***********************************************
  33       BlueZ GATT Service interface introspection XML.
  34       ***********************************************
  35   -->
  36   <interface name="org.bluez.GattService1">
  37     <annotation name="org.freedesktop.DBus.Properties.PropertiesChanged" value="const"/>
  38
  39     <property name="UUID" type="s" access="read"/>
  40     <property name="Primary" type="b" access="read"/>
  41     <property name="Characteristics" type="ao" access="read"/>
  42
  43     <!--
  44     ===========================================================
  45     The "Device" property is only exposed on the client side by
  46     BlueZ itself.  It isn't set by the IoTivity server side.
  47     Don't bother generating skeleton code for it.
  48     ===========================================================
  49     <property name="Device" type="o" access="read">
  50       <annotation name="org.freedesktop.DBus.Properties.PropertiesChanged" value="true"/>
  51     </property>
  52
  53     ===========================================================
  54     The "Includes" property is not supported as of BlueZ 5.30.
  55     It also isn't used by the IoTivity server side
  56     implementation.  Don't bother generating skeleton code for
  57     it.
  58     ===========================================================
  59     <property name="Includes" type="ao" access="read"/>
  60     -->
  61
  62   </interface>
  63
  64   <!--
  65       ******************************************************
  66       BlueZ GATT Characteristic interface introspection XML.
  67       ******************************************************
  68   -->
  69   <interface name="org.bluez.GattCharacteristic1">
  70     <!--
  71     ============================================================
  72     None of the OIC GATT characteristics support the "ReadValue"
  73     method.  Don't bother generating skeleton code for it.
  74     ============================================================
  75     <method name="ReadValue">
  76       <arg name="value" type="ay" direction="out"/>
  77       <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
  78     </method>
  79     -->
  80
  81     <method name="WriteValue">
  82       <arg name="value" type="ay" direction="in">
  83         <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
  84       </arg>
  85     </method>
  86
  87     <method name="StartNotify"/>
  88
  89     <method name="StopNotify"/>
  90
  91     <annotation name="org.freedesktop.DBus.Properties.PropertiesChanged" value="const"/>
  92
  93     <property name="UUID" type="s" access="read"/>
  94     <property name="Service" type="o" access="read"/>
  95
  96     <property name="Value" type="ay" access="read">
  97       <annotation name="org.freedesktop.DBus.Properties.PropertiesChanged" value="true"/>
  98       <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
  99     </property>
 100
 101     <property name="Notifying" type="b" access="read">
 102       <annotation name="org.freedesktop.DBus.Properties.PropertiesChanged" value="true"/>
 103     </property>
 104     <property name="Flags" type="as" access="read"/>
 105     <property name="Descriptors" type="ao" access="read"/>
 106   </interface>
 107
 108   <!--
 109       **************************************************
 110       BlueZ GATT Descriptor interface introspection XML.
 111       **************************************************
 112   -->
 113   <interface name="org.bluez.GattDescriptor1">
 114     <method name="ReadValue">
 115       <arg name="value" type="ay" direction="out">
 116         <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
 117       </arg>
 118     </method>
 119
 120     <!--
 121     ============================================================
 122     None of the OIC GATT descriptors directly supported by
 123     IoTivity support the "WriteValue" method.  The OIC Client
 124     Characteristic Configuration Descriptor supports writes, but
 125     that descriptor is handled by BlueZ, not IoTivity, when the
 126     "notify" property is set on a given GATT characteristic.
 127     Don't bother generating skeleton code for it.
 128     ============================================================
 129
 130     <method name="WriteValue">
 131       <arg name="value" type="ay" direction="in">
 132             <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
 133           </arg>
 134     </method>
 135     -->
 136
 137     <annotation name="org.freedesktop.DBus.Properties.PropertiesChanged" value="const"/>
 138
 139     <property name="UUID" type="s" access="read"/>
 140     <property name="Characteristic" type="o" access="read"/>
 141
 142     <property name="Value" type="ay" access="read">
 143       <annotation name="org.freedesktop.DBus.Properties.PropertiesChanged" value="true"/>
 144       <annotation name="org.gtk.GDBus.C.ForceGVariant" value="true"/>
 145     </property>
 146
 147     <property name="Flags" type="as" access="read"/>
 148   </interface>
 149
 150   <!--
 151       ***************************************************
 152       BlueZ LE Advertisement interface introspection XML.
 153       ***************************************************
 154   -->
 155   <interface name="org.bluez.LEAdvertisement1">
 156     <method name="Release">
 157       <annotation name="org.freedesktop.DBus.Method.NoReply" value="true"/>
 158     </method>
 159
 160     <annotation name="org.freedesktop.DBus.Properties.PropertiesChanged" value="const"/>
 161
 162     <property name="Type" type="s" access="read"/>
 163     <property name="ServiceUUIDs" type="as" access="read"/>
 164     <property name="ManufacturerData" type="a{sv}" access="read"/>
 165     <property name="SolicitUUIDs" type="as" access="read"/>
 166     <property name="ServiceData" type="a{sv}" access="read"/>
 167     <property name="IncludeTxPower" type="b" access="read"/>
 168   </interface>
 169
 170 </node>