Document the public DBus API.
This commit is contained in:
Tambet Ingo
@@ -0,0 +1,27 @@
|
||||
<tp:spec
|
||||
xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
|
||||
<tp:title>ModemManager D-Bus Interface Specification</tp:title>
|
||||
<tp:version>0.1</tp:version>
|
||||
<tp:copyright>Copyright (C) 2008 Novell, Inc.</tp:copyright>
|
||||
|
||||
<tp:license xmlns="http://www.w3.org/1999/xhtml">
|
||||
<p>This program is free software; you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.</p>
|
||||
|
||||
<p>This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
General Public License for more details.</p>
|
||||
|
||||
<p>You should have received a copy of the GNU Lesser General Public
|
||||
License along with this library; if not, write to the Free Software
|
||||
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p>
|
||||
</tp:license>
|
||||
|
||||
<xi:include href="mm-manager.xml"/>
|
||||
<xi:include href="mm-modem.xml"/>
|
||||
</tp:spec>
|
||||
@@ -1,18 +1,39 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
|
||||
<node name="/">
|
||||
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
|
||||
<interface name="org.freedesktop.ModemManager">
|
||||
<method name="EnumerateDevices">
|
||||
<tp:docstring>
|
||||
Get the list of modem devices.
|
||||
</tp:docstring>
|
||||
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_manager_enumerate_devices"/>
|
||||
<arg name="devices" type="ao" direction="out"/>
|
||||
<arg name="devices" type="ao" direction="out">
|
||||
<tp:docstring>
|
||||
List of object paths of modem devices known to the system.
|
||||
</tp:docstring>
|
||||
</arg>
|
||||
</method>
|
||||
|
||||
<signal name="DeviceAdded">
|
||||
<arg name="device" type="o"/>
|
||||
<tp:docstring>
|
||||
A device was added to the system.
|
||||
</tp:docstring>
|
||||
<arg name="device" type="o">
|
||||
<tp:docstring>
|
||||
The object path of the newly added device.
|
||||
</tp:docstring>
|
||||
</arg>
|
||||
</signal>
|
||||
|
||||
<signal name="DeviceRemoved">
|
||||
<arg name="device" type="o"/>
|
||||
<tp:docstring>
|
||||
A device was removed from the system, and is no longer available.
|
||||
</tp:docstring>
|
||||
<arg name="device" type="o">
|
||||
<tp:docstring>
|
||||
The object path of the device that was just removed.
|
||||
</tp:docstring>
|
||||
</arg>
|
||||
</signal>
|
||||
|
||||
</interface>
|
||||
|
||||
+233
-17
@@ -1,85 +1,301 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
|
||||
<node name="/">
|
||||
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
|
||||
<interface name="org.freedesktop.ModemManager.Modem">
|
||||
<method name="Enable">
|
||||
<tp:docstring>
|
||||
Enable the device. Initializes the modem and checks whether PIN (or PUK) is needed.
|
||||
</tp:docstring>
|
||||
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
|
||||
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_enable"/>
|
||||
<arg name="enable" type="b" direction="in"/>
|
||||
<arg name="enable" type="b" direction="in">
|
||||
<tp:docstring>
|
||||
True to enable the device, False to disable.
|
||||
</tp:docstring>
|
||||
</arg>
|
||||
</method>
|
||||
|
||||
<method name="SetPin">
|
||||
<tp:docstring>
|
||||
Set the PIN (or PUK) to unlock the SIM card.
|
||||
</tp:docstring>
|
||||
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
|
||||
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_set_pin"/>
|
||||
<arg name="secret" type="s" direction="in"/>
|
||||
<arg name="pin" type="s" direction="in">
|
||||
The PIN code.
|
||||
</arg>
|
||||
</method>
|
||||
|
||||
<method name="Register">
|
||||
<tp:docstring>
|
||||
Register the device to network.
|
||||
</tp:docstring>
|
||||
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
|
||||
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_register"/>
|
||||
<arg name="network_id" type="s" direction="in"/>
|
||||
<arg name="network_id" type="s" direction="in">
|
||||
<tp:docstring>
|
||||
The network ID to register. An empty string can be used to register to the home network.
|
||||
</tp:docstring>
|
||||
</arg>
|
||||
</method>
|
||||
|
||||
<method name="Connect">
|
||||
<tp:docstring>
|
||||
Dial in.
|
||||
</tp:docstring>
|
||||
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
|
||||
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_connect"/>
|
||||
<arg name="number" type="s" direction="in"/>
|
||||
<arg name="apn" type="s" direction="in"/>
|
||||
<arg name="number" type="s" direction="in">
|
||||
<tp:docstring>
|
||||
The number to use for dialing.
|
||||
</tp:docstring>
|
||||
</arg>
|
||||
<arg name="apn" type="s" direction="in">
|
||||
<tp:docstring>
|
||||
The APN to use. Can be an empty string to use the default APN from the SIM card.
|
||||
</tp:docstring>
|
||||
</arg>
|
||||
</method>
|
||||
|
||||
<method name="Disconnect">
|
||||
<tp:docstring>
|
||||
Disconnect modem.
|
||||
</tp:docstring>
|
||||
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
|
||||
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_disconnect"/>
|
||||
</method>
|
||||
|
||||
<method name="Scan">
|
||||
<tp:docstring>
|
||||
Scan for available networks.
|
||||
</tp:docstring>
|
||||
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
|
||||
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_scan"/>
|
||||
<arg name="results" type="aa{ss}" direction="out"/>
|
||||
<arg name="results" type="aa{ss}" direction="out">
|
||||
<tp:docstring>
|
||||
Found networks. It's an array of dictionaries (strings for keys and values), the list of known keys is the following: status, operator-long, operator-short, operator-num.
|
||||
</tp:docstring>
|
||||
</arg>
|
||||
</method>
|
||||
|
||||
<method name="GetSignalQuality">
|
||||
<tp:docstring>
|
||||
Get the current signal quality.
|
||||
</tp:docstring>
|
||||
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
|
||||
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_get_signal_quality"/>
|
||||
<arg name="quality" type="u" direction="out"/>
|
||||
<arg name="quality" type="u" direction="out">
|
||||
<tp:docstring>
|
||||
Signal quality (percent).
|
||||
</tp:docstring>
|
||||
</arg>
|
||||
</method>
|
||||
|
||||
<method name="SetBand">
|
||||
<tp:docstring>
|
||||
Set the band.
|
||||
</tp:docstring>
|
||||
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
|
||||
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_set_band"/>
|
||||
<arg name="band" type="u" direction="in"/>
|
||||
<arg name="band" type="u" direction="in" tp:type="MM_MODEM_BAND">
|
||||
<tp:docstring>
|
||||
The new band.
|
||||
</tp:docstring>
|
||||
</arg>
|
||||
</method>
|
||||
|
||||
<method name="GetBand">
|
||||
<tp:docstring>
|
||||
Get the current band.
|
||||
</tp:docstring>
|
||||
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
|
||||
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_get_band"/>
|
||||
<arg name="band" type="u" direction="out"/>
|
||||
<arg name="band" type="u" direction="out" tp:type="MM_MODEM_BAND">
|
||||
<tp:docstring>
|
||||
The current band.
|
||||
</tp:docstring>
|
||||
</arg>
|
||||
</method>
|
||||
|
||||
<method name="SetNetworkMode">
|
||||
<tp:docstring>
|
||||
Set the network mode.
|
||||
</tp:docstring>
|
||||
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
|
||||
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_set_network_mode"/>
|
||||
<arg name="mode" type="u" direction="in"/>
|
||||
<arg name="mode" type="u" direction="in" tp:type="MM_MODEM_NETWORK_MODE">
|
||||
<tp:docstring>
|
||||
The new mode.
|
||||
</tp:docstring>
|
||||
</arg>
|
||||
</method>
|
||||
|
||||
<method name="GetNetworkMode">
|
||||
<tp:docstring>
|
||||
Get the network mode.
|
||||
</tp:docstring>
|
||||
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
|
||||
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_modem_get_network_mode"/>
|
||||
<arg name="mode" type="u" direction="out"/>
|
||||
<arg name="mode" type="u" direction="out">
|
||||
<tp:docstring>
|
||||
The current network mode.
|
||||
</tp:docstring>
|
||||
</arg>
|
||||
</method>
|
||||
|
||||
<property name="DataDevice" type="s" access="read">
|
||||
<tp:docstring>
|
||||
The serial device which can be used to start pppd.
|
||||
</tp:docstring>
|
||||
</property>
|
||||
|
||||
<property name="DataDevice" type="s" access="read"/>
|
||||
<property name="Driver" type="s" access="read"/>
|
||||
<property name="Type" type="u" access="read"/>
|
||||
<property name="Driver" type="s" access="read">
|
||||
<tp:docstring>
|
||||
The driver handling the device.
|
||||
</tp:docstring>
|
||||
</property>
|
||||
|
||||
<property name="Type" type="u" access="read" tp:type="MM_MODEM_TYPE">
|
||||
<tp:docstring>
|
||||
The modem type.
|
||||
</tp:docstring>
|
||||
</property>
|
||||
|
||||
<signal name="SignalQuality">
|
||||
<arg name="quality" type="u"/>
|
||||
<tp:docstring>
|
||||
The signal quality changed.
|
||||
</tp:docstring>
|
||||
<arg name="quality" type="u">
|
||||
<tp:docstring>
|
||||
The new quality in percent, 0..100.
|
||||
</tp:docstring>
|
||||
</arg>
|
||||
</signal>
|
||||
|
||||
<signal name="NetworkMode">
|
||||
<arg name="mode" type="u"/>
|
||||
<tp:docstring>
|
||||
The network mode changed.
|
||||
</tp:docstring>
|
||||
<arg name="mode" type="u" tp:type="MM_MODEM_NETWORK_MODE">
|
||||
<tp:docstring>
|
||||
The new quality in percent, 0..100.
|
||||
</tp:docstring>
|
||||
</arg>
|
||||
</signal>
|
||||
|
||||
<tp:enum name="MM_MODEM_TYPE" type="u">
|
||||
<tp:enumvalue suffix="GSM" value="1">
|
||||
<tp:docstring>
|
||||
A GSM device.
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
<tp:enumvalue suffix="CDMA" value="2">
|
||||
<tp:docstring>
|
||||
A CDMA device.
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
</tp:enum>
|
||||
|
||||
<tp:enum name="MM_MODEM_NETWORK_MODE" type="u">
|
||||
<tp:enumvalue suffix="ANY" value="0">
|
||||
<tp:docstring>
|
||||
Any network mode can be used.
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
<tp:enumvalue suffix="GPRS" value="1">
|
||||
<tp:docstring>
|
||||
GPRS
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
<tp:enumvalue suffix="EDGE" value="2">
|
||||
<tp:docstring>
|
||||
EDGE
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
<tp:enumvalue suffix="3G" value="3">
|
||||
<tp:docstring>
|
||||
3G
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
<tp:enumvalue suffix="HSDPA" value="4">
|
||||
<tp:docstring>
|
||||
HSDPA
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
<tp:enumvalue suffix="PREFER_2G" value="5">
|
||||
<tp:docstring>
|
||||
Prefer 2G (GPRS or EDGE).
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
<tp:enumvalue suffix="PREFER_3G" value="6">
|
||||
<tp:docstring>
|
||||
Prefer 3G (3G or HSDPA).
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
</tp:enum>
|
||||
|
||||
<tp:enum name="MM_MODEM_BAND" type="u">
|
||||
<tp:enumvalue suffix="ANY" value="0">
|
||||
<tp:docstring>
|
||||
Any band can be used.
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
<tp:enumvalue suffix="EGSM" value="1">
|
||||
<tp:docstring>
|
||||
EGSM (900 MHz).
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
<tp:enumvalue suffix="DCS" value="2">
|
||||
<tp:docstring>
|
||||
DCS (1800 MHz).
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
<tp:enumvalue suffix="PCS" value="3">
|
||||
<tp:docstring>
|
||||
PCS (1900 MHz).
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
<tp:enumvalue suffix="G850" value="4">
|
||||
<tp:docstring>
|
||||
G850 (850 MHz).
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
<tp:enumvalue suffix="U2100" value="5">
|
||||
<tp:docstring>
|
||||
U2100 (WCDMA 2100 MHz).
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
<tp:enumvalue suffix="U1700" value="6">
|
||||
<tp:docstring>
|
||||
U1700 (WCDMA 3GPP UMTS1800 MHz).
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
<tp:enumvalue suffix="17IV" value="7">
|
||||
<tp:docstring>
|
||||
17IV (WCDMA 3GPP AWS 1700/2100 MHz).
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
<tp:enumvalue suffix="U800" value="8">
|
||||
<tp:docstring>
|
||||
U800 (WCDMA 3GPP UMTS800 MHz).
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
<tp:enumvalue suffix="U850" value="9">
|
||||
<tp:docstring>
|
||||
U850 (WCDMA 3GPP UMTS850 MHz).
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
<tp:enumvalue suffix="U900" value="10">
|
||||
<tp:docstring>
|
||||
U900 (WCDMA 3GPP UMTS900 MHz).
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
<tp:enumvalue suffix="U17IX" value="11">
|
||||
<tp:docstring>
|
||||
U17IX (WCDMA 3GPP UMTS MHz).
|
||||
</tp:docstring>
|
||||
</tp:enumvalue>
|
||||
</tp:enum>
|
||||
|
||||
</interface>
|
||||
</node>
|
||||
|
||||
Reference in New Issue
Block a user