ModemManager::Modem Class

Member Function Documentation

[explicit] Modem::Modem(const QString &path, QObject *parent = nullptr)

ModemManager::Modem::AccessTechnologies Modem::accessTechnologies() const

Returns QFlags of MMModemAccessTechnology values, specifying the current network access technologies used by the device to communicate with the network.

If the device's access technology cannot be determined, MM_MODEM_ACCESS_TECHNOLOGY_UNKNOWN will be reported.

[signal] void Modem::accessTechnologiesChanged(QFlags<MMModemAccessTechnology> accessTechnologies)

[signal] void Modem::bearerAdded(const QString &bearer)

[signal] void Modem::bearerRemoved(const QString &bearer)

[signal] void Modem::bearersChanged()

QDBusPendingReply<QString> Modem::command(const QString &cmd, uint timeout)

QDBusPendingReply<QDBusObjectPath> Modem::createBearer(const ModemManager::BearerProperties &bearerProperties)

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.

QList<MMModemBand> Modem::currentBands() const

Returns List of MMModemBand values, specifying the radio frequency and technology bands the device is currently using when connecting to a network.

It must be a subset of supportedBands()

See also setCurrentBands().

[signal] void Modem::currentBandsChanged(const QList<MMModemBand> &supportedBands)

ModemManager::Modem::Capabilities Modem::currentCapabilities() const

Returns QFlags of MMModemCapability values, specifying the generic family of access technologies the modem currently supports without a firmware reload or reinitialization.

See also setCurrentCapabilities().

[signal] void Modem::currentCapabilitiesChanged(const QFlags<MMModemCapability> &currentCapabilities)

ModemManager::CurrentModesType Modem::currentModes() const

Returns A pair of MMModemMode values, where the first one is a bitmask specifying the access technologies (eg 2G/3G/4G) the device is currently allowed to use when connecting to a network, and the second one is the preferred mode of those specified as allowed.

The pair must be one of those specified in supportedModes()

See also setCurrentModes().

[signal] void Modem::currentModesChanged(ModemManager::CurrentModesType currentModes)

QDBusPendingReply<void> Modem::deleteBearer(const QString &bearer)

Delete an existing packet data bearer.

If the bearer is currently active and providing packet data server, it will be disconnected and that packet data service will terminate.

bearer path to the bearer to delete

QString Modem::device() const

Returns 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.

[signal] void Modem::deviceChanged(const QString &device)

QString Modem::deviceIdentifier() const

Returns 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.

[signal] void Modem::deviceIdentifierChanged(const QString &deviceIdentifier)

QStringList Modem::drivers() const

Returns The Operating System device drivers handling communication with the modem hardware.

[signal] void Modem::driversChanged(const QStringList &drivers)

QString Modem::equipmentIdentifier() const

Returns The identity of the device.

This will be the IMEI number for GSM devices and the hex-format ESN/MEID for CDMA devices.

[signal] void Modem::equipmentIdentifierChanged(const QString &equipmentIdentifier)

QDBusPendingReply<void> Modem::factoryReset(const QString &code)

Clear the modem's configuration (including persistent configuration and state), and return the device to a factory-default state.

If not required by the modem, code may be ignored.

This command may or may not power-cycle the device.

code Carrier-supplied code required to reset the modem.

ModemManager::Bearer::Ptr Modem::findBearer(const QString &bearer) const

Returns the configured packet data bearer on given path

bool Modem::isEnabled() const

Returns true if the modem is fully functional, false when in low power mode or disabled

See also setEnabled().

bool Modem::isValid() const

ModemManager::Bearer::List Modem::listBearers() const

Returns the configured packet data bearers (EPS Bearers, PDP Contexts, or CDMA2000 Packet Data Sessions).

QString Modem::manufacturer() const

Returns The equipment manufacturer, as reported by the modem.

[signal] void Modem::manufacturerChanged(const QString &manufacturer)

uint Modem::maxActiveBearers() const

Returns 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.

[signal] void Modem::maxActiveBearersChanged(uint maxActiveBearers)

uint Modem::maxBearers() const

Returns 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.

[signal] void Modem::maxBearersChanged(uint maxBearers)

QString Modem::model() const

Returns The equipment model, as reported by the modem.

[signal] void Modem::modelChanged(const QString &model)

QStringList Modem::ownNumbers() const

Returns List of numbers (e.g. MSISDN in 3GPP) being currently handled by this modem.

[signal] void Modem::ownNumbersChanged(const QStringList &ownNumbers)

QString Modem::plugin() const

Returns The name of the plugin handling this modem.

[signal] void Modem::pluginChanged(const QString &plugin)

[since 1.1.94] ModemManager::PortList Modem::ports() const

Returns The list of ports in the modem, given as an array of string and unsigned integer pairs. The string is the port name or path, and the integer is the port type given as a MMModemPortType value.

This function was introduced in 1.1.94.

[signal] void Modem::portsChanged(const ModemManager::PortList &ports)

MMModemPowerState Modem::powerState() const

Returns A MMModemPowerState value specifying the current power state of the modem.

See also setPowerState().

