From 245818de331608a10c2279a56c5feba86aa1a1ea Mon Sep 17 00:00:00 2001 From: Elly Jones Date: Mon, 20 Dec 2010 12:23:41 -0500 Subject: Install xml files so they can be used by cromo (chromeos modem manager) Amended: Install the files under their proper DBus names. Review URL: http://codereview.chromium.org/1618004 (cherry picked from commit 89f7f05f1294485fa8b44cfdd3c9b0d924d45ac1) Conflicts: Makefile.am Change-Id: I65b2b0c1b5e579bb5b1d5d5b390c3be2ae49543c --- introspection/all.xml | 26 +- introspection/mm-manager.xml | 40 --- introspection/mm-modem-cdma.xml | 97 ------ introspection/mm-modem-gsm-card.xml | 135 -------- introspection/mm-modem-gsm-contacts.xml | 104 ------- introspection/mm-modem-gsm-hso.xml | 19 -- introspection/mm-modem-gsm-network.xml | 340 --------------------- introspection/mm-modem-gsm-sms.xml | 156 ---------- introspection/mm-modem-gsm-ussd.xml | 78 ----- introspection/mm-modem-gsm.xml | 164 ---------- introspection/mm-modem-location.xml | 253 --------------- introspection/mm-modem-simple.xml | 58 ---- introspection/mm-modem.xml | 185 ----------- introspection/mm-properties-changed.xml | 45 --- introspection/org.freedesktop.DBus.Properties.xml | 45 +++ ...org.freedesktop.ModemManager.Modem.Gsm.Card.xml | 135 ++++++++ ...freedesktop.ModemManager.Modem.Gsm.Contacts.xml | 104 +++++++ .../org.freedesktop.ModemManager.Modem.Gsm.Hso.xml | 19 ++ ....freedesktop.ModemManager.Modem.Gsm.Network.xml | 340 +++++++++++++++++++++ .../org.freedesktop.ModemManager.Modem.Gsm.SMS.xml | 156 ++++++++++ ...org.freedesktop.ModemManager.Modem.Gsm.Ussd.xml | 78 +++++ .../org.freedesktop.ModemManager.Modem.Gsm.xml | 164 ++++++++++ ...org.freedesktop.ModemManager.Modem.Location.xml | 253 +++++++++++++++ .../org.freedesktop.ModemManager.Modem.Simple.xml | 58 ++++ .../org.freedesktop.ModemManager.Modem.xml | 185 +++++++++++ introspection/org.freedesktop.ModemManager.xml | 40 +++ 26 files changed, 1590 insertions(+), 1687 deletions(-) delete mode 100644 introspection/mm-manager.xml delete mode 100644 introspection/mm-modem-cdma.xml delete mode 100644 introspection/mm-modem-gsm-card.xml delete mode 100644 introspection/mm-modem-gsm-contacts.xml delete mode 100644 introspection/mm-modem-gsm-hso.xml delete mode 100644 introspection/mm-modem-gsm-network.xml delete mode 100644 introspection/mm-modem-gsm-sms.xml delete mode 100644 introspection/mm-modem-gsm-ussd.xml delete mode 100644 introspection/mm-modem-gsm.xml delete mode 100644 introspection/mm-modem-location.xml delete mode 100644 introspection/mm-modem-simple.xml delete mode 100644 introspection/mm-modem.xml delete mode 100644 introspection/mm-properties-changed.xml create mode 100644 introspection/org.freedesktop.DBus.Properties.xml create mode 100644 introspection/org.freedesktop.ModemManager.Modem.Gsm.Card.xml create mode 100644 introspection/org.freedesktop.ModemManager.Modem.Gsm.Contacts.xml create mode 100644 introspection/org.freedesktop.ModemManager.Modem.Gsm.Hso.xml create mode 100644 introspection/org.freedesktop.ModemManager.Modem.Gsm.Network.xml create mode 100644 introspection/org.freedesktop.ModemManager.Modem.Gsm.SMS.xml create mode 100644 introspection/org.freedesktop.ModemManager.Modem.Gsm.Ussd.xml create mode 100644 introspection/org.freedesktop.ModemManager.Modem.Gsm.xml create mode 100644 introspection/org.freedesktop.ModemManager.Modem.Location.xml create mode 100644 introspection/org.freedesktop.ModemManager.Modem.Simple.xml create mode 100644 introspection/org.freedesktop.ModemManager.Modem.xml create mode 100644 introspection/org.freedesktop.ModemManager.xml (limited to 'introspection') diff --git a/introspection/all.xml b/introspection/all.xml index dd30b574..0533e14c 100644 --- a/introspection/all.xml +++ b/introspection/all.xml @@ -23,19 +23,19 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

