ModemManager D-Bus Interface Specification

Version 0.1

Copyright (C) 2008 Novell, Inc.

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.

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.

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.

Interfaces

org.freedesktop.ModemManager

Methods:

EnumerateDevices ( ) → ao

Get the list of modem devices.

Returns

devices - ao
List of object paths of modem devices known to the system.

Signals:

DeviceAdded ( o: device )

A device was added to the system.

Parameters

device - o
The object path of the newly added device.

DeviceRemoved ( o: device )

A device was removed from the system, and is no longer available.

Parameters

device - o
The object path of the device that was just removed.

Interface has no properties.

org.freedesktop.ModemManager.Modem

Methods:

Enable ( b: enable ) → nothing

Enable the device. Initializes the modem.

Parameters

enable - b
True to enable the device, False to disable.

Connect ( s: number ) → nothing

Dial in.

Parameters

number - s
The number to use for dialing.

Disconnect ( ) → nothing

Disconnect modem.

Interface has no signals.

Properties:

DataDevice - s - (read)
The serial device which can be used to start pppd.
Driver - s - (read)
The driver handling the device.
Type - u - (read) (MM_MODEM_TYPE)
The modem type.

Enumerated types:

MM_MODEM_TYPE

MM_MODEM_TYPE_GSM = 1
A GSM device.
MM_MODEM_TYPE_CDMA = 2
A CDMA device.

org.freedesktop.ModemManager.Modem.Cdma

Methods:

GetSignalQuality ( ) → u

Get the current signal quality.

Returns

quality - u
Signal quality (percent).

Signals:

SignalQuality ( u: quality )

The signal quality changed.

Parameters

quality - u
The new quality in percent, 0..100.

Interface has no properties.

org.freedesktop.ModemManager.Modem.Gsm.Card

Methods:

GetImei ( ) → s

Get the IMEI of the SIM card.

Returns

imei - s
The IMEI.

GetImsi ( ) → s

Get the IMSI of the SIM card.

Returns

imsi - s
The IMSI.

GetInfo ( ) → s, s, s

Get the card information (manufacturer, modem, version).

Returns

manufacturer - s
The manufacturer of the card.
modem - s
The model of the card.
version - s
The version (revision) of the card.

SendPin ( s: pin ) → nothing

Send the PIN (or PUK) to unlock the SIM card.

Parameters

pin - s
The PIN code.

EnablePin ( s: pin, b: enabled ) → nothing

Enable or disable the PIN checking.

Parameters

pin - s
The PIN code.
enabled - b
True to enable PIN checking.

ChangePin ( s: old_pin, s: new_pin ) → nothing

Change the PIN code.

Parameters

old_pin - s
The current PIN code.
new_pin - s
The new PIN code.

Interface has no signals.

Interface has no properties.

org.freedesktop.ModemManager.Modem.Gsm.Contacts

Methods:

Add ( s: name, s: number ) → u

Add a new contact to the SIM card.

Parameters

name - s
The name of the contact.
number - s
The phone number of the contact.

Returns

index - u
The index of the new contact.

Delete ( u: index ) → nothing

Delete a contact from the SIM card.

Parameters

index - u
The index of the contact.

Get ( u: index ) → u, s, s

Retrieve a contact from the SIM card.

Parameters

index - u
The index of the contact.

Returns

found_index - u
The index of the contact (same as the passed index).
name - s
The name of the contact.
number - s
The number of the contact.

List ( ) → a(uss)

List all contacts on the SIM card.

Returns

results - a(uss)
The list of contacts where each contact has an index, name, and number.

Find ( s: pattern ) → a(uss)

Find a contact from the SIM card.

Parameters

pattern - s
The pattern to search for.

Returns

results - a(uss)
The list of matching contacts where a contact has an index, name, and number.

GetCount ( ) → u

Get the number of contacts stored on the SIM card.

Returns

count - u
The number of contacts.

Interface has no signals.

Interface has no properties.

org.freedesktop.ModemManager.Modem.Gsm.Network

Methods:

Register ( s: network_id ) → nothing

Register the device to network.

Parameters

network_id - s
The network ID to register. An empty string can be used to register to the home network.

Scan ( ) → aa{ss}

Scan for available networks.

Returns

results - aa{ss}
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.

SetApn ( s: apn ) → nothing

Set the APN.

Parameters

apn - s
The APN.

GetSignalQuality ( ) → u

Get the current signal quality.

Returns

quality - u
Signal quality (percent).

SetBand ( u: band ) → nothing

Set the GSM band.

Parameters

band - u (MM_MODEM_GSM_NETWORK_BAND)
The band.

GetBand ( ) → u

Get the current band.

Returns

band - u (MM_MODEM_GSM_NETWORK_BAND)
The current band.

SetNetworkMode ( u: mode ) → nothing

Set the GSM network mode.

Parameters

mode - u (MM_MODEM_GSM_NETWORK_MODE)
The GSM network mode.

GetNetworkMode ( ) → u

Get the network mode.

Returns

mode - u (MM_MODEM_GSM_NETWORK_MODE)
The current network mode.

GetRegistrationInfo ( ) → u, s, s

Get the registration status and the current operator (if registered).

Returns

status - u (MM_MODEM_GSM_NETWORK_REG_STATUS)
The network status.
operator_code - s
The current operator code.
operator_name - s
The current operator name.