[signal] void Modem::powerStateChanged(MMModemPowerState powerState)

QString Modem::primaryPort() const

Returns The name of the primary port using to control the modem.

[signal] void Modem::primaryPortChanged(const QString &primaryPort)

QDBusPendingReply<void> Modem::reset()

Clear non-persistent configuration and state, and return the device to a newly-powered-on state.

This command may power-cycle the device.

QString Modem::revision() const

Returns The revision identification of the software, as reported by the modem.

[signal] void Modem::revisionChanged(const QString &revision)

QDBusPendingReply<void> Modem::setCurrentBands(const QList<MMModemBand> &bands)

Set the radio frequency and technology bands the device is currently allowed to use when connecting to a network.

bands List of MMModemBand values, to specify the bands to be used.

See also currentBands().

QDBusPendingReply<void> Modem::setCurrentCapabilities(ModemManager::Modem::Capabilities caps)

Set the capabilities of the device. A restart of the modem may be required.

caps QFlags of MMModemCapability values, to specify the capabilities to use.

See also currentCapabilities().

QDBusPendingReply<void> Modem::setCurrentModes(const ModemManager::CurrentModesType &mode)

Set the access technologies (e.g. 2G/3G/4G preference) the device is currently allowed to use when connecting to a network.

The given combination should be supported by the modem, as specified in supportedModes()

See also currentModes().

QDBusPendingReply<void> Modem::setEnabled(bool enable)

Enable or disable 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.

See also isEnabled().

QDBusPendingReply<void> Modem::setPowerState(MMModemPowerState state)

Set the power state of the modem. This action can only be run when the modem is in MM_MODEM_STATE_DISABLED state.

See also powerState().

void Modem::setTimeout(int timeout)

Sets the timeout in milliseconds for all async method DBus calls. -1 means the default DBus timeout (usually 25 seconds).

See also timeout().

ModemManager::SignalQualityPair Modem::signalQuality() const

Returns 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 additional boolean value indicates if the quality value given was recently taken.

[signal] void Modem::signalQualityChanged(ModemManager::SignalQualityPair signalQuality)

QString Modem::simPath() const

Returns The path of the SIM object available in this device, if any.

[signal] void Modem::simPathChanged(const QString &oldPath, const QString &newPath)

MMModemState Modem::state() const

Returns Overall state of the modem, given as a MMModemState value.

If the device's state cannot be determined, MM_MODEM_STATE_UNKNOWN will be reported.

[signal] void Modem::stateChanged(MMModemState oldState, MMModemState newState, MMModemStateChangeReason reason)

MMModemStateFailedReason Modem::stateFailedReason() const

Returns Error specifying why the modem is in MM_MODEM_STATE_FAILED state, given as a MMModemStateFailedReason value.

[signal] void Modem::stateFailedReasonChanged(MMModemStateFailedReason stateFailedReason)

QList<MMModemBand> Modem::supportedBands() const

Returns List of MMModemBand values, specifying the radio frequency and technology bands supported by the device.

For POTS devices, only the MM_MODEM_BAND_ANY mode will be returned.

[signal] void Modem::supportedBandsChanged(const QList<MMModemBand> &supportedBands)

QList<MMModemCapability> Modem::supportedCapabilities() const

Returns List of MMModemCapability values, specifying the combinations of generic family of access technologies the modem supports.

If the modem doesn't allow changing the current capabilities, a single entry with MM_MODEM_CAPABILITY_ANY will be given.

[signal] void Modem::supportedCapabilitiesChanged(const QList<MMModemCapability> &supportedCapabilities)

ModemManager::Modem::IpBearerFamilies Modem::supportedIpFamilies() const

Returns QFlags of MMBearerIpFamily values, specifying the IP families supported by the device.

[signal] void Modem::supportedIpFamiliesChanged(QFlags<MMBearerIpFamily> supportedIpFamilies)

ModemManager::SupportedModesType Modem::supportedModes() const

Returns This property exposes the supported mode combinations, given as an list of unsigned integer pairs, where: The first integer is a bitmask of MMModemMode values, specifying the allowed modes. The second integer is a single MMModemMode, which specifies the preferred access technology, among the ones defined in the allowed modes.

[signal] void Modem::supportedModesChanged(ModemManager::SupportedModesType supportedModes)

int Modem::timeout() const

Returns the current value of the DBus timeout in milliseconds. -1 means the default DBus timeout (usually 25 seconds).

See also setTimeout().

QString Modem::uni() const

MMModemLock Modem::unlockRequired() const

Returns Current lock state of the device, given as a MMModemLock value.

[signal] void Modem::unlockRequiredChanged(MMModemLock unlockRequired)

ModemManager::UnlockRetriesMap Modem::unlockRetries() const

Returns A dictionary in which the keys are MMModemLock flags, and the values are integers giving the number of PIN tries remaining before the code becomes blocked (requiring a PUK) or permanently blocked. Dictionary entries exist only for the codes for which the modem is able to report retry counts.

[signal] void Modem::unlockRetriesChanged(const ModemManager::UnlockRetriesMap &unlockRetries)