- - - - - - - - - - - - - + + + + + + + + + + + + + diff --git a/introspection/mm-manager.xml b/introspection/mm-manager.xml deleted file mode 100644 index bdeac01b..00000000 --- a/introspection/mm-manager.xml +++ /dev/null @@ -1,40 +0,0 @@ - - - - - - - Get the list of modem devices. - - - - - List of object paths of modem devices known to the system. - - - - - - - A device was added to the system. - - - - The object path of the newly added device. - - - - - - - A device was removed from the system, and is no longer available. - - - - The object path of the device that was just removed. - - - - - - diff --git a/introspection/mm-modem-cdma.xml b/introspection/mm-modem-cdma.xml deleted file mode 100644 index bf91c0c9..00000000 --- a/introspection/mm-modem-cdma.xml +++ /dev/null @@ -1,97 +0,0 @@ - - - - - - - - Get the current signal quality. - - - - - - Signal quality (percent). - - - - - - - Get the Electronic Serial Number of the card. - - - - - - The ESN. - - - - - - - Get the Service System details of the current network, if registered. - - - - - - A structure containing the Band Class (0 = unknown, 1 = 800 MHz, 2 = 1900 MHz), the Band ("A" - "F" as defined by IS707-A), and the System ID of the serving network. - - - - - - - The signal quality changed. - - - - The new quality in percent, 0..100. - - - - - - Get device registration state. - - - - CDMA 1x registration state. - - - EVDO registration state. - - - - - - The device registration state changed. - - - 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. - - - - - - diff --git a/introspection/mm-modem-gsm-card.xml b/introspection/mm-modem-gsm-card.xml deleted file mode 100644 index d4811576..00000000 --- a/introspection/mm-modem-gsm-card.xml +++ /dev/null @@ -1,135 +0,0 @@ - - - - - - - Get the IMEI of the card. - - - - - - The IMEI. - - - - - - - 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 (or PUK) 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. - - - - - - Bands supported by the card. (Note for plugin writers: - returned value must not contain ANY) - - - - - - Network selection modes supported by the card. (Note for plugin writers: - returned value must not contain ANY) - - - - - diff --git a/introspection/mm-modem-gsm-contacts.xml b/introspection/mm-modem-gsm-contacts.xml deleted file mode 100644 index 60b06ad4..00000000 --- a/introspection/mm-modem-gsm-contacts.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - Add a new contact to the SIM card. - - - - - - The name of the contact. - - - - - The phone number of the contact. - - - - - The index of the new contact. - - - - - - - Delete a contact from the SIM card. - - - - - - The index of the contact. - - - - - - - Retrieve a contact from the SIM card. - - - - - - The index of the contact. - - - - - The contact structure containing index, name, and number. - - - - - - - List all contacts on the SIM card. - - - - - - The list of contacts where each contact has an index, name, and number. - - - - - - - Find a contact from the SIM card. - - - - - - The pattern to search for. - - - - - The list of matching contacts where a contact has an index, name, and number. - - - - - - - Get the number of contacts stored on the SIM card. - - - - - - The number of contacts. - - - - - - diff --git a/introspection/mm-modem-gsm-hso.xml b/introspection/mm-modem-gsm-hso.xml deleted file mode 100644 index d646acc3..00000000 --- a/introspection/mm-modem-gsm-hso.xml +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - Authenticate using the passed user name and password. - - - - - The user name. - - - The password. - - - - diff --git a/introspection/mm-modem-gsm-network.xml b/introspection/mm-modem-gsm-network.xml deleted file mode 100644 index 7c266818..00000000 --- a/introspection/mm-modem-gsm-network.xml +++ /dev/null @@ -1,340 +0,0 @@ - - - - - - - Register the device to network. - - - - - - The network ID 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 access technology used by - this mobile network as described in 3GPP TS 27.007 section 7.3. - e.g. "0" (GSM), "1" (GSM Compact), "2" (UTRAN/UMTS), "3" (EDGE), - etc. -
    • -