Signals:

SignalQuality ( u: quality )

The signal quality changed.

Parameters

quality - u
The new quality in percent, 0..100.

RegistrationInfo ( u: status, s: operator_code, s: operator_name )

The registration status changed.

Parameters

status - u (MM_MODEM_GSM_NETWORK_REG_STATUS)
The network status.
operator_code - s
The current operator code.
operator_name - s
The current operator name.

NetworkMode ( u: mode )

The network mode changed.

Parameters

mode - u (MM_MODEM_GSM_NETWORK_MODE)
The new network mode.

Interface has no properties.

Enumerated types:

MM_MODEM_GSM_NETWORK_MODE

MM_MODEM_GSM_NETWORK_MODE_ANY = 0
Any network mode can be used.
MM_MODEM_GSM_NETWORK_MODE_GPRS = 1
GPRS
MM_MODEM_GSM_NETWORK_MODE_EDGE = 2
EDGE
MM_MODEM_GSM_NETWORK_MODE_3G = 3
3G
MM_MODEM_GSM_NETWORK_MODE_HSDPA = 4
HSDPA
MM_MODEM_GSM_NETWORK_MODE_PREFER_2G = 5
Prefer 2G (GPRS or EDGE).
MM_MODEM_GSM_NETWORK_MODE_PREFER_3G = 6
Prefer 3G (3G or HSDPA).

MM_MODEM_GSM_NETWORK_BAND

MM_MODEM_GSM_NETWORK_BAND_ANY = 0
Any band can be used.
MM_MODEM_GSM_NETWORK_BAND_EGSM = 1
EGSM (900 MHz).
MM_MODEM_GSM_NETWORK_BAND_DCS = 2
DCS (1800 MHz).
MM_MODEM_GSM_NETWORK_BAND_PCS = 4
PCS (1900 MHz).
MM_MODEM_GSM_NETWORK_BAND_G850 = 8
G850 (850 MHz).
MM_MODEM_GSM_NETWORK_BAND_U2100 = 16
U2100 (WCDMA 2100 MHz).
MM_MODEM_GSM_NETWORK_BAND_U1700 = 32
U1700 (WCDMA 3GPP UMTS1800 MHz).
MM_MODEM_GSM_NETWORK_BAND_17IV = 64
17IV (WCDMA 3GPP AWS 1700/2100 MHz).
MM_MODEM_GSM_NETWORK_BAND_U800 = 128
U800 (WCDMA 3GPP UMTS800 MHz).
MM_MODEM_GSM_NETWORK_BAND_U850 = 256
U850 (WCDMA 3GPP UMTS850 MHz).
MM_MODEM_GSM_NETWORK_BAND_U900 = 512
U900 (WCDMA 3GPP UMTS900 MHz).
MM_MODEM_GSM_NETWORK_BAND_U17IX = 1024
U17IX (WCDMA 3GPP UMTS MHz).

MM_MODEM_GSM_NETWORK_REG_STATUS

MM_MODEM_GSM_NETWORK_REG_STATUS_IDLE = 0
Not registered, not searching for new operator to register.
MM_MODEM_GSM_NETWORK_REG_STATUS_HOME = 1
Registered on home network.
MM_MODEM_GSM_NETWORK_REG_STATUS_SEARCHING = 2
Not registered, searching for new operator to register with.
MM_MODEM_GSM_NETWORK_REG_STATUS_DENIED = 3
Registration denied.
MM_MODEM_GSM_NETWORK_REG_STATUS_UNKNOWN = 4
Unknown registration status.
MM_MODEM_GSM_NETWORK_REG_STATUS_ROAMING = 5
Registered on a roaming network.

org.freedesktop.ModemManager.Modem.Gsm.SMS

Methods:

Delete ( u: index ) → nothing

Delete an SMS message.

Parameters

index - u
The index of the SMS.

Get ( u: index ) → u, s, s, d

Retrieve an SMS from the SIM card.

Parameters

index - u
The index of the SMS.

Returns

found_index - u
The index of the SMS (same as the passed index).
number - s
The number the SMS was received from.
contents - s
The contents of the SMS.
time - d
The timestamp.

GetFormat ( ) → u

Returns

result - u

SetFormat ( u: format ) → nothing

Parameters

format - u

GetSmsc ( ) → s

Returns

result - s

SetSmsc ( s: smsc ) → nothing

Parameters

smsc - s

List ( ) → a(ussd)

Returns

result - a(ussd)

Save ( s: number, s: contents ) → u

Parameters

number - s
contents - s

Returns

index - u

Send ( ) → u

Returns

result - u

SendFromStorage ( u: index ) → nothing

Parameters

index - u

SetIndication ( u: mode, u: mt, u: bm, u: ds, u: bfr ) → nothing

Parameters

mode - u
mt - u
bm - u
ds - u
bfr - u

Signals:

SmsReceived ( u: index )

Parameters

index - u

Interface has no properties.

org.freedesktop.ModemManager.Modem.Gsm.Hso

Methods:

Authenticate ( s: username, s: password ) → nothing

Authenticate using the passed user name and password.

Parameters

username - s
password - s

GetIP4Config ( ) → u, au

Request the IP4 configuration from the device.

Returns

address - u
dns - au

Interface has no signals.

Properties:

NetworkDevice - s - (read)
The network device.

Index

Index of interfaces

Index of types