Warning, /frameworks/modemmanager-qt/src/dbus/introspection/org.freedesktop.ModemManager1.Modem.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:
0016 @short_description: The ModemManager Modem interface.
0017
0018 The Modem interface controls the status and actions in a given modem
0019 object.
0020 -->
0021 <interface name="org.freedesktop.ModemManager1.Modem">
0022
0023 <!--
0024 Enable:
0025 @enable: %TRUE to enable the modem and %FALSE to disable it.
0026
0027 Enable or disable the modem.
0028
0029 When enabled, the modem's radio is powered on and data sessions, voice
0030 calls, location services, and Short Message Service may be available.
0031
0032 When disabled, the modem enters low-power state and no network-related
0033 operations are available.
0034 -->
0035 <method name="Enable">
0036 <arg name="enable" type="b" direction="in" />
0037 </method>
0038
0039 <!--
0040 ListBearers:
0041 @bearers: The list of bearer object paths.
0042
0043 List configured packet data bearers (EPS Bearers, PDP Contexts, or
0044 CDMA2000 Packet Data Sessions).
0045 -->
0046 <method name="ListBearers">
0047 <arg name="bearers" type="ao" direction="out" />
0048 </method>
0049
0050 <!--
0051 CreateBearer:
0052 @properties: List of properties to assign to the bearer after creating it.
0053 @path: On success, the object path of the newly created bearer.
0054
0055 Create a new packet data bearer using the given characteristics.
0056
0057 This request may fail if the modem does not support additional bearers,
0058 if too many bearers are already defined, or if properties are invalid.
0059
0060 Allowed properties are:
0061 <variablelist>
0062 <varlistentry><term><literal>"apn"</literal></term>
0063 <listitem><para>Access Point Name, given as a string value (signature <literal>"s"</literal>). Required in 3GPP.</para></listitem></varlistentry>
0064 <varlistentry><term><literal>"ip-type"</literal></term>
0065 <listitem><para>Addressing type, given as a <link linkend="MMBearerIpFamily">MMBearerIpFamily</link> value (signature <literal>"u"</literal>). Optional in 3GPP and CDMA.</para></listitem></varlistentry>
0066 <varlistentry><term><literal>"allowed-auth"</literal></term>
0067 <listitem><para>The authentication method to use, given as a <link linkend="MMBearerAllowedAuth">MMBearerAllowedAuth</link> value (signature <literal>"u"</literal>). Optional in 3GPP.</para></listitem></varlistentry>
0068 <varlistentry><term><literal>"user"</literal></term>
0069 <listitem><para>User name (if any) required by the network, given as a string value (signature <literal>"s"</literal>). Optional in 3GPP.</para></listitem></varlistentry>
0070 <varlistentry><term><literal>"password"</literal></term>
0071 <listitem><para>Password (if any) required by the network, given as a string value (signature <literal>"s"</literal>). Optional in 3GPP.</para></listitem></varlistentry>
0072 <varlistentry><term><literal>"allow-roaming"</literal></term>
0073 <listitem><para>Flag to tell whether connection is allowed during roaming, given as a boolean value (signature <literal>"b"</literal>). Optional in 3GPP.</para></listitem></varlistentry>
0074 <varlistentry><term><literal>"rm-protocol"</literal></term>
0075 <listitem><para>Protocol of the Rm interface, given as a <link linkend="MMModemCdmaRmProtocol">MMModemCdmaRmProtocol</link> value (signature <literal>"u"</literal>). Optional in CDMA.</para></listitem></varlistentry>
0076 <varlistentry><term><literal>"number"</literal></term>
0077 <listitem><para>Telephone number to dial, given as a string value (signature <literal>"s"</literal>). Required in POTS.</para></listitem></varlistentry>
0078 </variablelist>
0079
0080 Some properties are only applicable to a bearer of certain access
0081 technologies, for example the <literal>"apn"</literal> property is not
0082 applicable to CDMA2000 Packet Data Session bearers.
0083 -->
0084 <method name="CreateBearer">
0085 <arg name="properties" type="a{sv}" direction="in">
0086 <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap" />
0087 </arg>
0088 <arg name="path" type="o" direction="out" />
0089 </method>
0090
0091 <!--
0092 DeleteBearer:
0093 @bearer: Object path of the bearer to delete.
0094
0095 Delete an existing packet data bearer.
0096
0097 If the bearer is currently active and providing packet data server, it
0098 will be disconnected and that packet data service will terminate.
0099 -->
0100 <method name="DeleteBearer">
0101 <arg name="bearer" type="o" direction="in" />
0102 </method>
0103
0104 <!--
0105 Reset:
0106
0107 Clear non-persistent configuration and state, and return the device to
0108 a newly-powered-on state.
0109
0110 This command may power-cycle the device.
0111 -->
0112 <method name="Reset" />
0113
0114 <!--
0115 FactoryReset:
0116 @code: Carrier-supplied code required to reset the modem.
0117
0118 Clear the modem's configuration (including persistent configuration and
0119 state), and return the device to a factory-default state.
0120
0121 If not required by the modem, @code may be ignored.
0122
0123 This command may or may not power-cycle the device.
0124 -->
0125 <method name="FactoryReset">
0126 <arg name="code" type="s" direction="in" />
0127 </method>
0128
0129 <!--
0130 SetPowerState:
0131 @state: A <link linkend="MMModemPowerState">MMModemPowerState</link> value, to specify the desired power state.
0132
0133 Set the power state of the modem. This action can only be run when the
0134 modem is in <link linkend="MM-MODEM-STATE-DISABLED:CAPS"><constant>MM_MODEM_STATE_DISABLED</constant></link>
0135 state.
0136 -->
0137 <method name="SetPowerState">
0138 <arg name="state" type="u" direction="in" />
0139 </method>
0140
0141 <!--
0142 SetCurrentCapabilities:
0143 @capabilities: Bitmask of <link linkend="MMModemCapability">MMModemCapability</link> values, to specify the capabilities to use.
0144
0145 Set the capabilities of the device. A restart of the modem may be required.
0146 -->
0147 <method name="SetCurrentCapabilities">
0148 <arg name="capabilities" type="u" direction="in" />
0149 </method>
0150
0151 <!--
0152 SetCurrentModes:
0153 @modes: A pair of <link linkend="MMModemMode">MMModemMode</link> values, where the first one is a bitmask of allowed modes, and the second one the preferred mode, if any.
0154
0155 Set the access technologies (e.g. 2G/3G/4G preference) the device is
0156 currently allowed to use when connecting to a network.
0157
0158 The given combination should be supported by the modem, as specified in the
0159 #org.freedesktop.ModemManager1.Modem:SupportedModes property.
0160 -->
0161 <method name="SetCurrentModes">
0162 <arg name="modes" type="(uu)" direction="in">
0163 <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="CurrentModesType"/>
0164 </arg>
0165 </method>
0166
0167 <!--
0168 SetCurrentBands:
0169 @bands: List of <link linkend="MMModemBand">MMModemBand</link> values, to specify the bands to be used.
0170
0171 Set the radio frequency and technology bands the device is currently
0172 allowed to use when connecting to a network.
0173 -->
0174 <method name="SetCurrentBands">
0175 <arg name="bands" type="au" direction="in">
0176 <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QList<uint>" />
0177 </arg>
0178 </method>
0179
0180 <!--
0181 Command
0182 @cmd The command string, e.g. "AT+GCAP" or "+GCAP" (leading AT is inserted if necessary).
0183 @timeout The number of seconds to wait for a response.
0184 @response The modem's response.
0185
0186 Send an arbitrary AT command to a modem and get the response.
0187
0188 Note that using this interface call is only allowed when running
0189 ModemManager in debug mode.
0190 -->
0191 <method name="Command">
0192 <arg name="cmd" type="s" direction="in" />
0193 <arg name="timeout" type="u" direction="in" />
0194 <arg name="response" type="s" direction="out" />
0195 </method>
0196
0197 <!--
0198 StateChanged:
0199 @old: A <link linkend="MMModemState">MMModemState</link> value, specifying the new state.
0200 @new: A <link linkend="MMModemState">MMModemState</link> value, specifying the new state.
0201 @reason: A <link linkend="MMModemStateChangeReason">MMModemStateChangeReason</link> value, specifying the reason for this state change.
0202
0203 The modem's state (see #org.freedesktop.ModemManager1.Modem:State) changed.
0204 -->
0205 <signal name="StateChanged">
0206 <arg name="old" type="i" />
0207 <arg name="new" type="i" />
0208 <arg name="reason" type="u" />
0209 </signal>
0210
0211 <!--
0212 Sim:
0213
0214 The path of the SIM object available in this device, if any.
0215 -->
0216 <property name="Sim" type="o" access="read" />
0217
0218 <!--
0219 Bearers:
0220
0221 The list of bearer object paths (EPS Bearers, PDP Contexts, or
0222 CDMA2000 Packet Data Sessions).
0223 -->
0224 <property name="Bearers" type="ao" access="read" />
0225
0226 <!--
0227 SupportedCapabilities:
0228
0229 List of <link linkend="MMModemCapability">MMModemCapability</link>
0230 values, specifying the combinations of generic family of access
0231 technologies the modem supports.
0232
0233 If the modem doesn't allow changing the current capabilities, a single entry with
0234 <link linkend="MM-MODEM-CAPABILITY-ANY:CAPS"><constant>MM_MODEM_CAPABILITY_ANY</constant></link>
0235 will be given.
0236 -->
0237 <property name="SupportedCapabilities" type="au" access="read">
0238 <annotation name="org.qtproject.QtDBus.QtTypeName" value="UIntList"/>
0239 </property>
0240
0241 <!--
0242 CurrentCapabilities:
0243
0244 Bitmask of <link linkend="MMModemCapability">MMModemCapability</link>
0245 values, specifying the generic family of access technologies the modem
0246 currently supports without a firmware reload or reinitialization.
0247 -->
0248 <property name="CurrentCapabilities" type="u" access="read" />
0249
0250 <!--
0251 MaxBearers:
0252
0253 The maximum number of defined packet data bearers the modem supports.
0254
0255 This is not the number of active/connected bearers the modem supports,
0256 but simply the number of bearers that may be defined at any given time.
0257 For example, POTS and CDMA2000-only devices support only one bearer,
0258 while GSM/UMTS devices typically support three or more, and any
0259 LTE-capable device (whether LTE-only, GSM/UMTS-capable, and/or
0260 CDMA2000-capable) also typically support three or more.
0261 -->
0262 <property name="MaxBearers" type="u" access="read" />
0263
0264 <!--
0265 MaxActiveBearers:
0266
0267 The maximum number of active packet data bearers the modem supports.
0268
0269 POTS and CDMA2000-only devices support one active bearer, while GSM/UMTS
0270 and LTE-capable devices (including LTE/CDMA devices) typically support
0271 at least two active bearers.
0272 -->
0273 <property name="MaxActiveBearers" type="u" access="read" />
0274
0275 <!--
0276 Manufacturer:
0277
0278 The equipment manufacturer, as reported by the modem.
0279 -->
0280 <property name="Manufacturer" type="s" access="read" />
0281
0282 <!--
0283 Model:
0284
0285 The equipment model, as reported by the modem.
0286 -->
0287 <property name="Model" type="s" access="read" />
0288
0289 <!--
0290 Revision:
0291
0292 The revision identification of the software, as reported by the modem.
0293 -->
0294 <property name="Revision" type="s" access="read" />
0295
0296 <!--
0297 DeviceIdentifier:
0298
0299 A best-effort device identifier based on various device information like
0300 model name, firmware revision, USB/PCI/PCMCIA IDs, and other properties.
0301
0302 This ID is not guaranteed to be unique and may be shared between
0303 identical devices with the same firmware, but is intended to be "unique
0304 enough" for use as a casual device identifier for various user
0305 experience operations.
0306
0307 This is not the device's IMEI or ESN since those may not be available
0308 before unlocking the device via a PIN.
0309 -->
0310 <property name="DeviceIdentifier" type="s" access="read" />
0311
0312 <!--
0313 Device:
0314
0315 The physical modem device reference (ie, USB, PCI, PCMCIA device), which
0316 may be dependent upon the operating system.
0317
0318 In Linux for example, this points to a sysfs path of the usb_device
0319 object.
0320 -->
0321 <property name="Device" type="s" access="read" />
0322
0323 <!--
0324 Drivers:
0325
0326 The Operating System device drivers handling communication with the modem
0327 hardware.
0328 -->
0329 <property name="Drivers" type="as" access="read" />
0330
0331 <!--
0332 Plugin:
0333
0334 The name of the plugin handling this modem.
0335 -->
0336 <property name="Plugin" type="s" access="read" />
0337
0338 <!--
0339 PrimaryPort:
0340
0341 The name of the primary port using to control the modem.
0342 -->
0343 <property name="PrimaryPort" type="s" access="read" />
0344
0345 <!--
0346 Ports:
0347
0348 The list of ports in the modem, given as an array of string and unsigned
0349 integer pairs. The string is the port name or path, and the integer is
0350 the port type given as a
0351 <link linkend="MMModemPortType">MMModemPortType</link> value.
0352 -->
0353 <property name="Ports" type="a(su)" access="read">
0354 <annotation name="org.qtproject.QtDBus.QtTypeName" value="PortList"/>
0355 </property>
0356
0357 <!--
0358 EquipmentIdentifier:
0359
0360 The identity of the device.
0361
0362 This will be the IMEI number for GSM devices and the hex-format ESN/MEID
0363 for CDMA devices.
0364 -->
0365 <property name="EquipmentIdentifier" type="s" access="read" />
0366
0367 <!--
0368 UnlockRequired:
0369
0370 Current lock state of the device, given as a
0371 <link linkend="MMModemLock">MMModemLock</link> value.
0372 -->
0373 <property name="UnlockRequired" type="u" access="read" />
0374
0375 <!--
0376 UnlockRetries:
0377
0378 A dictionary in which the keys are <link linkend="MMModemLock">MMModemLock</link>
0379 flags, and the values are integers giving the number of PIN tries remaining
0380 before the code becomes blocked (requiring a PUK) or permanently blocked. Dictionary
0381 entries exist only for the codes for which the modem is able to report retry
0382 counts.
0383 -->
0384 <property name="UnlockRetries" type="a{uu}" access="read">
0385 <annotation name="org.qtproject.QtDBus.QtTypeName" value="UnlockRetriesMap"/>
0386 </property>
0387
0388 <!--
0389 State:
0390
0391 Overall state of the modem, given as a
0392 <link linkend="MMModemState">MMModemState</link> value.
0393
0394 If the device's state cannot be determined,
0395 <link linkend="MM-MODEM-STATE-UNKNOWN:CAPS"><constant>MM_MODEM_STATE_UNKNOWN</constant></link>
0396 will be reported.
0397 -->
0398 <property name="State" type="i" access="read" />
0399
0400 <!--
0401 StateFailedReason:
0402
0403 Error specifying why the modem is in
0404 <link linkend="MM-MODEM-STATE-FAILED:CAPS"><constant>MM_MODEM_STATE_FAILED</constant></link>
0405 state, given as a
0406 <link linkend="MMModemStateFailedReason">MMModemStateFailedReason</link> value.
0407 -->
0408 <property name="StateFailedReason" type="u" access="read" />
0409
0410 <!--
0411 AccessTechnologies:
0412
0413 Bitmask of <link linkend="MMModemAccessTechnology">MMModemAccessTechnology</link> values,
0414 specifying the current network access technologies used by the device to communicate
0415 with the network.
0416
0417 If the device's access technology cannot be determined,
0418 <link linkend="MM-MODEM-ACCESS-TECHNOLOGY-UNKNOWN:CAPS"><constant>MM_MODEM_ACCESS_TECHNOLOGY_UNKNOWN</constant></link>
0419 will be reported.
0420 -->
0421 <property name="AccessTechnologies" type="u" access="read" />
0422
0423 <!--
0424 SignalQuality:
0425
0426 Signal quality in percent (0 - 100) of the dominant access technology
0427 the device is using to communicate with the network. Always 0 for POTS
0428 devices.
0429
0430 The additional boolean value indicates if the quality value given was
0431 recently taken.
0432 -->
0433 <property name="SignalQuality" type="(ub)" access="read">
0434 <annotation name="org.qtproject.QtDBus.QtTypeName" value="SignalQualityPair"/>
0435 </property>
0436
0437 <!--
0438 OwnNumbers:
0439
0440 List of numbers (e.g. MSISDN in 3GPP) being currently handled by this
0441 modem.
0442 -->
0443 <property name="OwnNumbers" type="as" access="read" />
0444
0445 <!--
0446 PowerState:
0447
0448 A <link linkend="MMModemPowerState">MMModemPowerState</link> value
0449 specifying the current power state of the modem.
0450 -->
0451 <property name="PowerState" type="u" access="read" />
0452
0453 <!--
0454 SupportedModes:
0455
0456 This property exposes the supported mode combinations, given as an array of unsigned
0457 integer pairs, where:
0458
0459 <variablelist>
0460 <varlistentry>
0461 <listitem>
0462 The first integer is a bitmask of <link linkend="MMModemMode">MMModemMode</link> values,
0463 specifying the allowed modes.
0464 </listitem>
0465 </varlistentry>
0466 <varlistentry>
0467 <listitem>
0468 The second integer is a single <link linkend="MMModemMode">MMModemMode</link>, which
0469 specifies the preferred access technology, among the ones defined in the allowed modes.
0470 </listitem>
0471 </varlistentry>
0472 </variablelist>
0473 -->
0474 <property name="SupportedModes" type="a(uu)" access="read">
0475 <annotation name="org.qtproject.QtDBus.QtTypeName" value="SupportedModesType"/>
0476 </property>
0477
0478 <!--
0479 CurrentModes:
0480
0481 A pair of <link linkend="MMModemMode">MMModemMode</link> values, where the first one
0482 is a bitmask specifying the access technologies (eg 2G/3G/4G) the device
0483 is currently allowed to use when connecting to a network, and the second one is the
0484 preferred mode of those specified as allowed.
0485
0486 The pair must be one of those specified in
0487 #org.freedesktop.ModemManager1.Modem:SupportedModes.
0488 -->
0489 <property name="CurrentModes" type="(uu)" access="read">
0490 <annotation name="org.qtproject.QtDBus.QtTypeName" value="CurrentModesType"/>
0491 </property>
0492
0493 <!--
0494 SupportedBands:
0495
0496 List of <link linkend="MMModemBand">MMModemBand</link> values,
0497 specifying the radio frequency and technology bands supported by the
0498 device.
0499
0500 For POTS devices, only the
0501 <link linkend="MM-MODEM-BAND-ANY:CAPS"><constant>MM_MODEM_BAND_ANY</constant></link>
0502 mode will be returned.
0503 -->
0504 <property name="SupportedBands" type="au" access="read">
0505 <annotation name="org.qtproject.QtDBus.QtTypeName" value="UIntList"/>
0506 </property>
0507
0508 <!--
0509 CurrentBands:
0510
0511 List of <link linkend="MMModemBand">MMModemBand</link> values,
0512 specifying the radio frequency and technology bands the device is
0513 currently using when connecting to a network.
0514
0515 It must be a subset of #org.freedesktop.ModemManager1.Modem:SupportedBands.
0516 -->
0517 <property name="CurrentBands" type="au" access="read">
0518 <annotation name="org.qtproject.QtDBus.QtTypeName" value="UIntList"/>
0519 </property>
0520
0521 <!--
0522 SupportedIpFamilies:
0523
0524 Bitmask of <link linkend="MMBearerIpFamily">MMBearerIpFamily</link> values,
0525 specifying the IP families supported by the device.
0526 -->
0527 <property name="SupportedIpFamilies" type="u" access="read" />
0528
0529 </interface>
0530 </node>