- - - - - - - Set the APN. - - - - - - The APN. - - - - - - - Get the current signal quality. - - - - - - Signal quality (percent). - - - - - - - Sets the band the device is allowed to use when connecting to a mobile network. - - - - - - The desired band. Only one band may be specified, and may not be UNKNOWN. - - - - - - - Returns the current band the device is using. (Note for plugin writers: returned value must not be ANY) - - - - - - The current band. - - - - - - - Set the desired mode the device may use when connecting to a mobile - network (DEPRECATED; see SetAllowedMode instead). - - - - - - The desired network mode. Only one mode may be specified, and may not be UNKNOWN. - - - - - - - Returns the current network mode of the device (DEPRECATED; does not - allow returning both the saved mode preference *and* the current access - technology of the device at the same time. See the AllowedMode - property instead). - - - - - - Returns the general network mode (ex. 2G/3G preference) of the device. - - - - - - - Get the registration status and the current operator (if registered). - - - - - - The returned information is composed of the following items in the - following order: -
    -
  • - Mobile registration status as defined in 3GPP TS 27.007 section - 10.1.19. See the MM_MODEM_GSM_NETWORK_REG_STATUS enumeration for - possible values. -
    • -
  • - 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. If the MCC and MNC - are not known or the mobile is not registered to a mobile network, - this value should be a zero-length (blank) string. e.g. "31026" - or "310260". -
    • -
  • - 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 value should - be a zero-length (blank) string. -
    • -
