diff --git a/new/mm-mobile-error.xml b/new/mm-mobile-error.xml new file mode 100644 index 00000000..5edbcb76 --- /dev/null +++ b/new/mm-mobile-error.xml @@ -0,0 +1,318 @@ + + + Copyright (C) 2008 Novell, Inc. + + + + A phone failure. + + + + + + No connection to phone. + + + + + + Phone-adaptor link reserved. + + + + + + Operation not allowed. + + + + + + Operation not supported. + + + + + + PH-SIM PIN required. + + + + + + PH-FSIM PIN required. + + + + + + PH-FSIM PUK required. + + + + + + SIM not inserted. + + + + + + SIM PIN required. + + + + + + SIM PUK required. + + + + + + SIM failure. + + + + + + SIM busy. + + + + + + SIM wrong. + + + + + + Incorrect password. + + + + + + SIM PIN2 required. + + + + + + SIM PUK2 required. + + + + + + Memory full. + + + + + + Invalid index. + + + + + + Not found. + + + + + + Memory failure. + + + + + + Text string too long. + + + + + + Invalid characters in text string. + + + + + + Dial string too long. + + + + + + Invalid characters in dial string. + + + + + + No network service. + + + + + + Network timeout. + + + + + + Network not allowed - emergency calls only. + + + + + + Network personalization PIN required. + + + + + + Network personalization PUK required. + + + + + + Network subset personalization PIN required. + + + + + + Network subset personalization PUK required. + + + + + + Service provider personalization PIN required. + + + + + + Service provider personalization PUK required. + + + + + + Corporate personalization PIN required. + + + + + + Corporate personalization PUK required. + + + + + + Hidden key required. This key is required when accessing hidden phonebook entries. + + + + + + EAP method not supported. + + + + + + Incorrect parameters. + + + + + + An unknown error. + + + + + + Illegal MS. + + + + + + Illegal ME. + + + + + + GPRS services not allowed. + + + + + + PLMN not allowed. + + + + + + Location area not allowed. + + + + + + Roaming not allowed in this location area. + + + + + + Service option not supported. + + + + + + Requested service option not subscribed. + + + + + + Service option temporarily out of order. + + + + + + PDP authentication failure. + + + + + + Unspecified GPRS error + + + + + + Invalid mobile class. + + + + diff --git a/new/mm-modem-connect-error.xml b/new/mm-modem-connect-error.xml new file mode 100644 index 00000000..b983702e --- /dev/null +++ b/new/mm-modem-connect-error.xml @@ -0,0 +1,30 @@ + + + Copyright (C) 2008 Novell, Inc. + + + + No carrier. + + + + + + No dialtone. + + + + + + Busy. + + + + + + No answer. + + + + diff --git a/new/mm-modem-error.xml b/new/mm-modem-error.xml new file mode 100644 index 00000000..200e093a --- /dev/null +++ b/new/mm-modem-error.xml @@ -0,0 +1,36 @@ + + + Copyright (C) 2008 Novell, Inc. + + + + A generic error. An example of a generic error is ModemManager not being able to parse the response from modem. + + + + + + Operation not implemented by modem. + + + + + + Operation could not be performed while the modem is connected. + + + + + + Operation could not be performed while the modem is disconnected. + + + + + + Operation could not be performed because it is already in progress. + + + + diff --git a/new/mm-serial-error.xml b/new/mm-serial-error.xml new file mode 100644 index 00000000..338a2232 --- /dev/null +++ b/new/mm-serial-error.xml @@ -0,0 +1,24 @@ + + + Copyright (C) 2008 Novell, Inc. + + + + Could not open serial device. + + + + + + Could not write to the serial device. + + + + + + A response was not received in time. + + + + diff --git a/new/org.freedesktop.DBus.Properties.xml b/new/org.freedesktop.DBus.Properties.xml new file mode 100644 index 00000000..b2d09236 --- /dev/null +++ b/new/org.freedesktop.DBus.Properties.xml @@ -0,0 +1,45 @@ + + + + + + + One or more properties' values changed. + + + + The D-Bus interface of the changed properties. + + + + + The changed property names and their new values. + + + + + + + One or more properties value changed; this signal implements the + D-Bus specification's PropertiesChanged signal. + + + + The D-Bus interface of the changed properties. + + + + + The changed property names and their new values. + + + + + Properties which are now invalid, but for which the new value is not + emitted in this signal. Clients interested in these properties should + issue a Get request for them to retrieve the new value. + + + + + diff --git a/new/org.freedesktop.ModemManager1.Modem.3gpp.Ussd.xml b/new/org.freedesktop.ModemManager1.Modem.3gpp.Ussd.xml new file mode 100644 index 00000000..96d322d1 --- /dev/null +++ b/new/org.freedesktop.ModemManager1.Modem.3gpp.Ussd.xml @@ -0,0 +1,84 @@ + + + + + + + + Sends a USSD command string to the network initiating a USSD session. + When the request is handled by the network, the method returns the + response or an appropriate error. The network may be awaiting further + response from the ME after returning from this method and no new command + can be initiated until this one is cancelled or ended. + + + + + + The command to start the USSD session with. + + + + + The network response to the command which started the USSD session. + + + + + + + Respond to a USSD request that is either initiated by the mobile network, + or that is awaiting further input after Initiate() was called. + + + + + + The response to network-initiated USSD command, or a response to a + request for further input. + + + + + The network reply to this response to the network-initiated USSD + command. The reply may require further responses. + + + + + + + Cancel an ongoing USSD session, either mobile or network initiated. + + + + + + + + Indicates the state of any ongoing USSD session. Values may be one of + the following: "idle" (no active session), "active" (a session is active + and the mobile is waiting for a response), "user-response" (the network + is waiting for the client's response, which must be sent using Respond()). + + + + + + Contains any network-initiated request to which no USSD response is + required. When no USSD session is active, or when there is no network- + initiated request, this property will be a zero-length string. + + + + + + Contains any pending network-initiated request for a response. Client + should call Respond() with the appropriate response to this request. + When no USSD session is active, or when there is no pending + network-initiated request, this property will be a zero-length string. + + + + + diff --git a/new/org.freedesktop.ModemManager1.Modem.3gpp.xml b/new/org.freedesktop.ModemManager1.Modem.3gpp.xml new file mode 100644 index 00000000..4c8609f8 --- /dev/null +++ b/new/org.freedesktop.ModemManager1.Modem.3gpp.xml @@ -0,0 +1,140 @@ + + + + + + + + + + Request registration with a given mobile network. + + + + + + The network ID (ie, MCC-MNC, like "310260") to register. An empty + string can be used to register to the home network. + + + + + + + Scan for available networks. + + + + + +

Found networks. It's an array of dictionaries (strings for both + keys and values) with each array element describing a mobile network + found in the scan. Each dict may include one or more of the following + keys:

+
    +
  • + "status": a number representing network availability status as + defined in 3GPP TS 27.007 section 7.3. e.g. "0" (unknown), "1" + (available), "2" (current), or "3" (forbidden). This key will + always be present. +
    • +
  • + "operator-long": long-format name of operator. If the name is + unknown, this field should not be present. +
    • +
  • + "operator-short": short-format name of operator. If the name is + unknown, this field should not be present. +
    • +
  • + "operator-num": mobile code of the operator. Returned in the + format "MCCMNC", where MCC is the three-digit ITU E.212 Mobile + Country Code and MNC is the two- or three-digit GSM Mobile + Network Code. e.g. "31026" or "310260". +
    • +
  • + "access-tech": a number representing the generic access technology + used by this mobile network, defined by the MM_MODEM_ACCESS_TECH + enum. +
    • +
+ + + + + + + + + The IMEI of the device. + + + + + + Mobile registration status as defined in 3GPP TS 27.007 section + 10.1.19. + + + + + + Current operator code of the operator to which the mobile is + currently registered. Returned in the format "MCCMNC", where MCC + is the three-digit ITU E.212 Mobile Country Code and MNC is the + two- or three-digit GSM Mobile Network Code (e.g. "31026" or "310260"). + If the MCC and MNC are not known or the mobile is not registered to a + mobile network, this property will be a zero-length (blank) string. + + + + + + Current operator name of the operator to which the mobile is + currently registered. If the operator name is not knowon or the + mobile is not registered to a mobile network, this property will + be a zero-length (blank) string. + + + + + + + + GSM registration code as defined in 3GPP TS 27.007 section 10.1.19. + + + + Not registered, not searching for new operator to register. + + + + + Registered on home network. + + + + + Not registered, searching for new operator to register with. + + + + + Registration denied. + + + + + Unknown registration status. + + + + + Registered on a roaming network. + + + + + + + diff --git a/new/org.freedesktop.ModemManager1.Modem.Bearer.xml b/new/org.freedesktop.ModemManager1.Modem.Bearer.xml new file mode 100644 index 00000000..180641d8 --- /dev/null +++ b/new/org.freedesktop.ModemManager1.Modem.Bearer.xml @@ -0,0 +1,137 @@ + + + + + + + + + + Requests activation of a packet data connection with the network using + this bearer's properties. Upon successful activation, the modem can + send and receive packet data and, depending on the addressing + capability of the modem, a connection manager may need to start PPP, + perform DHCP, or assign the IP address returned by the modem to the + data interface. Upon successful return, the Ip4Config and/or Ip6Config + properties become valid and may contain IP configuration information for + the data interface associated with this bearer. + + + + + + The number to use for dialing. + + + + + + + Disconnect and deactivate this packet data connection. Any ongoing data + session will be terminated and IP addresses become invalid when this + method is called. + + + + + + + + + + + + The operating system name for the network data interface that provides + packet data using this bearer. Connection managers must configure this + interface depending on the IP "method" given by the "Ip4Config" or + "Ip6Config" properties set by bearer activation. If STATIC or DHCP + methods are given, the interface will be an ethernet-style inteface + suitable for DHCP or setting static IP configuration on, while if the + PPP method is given, the interface will be a serial TTY which must then + have PPP run over it. + + + + + + Indicates whether or not the bearer is connected and thus whether + packet data communication using this bearer is possible. + + + + + + In some devices, packet data service will be suspended while the device + is handling other communication, like a voice call. If packet data + service is suspended (but not deactivated) this property will be TRUE. + + + + + + If the bearer was configured for IPv4 addressing, upon activation this + property contains the addressing details for assignment to the data + interface. If the bearer specifies configuration via PPP or DHCP, + only the 'method' item will be present. Available items include: + + method: (uint) One of MM_MODEM_BEARER_IP_METHOD + address: (string, STATIC method only) IP address + prefix: (uint, STATIC method only) Numeric CIDR network prefix (ie, 24, 32, etc) + dns1: (string, STATIC method only) First DNS server + dns2: (string, STATIC method only) Second DNS server + dns3: (string, STATIC method only) Third DNS server + gateway: (string, STATIC method only) First DNS server + + + + + + If the bearer was configured for IPv6 addressing, upon activation this + property contains the addressing details for assignment to the data + interface. If the bearer specifies configuration via PPP or DHCP, + only the 'method' item will be present. Available items include: + + method: (uint) One of MM_MODEM_BEARER_IP_METHOD + address: (string, STATIC method only) IP address + prefix: (string, STATIC method only) Network prefix + dns1: (string, STATIC method only) First DNS server + dns2: (string, STATIC method only) Second DNS server + dns3: (string, STATIC method only) Third DNS server + gateway: (string, STATIC method only) First DNS server + + + + + + + + Connection managers should use PPP to get the address. + + + + + Connection managers should use the provided static IP configuration + given by the modem to configure the IP data interface. + + + + + Connection managers should begin DHCP on the data interface to obtain + necessary IP configuration details. + + + + + + diff --git a/new/org.freedesktop.ModemManager1.Modem.Cdma.xml b/new/org.freedesktop.ModemManager1.Modem.Cdma.xml new file mode 100644 index 00000000..730a3c98 --- /dev/null +++ b/new/org.freedesktop.ModemManager1.Modem.Cdma.xml @@ -0,0 +1,184 @@ + + + + + + + + + + Provisions the modem for use with a given carrier using the modem's + Over-The-Air (OTA) activation functionality, if any. In the event of + immediate failure, returns an error value instead of setting a DBus error. + + + + + + Name of carrier. + + + + + An enum from MM_MODEM_CDMA_ACTIVATION_ERROR. This is + returned for immediate errors. Delayed errors are returned + via an ActivationStateChanged signal + + + + + + + Sets the modem provisioning data directly, without contacting the + carrier over the air. Some modems will reboot after this call is made. + + + + + + A dictionary of properties to set on the modem. Keys include 'mdn', 'min' + + + + + + + + + The device activation state changed. + + + Current activation state + + + Carrier-specific error code + + + + Selected Modem.Simple.GetStatus keys that have changed as a result of + this activation state change. Will include 'mdn' and 'min'. + + + + + + + + + The modem's Mobile Equipment Identifier. + + + + + + The modem's Electronic Serial Number (superceded by the MEID but still + used by older devices). + + + + + + The System Identifier of the serving CDMA 1x network, if known, and + if the modem is registered with a CDMA 1x network. See ifast.org or + the mobile broadband provider database for mappings of SIDs to network + providers. + + + + + + The Network Identifier of the serving CDMA 1x network, if known, and + if the modem is registered with a CDMA 1x network. + + + + + CDMA 1x registration state. + + + + EVDO registration state. + + + + + + + Registration status is unknown or the device is not registered. + + + Registered, but roaming status is unknown or cannot be provided by the device. The device may or may not be roaming. + + + Currently registered on the home network. + + + Currently registered on a roaming network. + + + + + + Device is not activated + + + Device is activating + + + Device is partially activated; carrier-specific steps required to continue. + + + Device is ready for use. + + + + + + + + Device cannot activate while roaming. + + + + + Device cannot activate on this network type (eg EVDO vs 1xRTT). + + + + + Device could not connect to the network for activation. + + + + + Device could not authenticate to the network for activation. + + + + + Later stages of device provisioning failed. + + + + + No signal available. + + + + + An error occurred. + + + + + Activation timed out. + + + + + API call for initial activation failed. + + + + + diff --git a/new/org.freedesktop.ModemManager1.Modem.Contacts.xml b/new/org.freedesktop.ModemManager1.Modem.Contacts.xml new file mode 100644 index 00000000..7ddab3c4 --- /dev/null +++ b/new/org.freedesktop.ModemManager1.Modem.Contacts.xml @@ -0,0 +1,139 @@ + + + + + + + + Add a new contact. + + + + + + Dictionary of properties describing the contact. If any property + exceeds the modem's size limit, that property will be truncated to fit. + Known properties are: + + name : (string) Full name of the contact + number : (string) Telephone number + email : (string) Email address + group : (string) Group this contact belongs to + name2 : (string) Additional contact name + number2 : (string) Additional contact telephone number + hidden : (bool) Whether this entry is hidden or not + storage : (uint) Phonebook in which contact is stored, one of + MM_MODEM_CONTACTS_STORAGE + + + + + The index number of the new contact; this number is an internal + private number to ModemManager and does not correspond to the index + of the contact in the modem or SIM itself. + + + + + + + Delete a contact. + + + + + + The index of the contact to delete. + + + + + + + Retrieve a contact from the SIM card. + + + + + + The index of the contact. + + + + + The properties of the contact including those properties defined by + the Add method. + + + + + + + List all contacts. + + + + + + An array of dictionaries, each dictionary representing a contact. + + + + + + + Find a contact from the SIM card. + + + + + + The pattern to search for. + + + + + An array of dictionaries, each dictionary representing a contact which + matches the query pattern. + + + + + + + Get the number of contacts stored on the SIM card. + + + + + + The number of contacts. + + + + + + + + + Specifies different storage locations for contact information. + + + + Store information in device's local memory. + + + + + Store information in a card inserted in the device (like a SIM/RUIM). + + + + + Store information in the combined device/ME and SIM/SM phonebook. + + + + + + diff --git a/new/org.freedesktop.ModemManager1.Modem.Location.xml b/new/org.freedesktop.ModemManager1.Modem.Location.xml new file mode 100644 index 00000000..7a5908fa --- /dev/null +++ b/new/org.freedesktop.ModemManager1.Modem.Location.xml @@ -0,0 +1,253 @@ + + + + + + This interface allows devices to provide location information to client + applications. Not all devices can provide this information, or even if + they do, they may not be able to provide it while a data session is + active. + + + + + Location capabilities of the device. + + + + + + TRUE if location information gathering is enabled for this device, FALSE + if it is disabled. When disabled, the device will not provide location + information. + + + + + + Enable or disable location information gathering. This method may + require the client to authenticate itself. This method may also cause + any necessary functionality of the mobile be be turned on, including + enabling the modem device itself. + + + + + + TRUE to enable location information gathering, FALSE to disable. + + + + + When enabling location information gathering, this argument controls + whether the device emits signals with new location information or not. + When signals are emitted, any client application (including malicious + ones!) can listen for location updates unless D-Bus permissions + restrict these signals from certain users. If further security is + desired, this argument can be set to FALSE to disable location + updates via D-Bus signals and require applications to call + authenticated APIs (like GetLocation) to get location information. + This argument is ignored when disabling location information + gathering. + + + + + + + Return current location information, if any. This method may require + the client to authenticate itself. + + + + + + Dict of available location information when location information + gathering is enabled. If the modem supports multiple location types + it may return more than one here. + + + + + + + TRUE if location updates will be emitted via D-Bus signals, FALSE + if location updates will not be emitted. See the Enable method for + more information. + + + + + + Dict of available location information when location information + gathering is enabled. If the modem supports multiple location types + it may return more than one here. Note that if the device was told + not to emit updated location information when location information + gathering was initially enabled, this property may not return + any location information for security reasons. + + + + + + A mapping from location type to type-specific location information. + + + + Identifies the type and format of the associated location information. + Contrary to the value description, this is not a bitfield but uses the + same values as the MM_MODEM_LOCATION_CAPABILITIES bitfield. + + + + + Contains type-specific location information. See the documentation for + each type for a description of its data format. + + + + + + +

Unknown or no capabilties.

 + + + +

For capability reporting, indicates the device is capable of + providing GPS NMEA-format location information.

+ +

For location reporting, devices supporting this capability return + a string containing one or more NMEA sentences (D-Bus signature 's'). + The manager will cache the most recent NMEA sentence of each type for + a period of time not less than 30 seconds. When reporting multiple + NMEA sentences, sentences shall be separated by an ASCII Carriage + Return and Line Feed (<CR><LF>) sequence. +

+

+ For example, if the device sends a $GPRMC sentence immediately + followed by a $GPGGA sentence, the reported location string would be + (where of course the <CR><LF> is replaced with the actual + ASCII CR (0x0D) and LF (0x0A) control characters): + 

+          $GPRMC,134523.92,V,,,,,,,030136,,,N*73<CR><LF>$GPGGA,,,,,,0,00,0.5,,M,0.0001999,M,0.0000099,0000*45
+
+ If the device sends a new $GPRMC three seconds later, the new $GPRMC + replaces the previously received $GPRMC sentence, and the updated + string would be: + 
+          $GPRMC,134526.92,V,,,,,,,030136,,,N*76<CR><LF>$GPGGA,,,,,,0,00,0.5,,M,0.0001999,M,0.0000099,0000*45
+
+ If the device then sends a $GPGSA sentence about 5 seconds later, the + $GPGSA sentence is added to the string (since no $GPGSA sentence was + previously received in this session), the updated string would be: + 
+          $GPRMC,134526.92,V,,,,,,,030136,,,N*76<CR><LF>$GPGGA,,,,,,0,00,0.5,,M,0.0001999,M,0.0000099,0000*45<CR><LF>$GPGSA,A,1,,,,,,,,,,,,,1.1,0.5,1.0*34
+
+ The manager may discard any cached sentences older than 30 seconds. +

+

This allows clients to read the latest positioning data as soon as + possible after they start, even if the device is not providing + frequent location data updates. +

+ + + + +

For capability reporting, indicates the device is capable of + providing GSM Location Area Code/Cell ID location information.

+ +

For location reporting, devices supporting this + capability return a string in the format "MCC,MNC,LAC,CI" (without the + quotes of course) where the following applies:

+
    +
  • + MCC is the three-digit ITU E.212 Mobile Country Code of the + network provider to which the mobile is currently registered. + This value should be the same MCC as reported by the + org.freedesktop.Modem.Gsm.Network.GetRegistrationInfo() method's + returned "operator code" argument. + e.g. "310" +
    • +
  • + MNC is the two- or three-digit GSM Mobile Network Code of the + network provider to which the mobile is currently registered. + This value should be the same MCC as reported by the + org.freedesktop.Modem.Gsm.Network.GetRegistrationInfo() method's + returned "operator code" argument. + e.g. "26" or "260" +
    • +
  • + LAC is the two-byte Location Area Code of the base station with + which the mobile is registered, in upper-case hexadecimal format + without leading zeros, as specified in 3GPP TS 27.007 section + 10.1.19. e.g. "84CD". +
    • +
  • + CI is the two- or four-byte Cell Identifier with which the mobile + is registered, in upper-case hexadecimal format without leading + zeros, as specified in 3GPP TS 27.007. e.g. "2BAF" or "D30156". +
    • +
+

The entire string may only be composed of the ASCII digits [0-9], + the alphabetical characters [A-F], and the comma (,) character. No + other characters are allowed. For example: "310,260,8BE3,2BAF" or + "250,40,CE00,1CEAD8F0".

+ +

If any of these four items (MCC,MNC,LAC,CI) is unknown or the + mobile is not registered with a network, then the GSM_LAC_CI location + information item should not be provided as a returned value from the + GetLocation() method or in the Location property.

+ + + + +

For capability reporting, indicates the device is capable of + providing raw GPS information using a series of defined key/value + pairs.

+ +

For location reporting, devices supporting this + capability return a D-Bus dict (signature a{sv}) mapping well-known + keys to values with defined formats. The allowed key/value pairs + and their formats are:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
KeyValue TypeValue contentsExample
latitudedLatitude in Decimal Degrees (positive numbers mean N quadrasphere, negative mean S quadrasphere)38.889722 (ie, 38d 53' 22" N)
longitudedLongitude in Decimal Degrees (positive numbers mean E quadrasphere, negative mean W quadrasphere)-77.008889 (ie, 77d 0' 32" W)
altitudedAltitude above sea level in meters33.5
horiz-velocitydHorizontal velocity in meters-per-second.5
vert-velocitydVertical velocity in meters-per-second.01
+

The 'latitude' and 'longitude' keys are required; other keys are + optional.

+ + + + + + + diff --git a/new/org.freedesktop.ModemManager1.Modem.Simple.xml b/new/org.freedesktop.ModemManager1.Modem.Simple.xml new file mode 100644 index 00000000..20af2934 --- /dev/null +++ b/new/org.freedesktop.ModemManager1.Modem.Simple.xml @@ -0,0 +1,116 @@ + + + + + + + + + + Do everything needed to connect the modem using the given properties. + This method will attempt to find a matching packet data bearer and + activate it if necessary, returning the bearer's IP details. If no + matching bearer is found, a new bearer will be created and activated, + but this operation may fail if no resources are available to complete + this connection attempt (ie, if a conflicting bearer is already active). + + + + + + Dictionary of properties needed to get the modem connected. This + call may make a large number of changes to modem configuration based + on properties passed in. For example, given a PIN-locked, disabled + GSM/UMTS modem, this call may unlock the SIM PIN, alter the access + technology preference, wait for network registration (or force + registration to a specific provider), create a new packet data bearer + using the given 'apn', and connect that bearer. + + 'pin' : (string) SIM-PIN unlock code + 'network-id' : (string) ETSI MCC-MNC of a network to force registration with + 'band' : (uint) Bitfield of radio bands the modem may use + 'allowed-mode' : (uint) Allowed network technology preference (ie, 2G/3G, etc) + 'apn' : (string) For GSM/UMTS and LTE devices the APN to use + 'ip-type' : (string) For GSM/UMTS and LTE devices the IP addressing + type to use, one of "IPV4", "IPV4V6", or "IPV6" + 'number' : (string) For POTS devices, the number to dial + 'home_only' : (uint) 1 to allow only connections to home networks + + + + + On successful connect, returns the object path of the connected + packet data bearer used for the connection attempt. + + + + + The operating system name for the network data interface that provides + packet data using this bearer. Connection managers must configure this + interface using the given IP configuration returned by bearer activation. + + + + + If the bearer was configured for IPv4 addressing, upon successful + connect this argument contains the addressing details for assignment + to the data interface. If the bearer specifies configuration via PPP + or DHCP, only the 'method' item will be present. See the description + of the property of this name in the + org.freedesktop.ModemManager1.Modem.Bearer interface. + + + + + If the bearer was configured for IPv6 addressing, upon successful + connect this argument contains the addressing details for assignment + to the data interface. If the bearer specifies configuration via PPP + or DHCP, only the 'method' item will be present. See the description + of the property of this name in the + org.freedesktop.ModemManager1.Modem.Bearer interface. + + + + + + + Disconnect an active packet data connection. + + + + + + If given this method will disconnect the referenced packet data bearer, + while if "/" (ie, no object given) this method will disconnect all + active packet data bearers. + + + + + + + + Get the modem status. + + + + + + Dictionary of properties. The predefined common properties are: + + 'state' : (uint, always) Modem state + 'signal-quality' : (uint, state >= registered) + 'operator-code' : (string, state >= registered) Operator MCC-MNC + 'operator-name' : (string, state >= registered) + 'band' : (uint, state >= registered) + 'access-technology' : (uint, state >= registered) See MM_MODEM_ACCESS_TECH + + + + + + diff --git a/new/org.freedesktop.ModemManager1.Modem.xml b/new/org.freedesktop.ModemManager1.Modem.xml new file mode 100644 index 00000000..32a6a93f --- /dev/null +++ b/new/org.freedesktop.ModemManager1.Modem.xml @@ -0,0 +1,601 @@ + + + + + + + + + + Enable or disables the modem. When enabled, the modem's radio is powered + on and data sessions, voice calls, location services, and Short Message + Service may be available. When disabled, the modem enters low-power + state and no network-related operations are available. + + + + + + Pass True to enable the modem, or False to disable it. + + + + + + + List configured packet data bearers (EPS Bearers, PDP Contexts, or + CDMA2000 Packet Data Sessions). + + + + + + The list of bearer object paths. + + + + + + + Create a new packet data bearer using the given characteristics. This + request may fail if the modem does not support additional bearers, if + too many bearers are already defined, or if properties are invalid. + + + + + + List of properties to assign to the bearer after creating it. Some + properties are only applicable to a bearer of certain access + technologies, for example the "apn" property is not applicable to + CDMA2000 Packet Data Session bearers. Allowed properties are: + + apn : (3GPP, required) Access Point Name + ip-type : (3GPP and CMDA, optional) Addressing type, one of + "IPV4", "IPV4V6", or "IPV6" + user : (3GPP, optional) user name (if any) required by the network + password : (3GPP, optional) password (if any) required by the network + number : (POTS, required) telphone number to dial + + ** FIXME: how about QoS? + + + + + + + Delete an existing packet data bearer. + + + + + + Object path of the bearer to delete. If the bearer is currently + active and providing packet data server, it will be disconnected + and that packet data service will terminate. + + + + + + + Retrieve modem information, like the manufacturer, hardware version, + firmware version, etc. + + + + + + Dictionary containing various information about the modem, including + zero or more of the following items: + + manufacturer : (string) + model : (string) + version/revision : (string) + + + + + + + Clear non-persistent configuration and state, and return the device to + a newly-powered-on state. This command may power-cycle the device. + + + + + + + + Clear the modem's configuration (including persistent configuration and + state), and return the device to a factory-default state. This command + may or may not power-cycle the device. + + + + + Carrier-supplied code required to reset the modem. Ignored if not required. + + + + + + + + The modem's state (see the State property) changed. + + + Old state + + + New state + + + Reason for this state change + + + + + + + + The generic family of access technologies the modem supports. Not all + capabilities are available at the same time however; some modems require + a firmware reload or other reinitialization to switch between eg CDMA/EVDO + and GSM/UMTS. + + + + + + The generic family of access technologies the modem currently supports + without a firmware reload or reinitialization. + + + + + + The maximum number of defined packet data bearers the modem supports. + This is not the number of active/connected bearers the modem supports, + but simply the number of bearers that may be defined at any given time. + For example, POTS and CDMA2000-only devices support only one bearer, + while GSM/UMTS devices typically support three or more, and any + LTE-capable device (whether LTE-only, GSM/UMTS-capable, and/or + CDMA2000-capable) also typically support three or more. + + + + + + The maximum number of active packet data bearers the modem supports. + POTS and CDMA2000-only devices support one active bearer, while + GSM/UMTS and LTE-capable devices (including LTE/CDMA devices) typically + support at least two active bearers. + + + + + + A best-effort device identifier based on various device information like + model name, firmware revision, USB/PCI/PCMCIA IDs, and other properties. + This ID is not guaranteed to be unique and may be shared between + identical devices with the same firmware, but is intended to be + "unique enough" for use as a casual device identifier for various + user experience operations. This is not the device's IMEI or ESN since + those may not be available before unlocking the device via a PIN. + + + + + + The physical modem device reference (ie, USB, PCI, PCMCIA device), which + may be dependent upon the operating system. In Linux for example, this + points to a sysfs path of the usb_device object. + + + + + + The Operating System device driver handling communication with the + modem hardware. + + + + + + The identity of the device. This will be the IMEI number for + GSM devices and the hex-format ESN/MEID for CDMA devices. + + + + + + Empty if the device is usable without an unlock code or has already + been unlocked. If the device needs to be unlocked before becoming usable this + property contains the specific unlock code required.  Valid unlock code values + are "" (blank), "sim-pin", "sim-puk", "ph-sim-pin", "ph-fsim-pin", + "ph-fsim-puk", "sim-pin2", "sim-puk2", "ph-net-pin", "ph-net-puk", + "ph-netsub-pin", "ph-netsub-puk", "ph-sp-pin", "ph-sp-puk", "ph-corp-pin", and + "ph-corp-puk". + + + + + + The number of unlock retries remaining for the unlock code given by the property UnlockRequired, or 999 if + the device does not support reporting unlock retries. + + + + + + Overall state of the modem. + + + + + + The current network access technology used by the device to communicate + with the network. (Note to plugin writers: if the device's access + technology cannot be determined, use UNKNOWN) + + + + + + Signal quality in percent (0 - 100) of the dominant access technology + the device is using to communicate with the network. Always 0 for POTS + devices. + + + + + + The allowed access technologies (eg 2G/3G/4G preference) the device is + allowed to use when connecting to a network. For POTS devices, only + the "any" mode is supported. + + + + + + Access technology selection modes supported by the device. + + + + + + The allowed radio frequency and technology bands the device may use when + allowed to use when connecting to a network. For POTS devices, only + the "any" mode is supported. + + + + + + Radio frequency and technology bands supported by the device. + + + + + + + + Flags describing one or more of the general access technology families + that a modem supports. + + + Modem has no capabilties. + + + + Modem supports the analog wired telephone network (ie 56k dialup) and + does not have wireless/cellular capabilities. + + + + + Modem supports at least one of CDMA 1xRTT, EVDO revision 0, EVDO + revision A, or EVDO revision B. + + + + + Modem supports at least one of GSM, GPRS, EDGE, UMTS, HSDPA, HSUPA, or + HSPA+ packet switched data capability. + + + + + Modem has at LTE data capability. + + + + + + + + State unknown or not reportable. + + + + + The modem is not enabled and is powered down. + + + + + The modem is current transitioning to the DISABLED state. + + + + + The modem is currently transitioning to the ENABLED state. + + + + + The modem is enabled and powered on but not registered with a network + provider and not available for data connections. + + + + + The modem is searching for a network provider to register with. + + + + + The modem is registered with a network provider, and data connections + and messaging may be available for use. + + + + + The modem is disconnecting and deactivating the last active packet + data bearer. This state will not be entered if more than one packet + data bearer is active and one of the active bearers is deactivated. + + + + + The modem is activating and connecting the first packet data bearer. + Subsequent bearer activations when another bearer is already active + do not cause this state to be entered. + + + + + One or more packet data bearers is active and connected. + + + + + + + + Reason unknown or not reportable. + + + + + State change was requested by an interface user. + + + + + State change was caused by a system suspend. + + + + + + + Describes various access technologies that a device uses when registered + with or connected to a network. + + + The access technology used is unknown + + + Analog wireline telephone + + + GSM + + + Compact GSM + + + GPRS + + + EDGE (ETSI 27.007: "GSM w/EGPRS") + + + UMTS (ETSI 27.007: "UTRAN") + + + HSDPA (ETSI 27.007: "UTRAN w/HSDPA") + + + HSUPA (ETSI 27.007: "UTRAN w/HSUPA") + + + HSPA (ETSI 27.007: "UTRAN w/HSDPA and HSUPA") + + + HSPA+ (ETSI 27.007: "UTRAN w/HSPA+") + + + CDMA2000 1xRTT + + + CDMA2000 EVDO revision 0 + + + CDMA2000 EVDO revision A + + + CDMA2000 EVDO revision B + + + LTE (ETSI 27.007: "E-UTRAN") + + + + + + Describes the device's current access mode preference; ie the specific + technology preferences the device is allowed to use when connecting to + a network. Also used as a bitfield to indicate which allowed modes + the modem supports when setting the mode preference. + + + + Any mode can be used (only this value allowed for POTS modems) + + + + Prefer 2G (GPRS or EDGE) + + + Prefer 3G (UMTS or HSxPA) + + + Prefer 4G (LTE) + + + Use only 2G (GPRS or EDGE) + + + Use only 3G (UMTS or HSxPA) + + + Use only 4G (LTE) + + + + + + + A 64-bit wide bitfield describing the specific radio bands supported by + the device and the radio bands the device is allowed to use when + connecting to a mobile network. + + + Unknown or invalid band + + + For certain operations, allow the modem to select a band automatically. + + + + + GSM/GPRS/EDGE 900 MHz + + + GSM/GPRS/EDGE 1800 MHz + + + GSM/GPRS/EDGE 1900 MHz + + + GSM/GPRS/EDGE 850 MHz + + + WCDMA 2100 MHz (Class I) + + + WCDMA 3GPP 1800 MHz (Class III) + + + WCDMA 3GPP AWS 1700/2100 MHz (Class IV) + + + WCDMA 3GPP UMTS 800 MHz (Class VI) + + + WCDMA 3GPP UMTS 850 MHz (Class V) + + + WCDMA 3GPP UMTS 900 MHz (Class VIII) + + + WCDMA 3GPP UMTS 1700 MHz (Class IX) + + + WCDMA 3GPP UMTS 1900 MHz (Class II) + + + WCDMA 3GPP UMTS 2600 MHz (Class VII, internal) + + + + + CDMA Band Class 0 (US Cellular 850MHz) + + + CDMA Band Class 1 (US PCS 1900MHz) + + + CDMA Band Class 2 (UK TACS 900MHz) + + + CDMA Band Class 3 (Japanese TACS) + + + CDMA Band Class 4 (Korean PCS) + + + CDMA Band Class 5 (NMT 450MHz) + + + CDMA Band Class 6 (IMT2000 2100MHz) + + + CDMA Band Class 7 (Cellular 700MHz) + + + CDMA Band Class 8 (1800MHz) + + + CDMA Band Class 9 (900MHz) + + + CDMA Band Class 10 (US Secondary 800) + + + CDMA Band Class 11 (European PAMR 400MHz) + + + CDMA Band Class 12 (PAMR 800MHz) + + + CDMA Band Class 13 (IMT2000 2500MHz Expansion) + + + CDMA Band Class 14 (More US PCS 1900MHz) + + + CDMA Band Class 15 (AWS 1700MHz) + + + CDMA Band Class 16 (US 2500MHz) + + + CDMA Band Class 17 (US 2500MHz Forward Link Only) + + + CDMA Band Class 18 (US 700MHz Public Safety) + + + CDMA Band Class 19 (US Lower 700MHz) + + + + + diff --git a/new/org.freedesktop.ModemManager1.Sim.xml b/new/org.freedesktop.ModemManager1.Sim.xml new file mode 100644 index 00000000..14c34aea --- /dev/null +++ b/new/org.freedesktop.ModemManager1.Sim.xml @@ -0,0 +1,113 @@ + + + + + + + Handles communication with SIM, USIM, and RUIM (CDMA SIM) cards. + + + + + Get the IMSI of the SIM card. + + + + + + The IMSI. + + + + + + + Returns the ID of the network operator that issued the SIM card, + formatted as a 5 or 6-digit MCC/MNC code (ex "310410"). + + + + + + The operator ID formatted as an MCC/MNC code. + + + + + + + Send the PUK and a new PIN to unlock the SIM card. + + + + + + The PUK code. + + + + + The PIN code. + + + + + + + Send the PIN to unlock the SIM card. + + + + + + The PIN code. + + + + + + + Enable or disable the PIN checking. + + + + + + The PIN code. + + + + + True to enable PIN checking. + + + + + + + Change the PIN code. + + + + + + The current PIN code. + + + + + The new PIN code. + + + + + + + An obfuscated SIM identifier based on the IMSI or the ICCID. This may + be available before the PIN has been entered depending on the device + itself. + + + + + diff --git a/new/org.freedesktop.ModemManager1.xml b/new/org.freedesktop.ModemManager1.xml new file mode 100644 index 00000000..6ec05dad --- /dev/null +++ b/new/org.freedesktop.ModemManager1.xml @@ -0,0 +1,51 @@ + + + + + + + + + + Get the list of modems known to ModemManager. + + + + + List of object paths of modem devices known to the system. + + + + + + + A modem was added to the system. + + + + The object path of the newly added modem. + + + + + + + A modem was removed from the system, and is no longer available. + + + + The object path of the modem that was just removed. + + + + + + + + + Array of object paths of all modems known to ModemManager. + + + + +