Warning, /frameworks/modemmanager-qt/src/dbus/introspection/org.freedesktop.ModemManager1.Modem.Simple.xml is written in an unsupported language. File is not indexed.
0001 <?xml version="1.0" encoding="UTF-8" ?>
0002
0003 <!--
0004 ModemManager 1.0 Interface Specification
0005
0006 Copyright (C) 2008 Novell, Inc.
0007 Copyright (C) 2008-2013 Red Hat, Inc.
0008 Copyright (C) 2011-2013 Google, Inc.
0009 Copyright (C) 2011-2013 Lanedo GmbH
0010 -->
0011
0012 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
0013
0014 <!--
0015 org.freedesktop.ModemManager1.Modem.Simple:
0016 @short_description: The ModemManager Simple interface.
0017
0018 The Simple interface allows controlling and querying the status of Modems.
0019 -->
0020 <interface name="org.freedesktop.ModemManager1.Modem.Simple">
0021
0022 <!--
0023 Connect:
0024 @properties: Dictionary of properties needed to get the modem connected.
0025 @bearer: On successful connect, returns the object path of the connected packet data bearer used for the connection attempt.
0026
0027 Do everything needed to connect the modem using the given properties.
0028
0029 This method will attempt to find a matching packet data bearer and
0030 activate it if necessary, returning the bearer's IP details. If no
0031 matching bearer is found, a new bearer will be created and activated,
0032 but this operation may fail if no resources are available to complete
0033 this connection attempt (ie, if a conflicting bearer is already active).
0034
0035 This call may make a large number of changes to modem configuration
0036 based on properties passed in. For example, given a PIN-locked, disabled
0037 GSM/UMTS modem, this call may unlock the SIM PIN, alter the access
0038 technology preference, wait for network registration (or force
0039 registration to a specific provider), create a new packet data bearer
0040 using the given "apn", and connect that bearer.
0041
0042 Allowed key/value pairs in @properties are:
0043 <variablelist>
0044 <varlistentry><term><literal>"pin"</literal></term>
0045 <listitem>
0046 SIM-PIN unlock code, given as a string value (signature <literal>"s"</literal>).
0047 </listitem>
0048 </varlistentry>
0049 <varlistentry><term><literal>"operator-id"</literal></term>
0050 <listitem>
0051 ETSI MCC-MNC of a network to force registration with,
0052 given as a string value (signature <literal>"s"</literal>).
0053 </listitem>
0054 </varlistentry>
0055 <varlistentry><term><literal>"apn"</literal></term>
0056 <listitem>
0057 For GSM/UMTS and LTE devices the APN to use,
0058 given as a string value (signature <literal>"s"</literal>).
0059 </listitem>
0060 </varlistentry>
0061 <varlistentry><term><literal>"ip-type"</literal></term>
0062 <listitem>
0063 For GSM/UMTS and LTE devices the IP addressing type to use,
0064 given as a <link linkend="MMBearerIpFamily">MMBearerIpFamily</link>
0065 value (signature <literal>"u"</literal>).
0066 </listitem>
0067 </varlistentry>
0068 <varlistentry><term><literal>"allowed-auth"</literal></term>
0069 <listitem>
0070 The authentication method to use, given as a
0071 <link linkend="MMBearerAllowedAuth">MMBearerAllowedAuth</link>
0072 value (signature <literal>"u"</literal>). Optional in 3GPP.
0073 </listitem>
0074 </varlistentry>
0075 <varlistentry><term><literal>"user"</literal></term>
0076 <listitem>
0077 User name (if any) required by the network, given as a string
0078 value (signature <literal>"s"</literal>). Optional in 3GPP.
0079 </listitem>
0080 </varlistentry>
0081 <varlistentry><term><literal>"password"</literal></term>
0082 <listitem>
0083 Password (if any) required by the network, given as a string value
0084 (signature <literal>"s"</literal>). Optional in 3GPP.
0085 </listitem>
0086 </varlistentry>
0087 <varlistentry><term><literal>"number"</literal></term>
0088 <listitem>
0089 For POTS devices the number to dial,,
0090 given as a string value (signature <literal>"s"</literal>).
0091 </listitem>
0092 </varlistentry>
0093 <varlistentry><term><literal>"allow-roaming"</literal></term>
0094 <listitem>
0095 %FALSE to allow only connections to home networks,
0096 given as a boolean value (signature <literal>"b"</literal>).
0097 </listitem>
0098 </varlistentry>
0099 <varlistentry><term><literal>"rm-protocol"</literal></term>
0100 <listitem>
0101 For CDMA devices, the protocol of the Rm interface, given as a
0102 <link linkend="MMModemCdmaRmProtocol">MMModemCdmaRmProtocol</link>
0103 value (signature <literal>"u"</literal>).
0104 </listitem>
0105 </varlistentry>
0106 </variablelist>
0107 -->
0108 <method name="Connect">
0109 <arg name="properties" type="a{sv}" direction="in" />
0110 <arg name="bearer" type="o" direction="out" />
0111 </method>
0112
0113 <!--
0114 Disconnect:
0115 @bearer: If given this method will disconnect the referenced packet
0116 data bearer, while if "/" (ie, no object given) this method will
0117 disconnect all active packet data bearers.
0118
0119 Disconnect an active packet data connection.
0120 -->
0121 <method name="Disconnect">
0122 <arg name="bearer" type="o" direction="in" />
0123 </method>
0124
0125 <!--
0126 GetStatus:
0127 @properties: Dictionary of properties.
0128
0129 Get the general modem status.
0130
0131 The predefined common properties returned are:
0132 <variablelist>
0133 <varlistentry><term><literal>"state"</literal></term>
0134 <listitem>
0135 A <link linkend="MMModemState">MMModemState</link> value
0136 specifying the overall state of the modem, given as an
0137 unsigned integer value (signature <literal>"u"</literal>).
0138 </listitem>
0139 </varlistentry>
0140 <varlistentry><term><literal>"signal-quality"</literal></term>
0141 <listitem>
0142 Signal quality value, given only when registered,
0143 as an unsigned integer value
0144 (signature <literal>"u"</literal>).
0145 </listitem>
0146 </varlistentry>
0147 <varlistentry><term><literal>"current-bands"</literal></term>
0148 <listitem>
0149 List of <link linkend="MMModemBand">MMModemBand</link> values,
0150 given only when registered, as a list of
0151 unsigned integer values (signature <literal>"au"</literal>).
0152 </listitem>
0153 </varlistentry>
0154 <varlistentry><term><literal>"access-technology"</literal></term>
0155 <listitem>
0156 A <link linkend="MMModemAccessTechnology">MMModemAccessTechnology</link> value,
0157 given only when registered, as an unsigned integer value
0158 (signature <literal>"u"</literal>).
0159 </listitem>
0160 </varlistentry>
0161 <varlistentry><term><literal>"m3gpp-registration-state"</literal></term>
0162 <listitem>
0163 A <link linkend="MMModem3gppRegistrationState">MMModem3gppRegistrationState</link> value
0164 specifying the state of the registration, given only when registered
0165 in a 3GPP network, as an unsigned integer value (signature
0166 <literal>"u"</literal>).
0167 </listitem>
0168 </varlistentry>
0169 <varlistentry><term><literal>"m3gpp-operator-code"</literal></term>
0170 <listitem>
0171 Operator <literal>MCC-MNC</literal>, given only when registered
0172 in a 3GPP network, as a string value (signature <literal>"s"</literal>).
0173 </listitem>
0174 </varlistentry>
0175 <varlistentry><term><literal>"m3gpp-operator-name"</literal></term>
0176 <listitem>
0177 Operator name, given only when registered in a 3GPP network,
0178 as a string value (signature <literal>"s"</literal>).
0179 </listitem>
0180 </varlistentry>
0181 <varlistentry><term><literal>"cdma-cdma1x-registration-state"</literal></term>
0182 <listitem>
0183 A <link linkend="MMModemCdmaRegistrationState">MMModemCdmaRegistrationState</link> value
0184 specifying the state of the registration, given only when registered
0185 in a CDMA1x network, as an unsigned integer value (signature
0186 <literal>"u"</literal>).
0187 </listitem>
0188 </varlistentry>
0189 <varlistentry><term><literal>"cdma-evdo-registration-state"</literal></term>
0190 <listitem>
0191 A <link linkend="MMModemCdmaRegistrationState">MMModemCdmaRegistrationState</link> value
0192 specifying the state of the registration, given only when registered
0193 in a EV-DO network, as an unsigned integer value (signature
0194 <literal>"u"</literal>).
0195 </listitem>
0196 </varlistentry>
0197 <varlistentry><term><literal>"cdma-sid"</literal></term>
0198 <listitem>
0199 The System Identifier of the serving network, if registered in a CDMA1x network and if known.
0200 Given as an unsigned integer value (signature <literal>"u"</literal>).
0201 </listitem>
0202 </varlistentry>
0203 <varlistentry><term><literal>"cdma-nid"</literal></term>
0204 <listitem>
0205 The Network Identifier of the serving network, if registered in a CDMA1x network and if known.
0206 Given as an unsigned integer value (signature <literal>"u"</literal>).
0207 </listitem>
0208 </varlistentry>
0209 </variablelist>
0210 -->
0211 <method name="GetStatus">
0212 <arg name="properties" type="a{sv}" direction="out" />
0213 </method>
0214
0215 </interface>
0216 </node>