- - - - - - - Set the access technologies a device is allowed to use when connecting - to a mobile network. - - - - - - The allowed mode. The device may not support all modes; see - the org.freedesktop.ModemManager.Gsm.Card.SupportedModes property for - allowed modes for each device. All devices support the "ANY" flag. - - - - - - - The allowed access technologies (eg 2G/3G preference) the device is allowed - to use when connecting to a mobile network. - - - - - - The current network access technology used by the device to communicate - with the base station. (Note to plugin writers: if the device's access - technology cannot be determined, use UNKNOWN) - - - - - - The signal quality changed. - - - - The new quality in percent, 0..100. - - - - - - - The registration status changed. - - - - 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. If the MCC and MNC - are not known or the mobile is not registered to a mobile network, - this value should be a zero-length (blank) string. e.g. "31026" or - "310260". - - - - - 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 value should - be a zero-length (blank) string. - - - - - - - The network mode preference changed. (DEPRECATED; see documentation - for GetNetworkMode/SetNetworkMode) - - - The new network mode. - - - - - - 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. - - - - - - - DEPRECATED; should not be used in new applications. Use - AccessTechnology, AllowedMode, and SetAllowedMode() instead. - - - Any network mode can be used - - - GPRS - - - EDGE - - - UMTS (3G) - - - HSDPA - - - Prefer 2G (GPRS or EDGE) - - - Prefer 3G (UMTS/HSDPA/HSUPA/HSPA) - - - Use only 2G (GPRS or EDGE) - - - Use only 3G (UMTS/HSDPA/HSUPA/HSPA) - - - HSUPA - - - HSPA (HSDPA + HSUPA) - - - - - diff --git a/introspection/mm-modem-gsm-sms.xml b/introspection/mm-modem-gsm-sms.xml deleted file mode 100644 index 081ecc5a..00000000 --- a/introspection/mm-modem-gsm-sms.xml +++ /dev/null @@ -1,156 +0,0 @@ - - - - - - - Delete an SMS message. - - - - - - The index of the SMS. - - - - - - - Retrieve an SMS from the SIM card. - - - - - - The index of the SMS. - - - - - A dictionary containing SMS properties of the SMS specified by the given index. This dictionary may contain the following key/value pairs: - - number : string - Phone number (mandatory) - text : string - SMS text (mandatory) - smsc : string - SMS service center number (optional) - validity : uint (0..255) - Specifies when the SMS expires in SMSC (optional) - class : uint (0..3) - Message importance and location (optional) - completed: boolean - Whether all message parts have been received or not (optional) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - SMS properties to save with the following key values: - - number : string - Phone number (mandatory) - text : string - SMS text (mandatory) - smsc : string - SMS service center number (optional) - validity : uint (0..255) - Specifies when the SMS expires in SMSC (optional) - class : uint (0..3) - Message importance and location (optional) - - - - - - - - - - - SMS properties to save with the following key values: - - number : string - Phone number (mandatory) - text : string - SMS text (mandatory) - smsc : string - SMS service center number (optional) - validity : uint (0..255) - Specifies when the SMS expires in SMSC (optional) - class : uint (0..3) - Message importance and location (optional) - - - - - - - - - - - - - - - - - - - - - - - - Emitted when any part of a new SMS has been received (but not for subsequent parts, if any). Not all parts may have been received and the message may not be complete; if it is, the 'complete' argument will be TRUE. - - - - Index of the new SMS. - - - - - TRUE if all message parts have been received, otherwise FALSE. - - - - - - - Emitted when the complete-ness status of an SMS message changes. An SMS may not necessarily be complete when the first part is received; this signal will be emitted when all parts have been received, even for single-part messages. - - - - The index of the SMS. - - - - - TRUE if all message parts have been received, otherwise FALSE. - - - - - - diff --git a/introspection/mm-modem-gsm-ussd.xml b/introspection/mm-modem-gsm-ussd.xml deleted file mode 100644 index ae6884f0..00000000 --- a/introspection/mm-modem-gsm-ussd.xml +++ /dev/null @@ -1,78 +0,0 @@ - - - - - - - - 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. - - - - - - - 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/introspection/mm-modem-gsm.xml b/introspection/mm-modem-gsm.xml deleted file mode 100644 index ea23adcf..00000000 --- a/introspection/mm-modem-gsm.xml +++ /dev/null @@ -1,164 +0,0 @@ - - - - - - - A bitfield describing the specifc access modes and technologies - supported by a device and the access technology in-use when connected to - a mobile network. - - - Unknown or invalid mode. - - - For certain operations, allow the modem to pick any available mode. - - - GPRS - - - EDGE - - - UMTS (3G) - - - HSDPA (3G) - - - Prefer 2G (GPRS or EDGE) - - - Prefer 3G (UMTS/HSDPA/HSUPA/HSPA) - - - Use only 2G (GPRS or EDGE) - - - Use only 3G (UMTS/HSDPA/HSUPA/HSPA) - - - HSUPA (3G) - - - HSPA (3G) - - - GSM - - - GSM Compact - - - - - - A 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) - - - - - - Describes the device's current access mode preference; ie the specific - technology preferences the device is allowed to use when connecting to - a mobile network. - - - Any mode can be used - - - Prefer 2G (GPRS or EDGE) - - - Prefer 3G (UMTS or HSxPA) - - - Use only 2G (GPRS or EDGE) - - - Use only 3G (UMTS or HSxPA) - - - - - - Describes various access technologies that a device uses when connected - to a mobile network. - - - The access technology used is unknown - - - 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") - - - - - - diff --git a/introspection/mm-modem-location.xml b/introspection/mm-modem-location.xml deleted file mode 100644 index d74f61cd..00000000 --- a/introspection/mm-modem-location.xml +++ /dev/null @@ -1,253 +0,0 @@ - - - - - - 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/introspection/mm-modem-simple.xml b/introspection/mm-modem-simple.xml deleted file mode 100644 index bee1017f..00000000 --- a/introspection/mm-modem-simple.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - Do everything needed to connect the modem. - - - - - - Dictionary of properties needed to get the modem connected. - Each implementation is free to add it's own specific key-value pairs. The predefined - common ones are: - - 'pin' : string - 'network_id' : string - 'band' : uint - 'network_mode' : uint - 'apn' : string - 'number' : string - - - - - - - Get the modem status. - - - - - - Dictionary of properties. - Each implementation is free to add it's own specific key-value pairs. The predefined - common ones are: - - 'state' : uint (always) - 'signal_quality' : uint (state >= registered) - 'operator_code' : string (state >= registered) - 'operator_name' : string (state >= registered) - 'band' : uint (state >= registered) - 'network_mode' : uint (state >= registered) - - - - - diff --git a/introspection/mm-modem.xml b/introspection/mm-modem.xml deleted file mode 100644 index e0cf4bd5..00000000 --- a/introspection/mm-modem.xml +++ /dev/null @@ -1,185 +0,0 @@ - - - - - - - - Enable the device. Initializes the modem. - - - - - - True to enable the device, False to disable. - - - - - - - Dial in. - - - - - - The number to use for dialing. - - - - - - - Disconnect modem. - - - - - - - - Request the IP4 configuration from the device. - Note that it'll only be supported for IPMethod MM_MODEM_IP_METHOD_STATIC. - - - - - Structure containing IP4 address, DNS1, DNS2, DNS3. - The DNS list is padded with 0's if there's less than 3 DNS servers. - - - - - - Get the card information (manufacturer, modem, version). - - - - - - Structure containing manufacturer, model, and version (revision) of the card. - - - - - - - Reset the modem to as close to factory state as possible. - - - - - Carrier-supplied code required to reset the modem. Ignored if not required. - - - - - - The modem port to use for IP configuration and traffic. - - - - - - 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 driver handling the device. - - - - - - The modem type. - - - - - - TRUE if the modem is enabled (ie, powered and usable), FALSE if it is disabled. - - - - - - 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. - - - - - - The IP configuration method. - - - - - - - A GSM device. - - - - - A CDMA device. - - - - - - - - Use PPP to get the address. - - - - - Static configuration, the modem will provide IP information. - - - - - Use DHCP - - - - - - diff --git a/introspection/mm-properties-changed.xml b/introspection/mm-properties-changed.xml deleted file mode 100644 index b2d09236..00000000 --- a/introspection/mm-properties-changed.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - 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/introspection/org.freedesktop.DBus.Properties.xml b/introspection/org.freedesktop.DBus.Properties.xml new file mode 100644 index 00000000..b2d09236 --- /dev/null +++ b/introspection/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/introspection/org.freedesktop.ModemManager.Modem.Gsm.Card.xml b/introspection/org.freedesktop.ModemManager.Modem.Gsm.Card.xml new file mode 100644 index 00000000..d4811576 --- /dev/null +++ b/introspection/org.freedesktop.ModemManager.Modem.Gsm.Card.xml @@ -0,0 +1,135 @@ + + + + + + + Get the IMEI of the card. + + + + + + The IMEI. + + + + + + + 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 (or PUK) 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. + + + + + + Bands supported by the card. (Note for plugin writers: + returned value must not contain ANY) + + + + + + Network selection modes supported by the card. (Note for plugin writers: + returned value must not contain ANY) + + + + + diff --git a/introspection/org.freedesktop.ModemManager.Modem.Gsm.Contacts.xml b/introspection/org.freedesktop.ModemManager.Modem.Gsm.Contacts.xml new file mode 100644 index 00000000..60b06ad4 --- /dev/null +++ b/introspection/org.freedesktop.ModemManager.Modem.Gsm.Contacts.xml @@ -0,0 +1,104 @@ + + + + + + + Add a new contact to the SIM card. + + + + + + The name of the contact. + + + + + The phone number of the contact. + + + + + The index of the new contact. + + + + + + + Delete a contact from the SIM card. + + + + + + The index of the contact. + + + + + + + Retrieve a contact from the SIM card. + + + + + + The index of the contact. + + + + + The contact structure containing index, name, and number. + + + + + + + List all contacts on the SIM card. + + + + + + The list of contacts where each contact has an index, name, and number. + + + + + + + Find a contact from the SIM card. + + + + + + The pattern to search for. + + + + + The list of matching contacts where a contact has an index, name, and number. + + + + + + + Get the number of contacts stored on the SIM card. + + + + + + The number of contacts. + + + + + + diff --git a/introspection/org.freedesktop.ModemManager.Modem.Gsm.Hso.xml b/introspection/org.freedesktop.ModemManager.Modem.Gsm.Hso.xml new file mode 100644 index 00000000..d646acc3 --- /dev/null +++ b/introspection/org.freedesktop.ModemManager.Modem.Gsm.Hso.xml @@ -0,0 +1,19 @@ + + + + + + + Authenticate using the passed user name and password. + + + + + The user name. + + + The password. + + + + diff --git a/introspection/org.freedesktop.ModemManager.Modem.Gsm.Network.xml b/introspection/org.freedesktop.ModemManager.Modem.Gsm.Network.xml new file mode 100644 index 00000000..7c266818 --- /dev/null +++ b/introspection/org.freedesktop.ModemManager.Modem.Gsm.Network.xml @@ -0,0 +1,340 @@ + + + + + + + Register the device to network. + + + + + + The network ID 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 access technology used by + this mobile network as described in 3GPP TS 27.007 section 7.3. + e.g. "0" (GSM), "1" (GSM Compact), "2" (UTRAN/UMTS), "3" (EDGE), + etc. +
    • +
+ + + + + + + Set the APN. + + + + + + The APN. + + + + + + + Get the current signal quality. + + + + + + Signal quality (percent). + + + + + + + Sets the band the device is allowed to use when connecting to a mobile network. + + + + + + The desired band. Only one band may be specified, and may not be UNKNOWN. + + + + + + + Returns the current band the device is using. (Note for plugin writers: returned value must not be ANY) + + + + + + The current band. + + + + + + + Set the desired mode the device may use when connecting to a mobile + network (DEPRECATED; see SetAllowedMode instead). + + + + + + The desired network mode. Only one mode may be specified, and may not be UNKNOWN. + + + + + + + Returns the current network mode of the device (DEPRECATED; does not + allow returning both the saved mode preference *and* the current access + technology of the device at the same time. See the AllowedMode + property instead). + + + + + + Returns the general network mode (ex. 2G/3G preference) of the device. + + + + + + + Get the registration status and the current operator (if registered). + + + + + + The returned information is composed of the following items in the + following order: +
    +
  • + Mobile registration status as defined in 3GPP TS 27.007 section + 10.1.19. See the MM_MODEM_GSM_NETWORK_REG_STATUS enumeration for + possible values. +
    • +
  • + 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. If the MCC and MNC + are not known or the mobile is not registered to a mobile network, + this value should be a zero-length (blank) string. e.g. "31026" + or "310260". +
    • +
  • + 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 value should + be a zero-length (blank) string. +
    • +
+ + + + + + + Set the access technologies a device is allowed to use when connecting + to a mobile network. + + + + + + The allowed mode. The device may not support all modes; see + the org.freedesktop.ModemManager.Gsm.Card.SupportedModes property for + allowed modes for each device. All devices support the "ANY" flag. + + + + + + + The allowed access technologies (eg 2G/3G preference) the device is allowed + to use when connecting to a mobile network. + + + + + + The current network access technology used by the device to communicate + with the base station. (Note to plugin writers: if the device's access + technology cannot be determined, use UNKNOWN) + + + + + + The signal quality changed. + + + + The new quality in percent, 0..100. + + + + + + + The registration status changed. + + + + 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. If the MCC and MNC + are not known or the mobile is not registered to a mobile network, + this value should be a zero-length (blank) string. e.g. "31026" or + "310260". + + + + + 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 value should + be a zero-length (blank) string. + + + + + + + The network mode preference changed. (DEPRECATED; see documentation + for GetNetworkMode/SetNetworkMode) + + + The new network mode. + + + + + + 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. + + + + + + + DEPRECATED; should not be used in new applications. Use + AccessTechnology, AllowedMode, and SetAllowedMode() instead. + + + Any network mode can be used + + + GPRS + + + EDGE + + + UMTS (3G) + + + HSDPA + + + Prefer 2G (GPRS or EDGE) + + + Prefer 3G (UMTS/HSDPA/HSUPA/HSPA) + + + Use only 2G (GPRS or EDGE) + + + Use only 3G (UMTS/HSDPA/HSUPA/HSPA) + + + HSUPA + + + HSPA (HSDPA + HSUPA) + + + + + diff --git a/introspection/org.freedesktop.ModemManager.Modem.Gsm.SMS.xml b/introspection/org.freedesktop.ModemManager.Modem.Gsm.SMS.xml new file mode 100644 index 00000000..081ecc5a --- /dev/null +++ b/introspection/org.freedesktop.ModemManager.Modem.Gsm.SMS.xml @@ -0,0 +1,156 @@ + + + + + + + Delete an SMS message. + + + + + + The index of the SMS. + + + + + + + Retrieve an SMS from the SIM card. + + + + + + The index of the SMS. + + + + + A dictionary containing SMS properties of the SMS specified by the given index. This dictionary may contain the following key/value pairs: + + number : string - Phone number (mandatory) + text : string - SMS text (mandatory) + smsc : string - SMS service center number (optional) + validity : uint (0..255) - Specifies when the SMS expires in SMSC (optional) + class : uint (0..3) - Message importance and location (optional) + completed: boolean - Whether all message parts have been received or not (optional) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + SMS properties to save with the following key values: + + number : string - Phone number (mandatory) + text : string - SMS text (mandatory) + smsc : string - SMS service center number (optional) + validity : uint (0..255) - Specifies when the SMS expires in SMSC (optional) + class : uint (0..3) - Message importance and location (optional) + + + + + + + + + + + SMS properties to save with the following key values: + + number : string - Phone number (mandatory) + text : string - SMS text (mandatory) + smsc : string - SMS service center number (optional) + validity : uint (0..255) - Specifies when the SMS expires in SMSC (optional) + class : uint (0..3) - Message importance and location (optional) + + + + + + + + + + + + + + + + + + + + + + + + Emitted when any part of a new SMS has been received (but not for subsequent parts, if any). Not all parts may have been received and the message may not be complete; if it is, the 'complete' argument will be TRUE. + + + + Index of the new SMS. + + + + + TRUE if all message parts have been received, otherwise FALSE. + + + + + + + Emitted when the complete-ness status of an SMS message changes. An SMS may not necessarily be complete when the first part is received; this signal will be emitted when all parts have been received, even for single-part messages. + + + + The index of the SMS. + + + + + TRUE if all message parts have been received, otherwise FALSE. + + + + + + diff --git a/introspection/org.freedesktop.ModemManager.Modem.Gsm.Ussd.xml b/introspection/org.freedesktop.ModemManager.Modem.Gsm.Ussd.xml new file mode 100644 index 00000000..ae6884f0 --- /dev/null +++ b/introspection/org.freedesktop.ModemManager.Modem.Gsm.Ussd.xml @@ -0,0 +1,78 @@ + + + + + + + + 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. + + + + + + + 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/introspection/org.freedesktop.ModemManager.Modem.Gsm.xml b/introspection/org.freedesktop.ModemManager.Modem.Gsm.xml new file mode 100644 index 00000000..ea23adcf --- /dev/null +++ b/introspection/org.freedesktop.ModemManager.Modem.Gsm.xml @@ -0,0 +1,164 @@ + + + + + + + A bitfield describing the specifc access modes and technologies + supported by a device and the access technology in-use when connected to + a mobile network. + + + Unknown or invalid mode. + + + For certain operations, allow the modem to pick any available mode. + + + GPRS + + + EDGE + + + UMTS (3G) + + + HSDPA (3G) + + + Prefer 2G (GPRS or EDGE) + + + Prefer 3G (UMTS/HSDPA/HSUPA/HSPA) + + + Use only 2G (GPRS or EDGE) + + + Use only 3G (UMTS/HSDPA/HSUPA/HSPA) + + + HSUPA (3G) + + + HSPA (3G) + + + GSM + + + GSM Compact + + + + + + A 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) + + + + + + Describes the device's current access mode preference; ie the specific + technology preferences the device is allowed to use when connecting to + a mobile network. + + + Any mode can be used + + + Prefer 2G (GPRS or EDGE) + + + Prefer 3G (UMTS or HSxPA) + + + Use only 2G (GPRS or EDGE) + + + Use only 3G (UMTS or HSxPA) + + + + + + Describes various access technologies that a device uses when connected + to a mobile network. + + + The access technology used is unknown + + + 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") + + + + + + diff --git a/introspection/org.freedesktop.ModemManager.Modem.Location.xml b/introspection/org.freedesktop.ModemManager.Modem.Location.xml new file mode 100644 index 00000000..d74f61cd --- /dev/null +++ b/introspection/org.freedesktop.ModemManager.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/introspection/org.freedesktop.ModemManager.Modem.Simple.xml b/introspection/org.freedesktop.ModemManager.Modem.Simple.xml new file mode 100644 index 00000000..bee1017f --- /dev/null +++ b/introspection/org.freedesktop.ModemManager.Modem.Simple.xml @@ -0,0 +1,58 @@ + + + + + + + + Do everything needed to connect the modem. + + + + + + Dictionary of properties needed to get the modem connected. + Each implementation is free to add it's own specific key-value pairs. The predefined + common ones are: + + 'pin' : string + 'network_id' : string + 'band' : uint + 'network_mode' : uint + 'apn' : string + 'number' : string + + + + + + + Get the modem status. + + + + + + Dictionary of properties. + Each implementation is free to add it's own specific key-value pairs. The predefined + common ones are: + + 'state' : uint (always) + 'signal_quality' : uint (state >= registered) + 'operator_code' : string (state >= registered) + 'operator_name' : string (state >= registered) + 'band' : uint (state >= registered) + 'network_mode' : uint (state >= registered) + + + + + diff --git a/introspection/org.freedesktop.ModemManager.Modem.xml b/introspection/org.freedesktop.ModemManager.Modem.xml new file mode 100644 index 00000000..e0cf4bd5 --- /dev/null +++ b/introspection/org.freedesktop.ModemManager.Modem.xml @@ -0,0 +1,185 @@ + + + + + + + + Enable the device. Initializes the modem. + + + + + + True to enable the device, False to disable. + + + + + + + Dial in. + + + + + + The number to use for dialing. + + + + + + + Disconnect modem. + + + + + + + + Request the IP4 configuration from the device. + Note that it'll only be supported for IPMethod MM_MODEM_IP_METHOD_STATIC. + + + + + Structure containing IP4 address, DNS1, DNS2, DNS3. + The DNS list is padded with 0's if there's less than 3 DNS servers. + + + + + + Get the card information (manufacturer, modem, version). + + + + + + Structure containing manufacturer, model, and version (revision) of the card. + + + + + + + Reset the modem to as close to factory state as possible. + + + + + Carrier-supplied code required to reset the modem. Ignored if not required. + + + + + + The modem port to use for IP configuration and traffic. + + + + + + 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 driver handling the device. + + + + + + The modem type. + + + + + + TRUE if the modem is enabled (ie, powered and usable), FALSE if it is disabled. + + + + + + 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. + + + + + + The IP configuration method. + + + + + + + A GSM device. + + + + + A CDMA device. + + + + + + + + Use PPP to get the address. + + + + + Static configuration, the modem will provide IP information. + + + + + Use DHCP + + + + + + diff --git a/introspection/org.freedesktop.ModemManager.xml b/introspection/org.freedesktop.ModemManager.xml new file mode 100644 index 00000000..bdeac01b --- /dev/null +++ b/introspection/org.freedesktop.ModemManager.xml @@ -0,0 +1,40 @@ + + + + + + + Get the list of modem devices. + + + + + List of object paths of modem devices known to the system. + + + + + + + A device was added to the system. + + + + The object path of the newly added device. + + + + + + + A device was removed from the system, and is no longer available. + + + + The object path of the device that was just removed. + + + + + + -- cgit v1.2.3-70-g09d2