ModemManager::ModemCdma Class

class ModemManager::ModemCdma

The ModemCdma class. More...

Header: #include <ModemManagerQt/ModemCdma>
CMake: find_package(KF6 REQUIRED COMPONENTS ModemManagerQt)
target_link_libraries(mytarget PRIVATE KF6::ModemManagerQt)
Inherits: ModemManager::Interface

Public Types

Public Functions

ModemCdma(const QString &path, QObject *parent = nullptr)
QDBusPendingReply<void> activate(const QString &carrierCode)
QDBusPendingReply<void> activateManual(const QVariantMap &properties)
MMModemCdmaActivationState activationState() const
MMModemCdmaRegistrationState cdma1xRegistrationState() const
QString esn() const
MMModemCdmaRegistrationState evdoRegistrationState() const
QString meid() const
uint nid() const
void setTimeout(int timeout)
uint sid() const
int timeout() const

Signals

void activationStateChanged(MMModemCdmaActivationState state, MMCdmaActivationError error, const QVariantMap &status_changes)
void cdma1xRegistrationStateChanged(MMModemCdmaRegistrationState cdma1xRegistrationState)
void esnChanged(const QString &esn)
void evdoRegistrationStateChanged(MMModemCdmaRegistrationState evdoRegistrationState)
void meidChanged(const QString &meid)
void nidChanged(uint nid)
void sidChanged(uint sid)

Detailed Description

This class provides access to specific actions that may be performed in modems with CDMA capabilities.

Member Type Documentation

ModemCdma::List

ModemCdma::Ptr

Member Function Documentation

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

QDBusPendingReply<void> ModemCdma::activate(const QString &carrierCode)

Provisions the modem for use with a given carrier using the modem's Over-The-Air (OTA) activation functionality, if any.

Some modems will reboot after this call is made.

carrierCode name of carrier, or carrier-specific code

QDBusPendingReply<void> ModemCdma::activateManual(const QVariantMap &properties)

Sets the modem provisioning data directly, without contacting the carrier over the air.

Some modems will reboot after this call is made.

properties QVariantMap consisting of:

"spc": The Service Programming Code, given as a string of exactly 6 digit characters. Mandatory parameter. "sid": The System Identification Number, given as a 16-bit unsigned integer (signature "q"). Mandatory parameter. "mdn": The Mobile Directory Number, given as a string of maximum 15 characters. Mandatory parameter. "min": The Mobile Identification Number, given as a string of maximum 15 characters. Mandatory parameter. "mn-ha-key": The MN-HA key, given as a string of maximum 16 characters. "mn-aaa-key": The MN-AAA key, given as a string of maximum 16 characters. "prl": The Preferred Roaming List, given as an array of maximum 16384 bytes.

MMModemCdmaActivationState ModemCdma::activationState() const

Returns a MMModemCdmaActivationState value specifying the state of the activation in the 3GPP2 network.

[signal] void ModemCdma::activationStateChanged(MMModemCdmaActivationState state, MMCdmaActivationError error, const QVariantMap &status_changes)

This signal is emitted when the activation info this network changes

state current activation state, given as a MMModemCdmaActivationState.

error carrier-specific error code, given as a MMCdmaActivationError.

status_changes properties that have changed as a result of this activation state change, including "mdn" and "min". The map may be empty if the changed properties are unknown.

MMModemCdmaRegistrationState ModemCdma::cdma1xRegistrationState() const

Returns a MMModemCdmaRegistrationState value specifying the CDMA 1x registration state.

[signal] void ModemCdma::cdma1xRegistrationStateChanged(MMModemCdmaRegistrationState cdma1xRegistrationState)

QString ModemCdma::esn() const

Returns the modem's Electronic Serial Number (superseded by MEID but still used by older devices).

[signal] void ModemCdma::esnChanged(const QString &esn)

MMModemCdmaRegistrationState ModemCdma::evdoRegistrationState() const

Returns a MMModemCdmaRegistrationState value specifying the EVDO registration state.

[signal] void ModemCdma::evdoRegistrationStateChanged(MMModemCdmaRegistrationState evdoRegistrationState)

QString ModemCdma::meid() const

Returns the modem's Mobile Equipment Identifier.

[signal] void ModemCdma::meidChanged(const QString &meid)

uint ModemCdma::nid() const

Returns the Network Identifier of the serving CDMA 1x network, if known, and if the modem is registered with a CDMA 1x network.

[signal] void ModemCdma::nidChanged(uint nid)

void ModemCdma::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().

uint ModemCdma::sid() const

Returns the System Identifier of the serving CDMA 1x network, if known, and if the modem is registered with a CDMA 1x network.

See also http://ifast.org, or, the, mobile, broadband, provider, database, for, mappings, of, SIDs, to, network, and providers.

[signal] void ModemCdma::sidChanged(uint sid)

int ModemCdma::timeout() const

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

See also setTimeout().