getModemDetail.lua
[INDEX]

ABSTRACT

Get detailed status information of the current wireless modem device (WWan)

ARGUMENTS

HTTP Arguments submit: GET; POST

Test this API over HTTP - (URL):

DeviceName

Modem device name,Device is this. (Device name can got by getNetInterface.lua)

Test value:

RETURNS

Return a JSON style result. The JSON format is:

{
/*OBJECT*/

"Result":
NUMBER

200 means OK, other error code meanings are similar to HTTP Response.

"Status":
"STRING"

Status message. Responsing result status of API executive, if there errors, it will describe reasons.

"Data": {
/*OBJECT*/

"3gppInfo": {
/*OBJECT*/

SIM info

"Imei":
"STRING"

The IMEI of the device

"RegistrationState":
INTEGER

A MMModem3gppRegistrationState value specifying the mobile registration status as defined in 3GPP

0

Not registered, not searching for new operator to register

1

Registered on home network

2

Not registered, searching for new operator to register with

3

Registration denied

4

Unknown registration status

5

Registered on a roaming network

"OperatorName":
"STRING"

Name of the operator to which the mobile is currently registered.

"OperatorCode":
INTEGER

Code of the operator to which the mobile is currently registered.

"EnabledFacilityLocks":
INTEGER

Bitmask of MMModem3gppFacility values for which PIN locking is enabled.

0

No facility

1 << 0

SIM lock

1 << 1

Fixed dialing (PIN2) SIM lock

1 << 2

Device is locked to a specific SIM

1 << 3

Device is locked to first SIM inserted

1 << 4

Network personalization

1 << 5

Network subset personalization

1 << 6

Service provider personalization

1 << 7

Corporate personalization

"ModemObj":
/*OBJECT*/

The path of the Modem object available in this device

"ModemInfo": {
/*OBJECT*/

Modeminfo

"Sim":
"STRING"

The path of the SIM object available in this device

"CurrentCapabilities":
INTEGER

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

0

Modem has no capabilities

1 << 0

Modem supports the analog wired telephone network (ie 56k dialup) and does not have wireless/cellular capabilities.

1 << 1

Modem supports at least one of CDMA 1xRTT, EVDO revision 0, EVDO revision A, or EVDO revision B.

1 << 2

Modem supports at least one of GSM, GPRS, EDGE, UMTS, HSDPA, HSUPA, or HSPA+ packet switched data capability.

1 << 3

Modem has LTE data capability.

1 << 4

Modem has LTE Advanced data capability.

1 << 5

Modem has Iridium capabilities.

0xFFFFFFFF

Mask specifying all capabilities

"MaxBearers":
INTEGER

The maximum number of defined packet data bearers the modem supports.

"MaxActiveBearers":
INTEGER

The maximum number of active MM_BEARER_TYPE_DEFAULT bearers that may be explicitly enabled by the user.

"Manufacturer":
"STRING"

The equipment manufacturer, as reported by the modem.

"Model":
"STRING"

The equipment model, as reported by the modem.

"Revision":
"STRING"

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

"DeviceIdentifier":
"STRING"

A best-effort device identifier based on various device information like model name, firmware revision, USB/PCI/PCMCIA IDs, and other properties.

"Device":
"STRING"

The physical modem device reference (ie, USB, PCI, PCMCIA device), which may be dependent upon the operating system.

"Drivers":
"STRING"

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

"Plugin":
"STRING"

The name of the plugin handling this modem.

"PrimaryPort":
"STRING"

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

"EquipmentIdentifier":
"STRING"

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

"UnlockRequired":
"STRING"

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

"UnlockRetries":
"STRING"

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.

"State":
INTEGER

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

-1

The modem is unusable.

0

State unknown or not reportable.

1

The modem is currently being initialized.

2

The modem needs to be unlocked.

3

The modem is not enabled and is powered down.

4

The modem is currently transitioning to the MM_MODEM_STATE_DISABLED state.

5

The modem is currently transitioning to the MM_MODEM_STATE_ENABLED state.

6

The modem is enabled and powered on but not registered with a network provider and not available for data connections.

7

The modem is searching for a network provider to register with.

8

The modem is registered with a network provider, and data connections and messaging may be available for use.

9

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

10

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 t

11

One or more packet data bearers is active and connected.

"StateFailedReason":
"STRING"

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

"AccessTechnologies":
INTEGER

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

0

The access technology used is unknown

1 << 0

Analog wireline telephone

1 << 1

GSM

1 << 2

Compact GSM

1 << 3

GPRS

1 << 4

EDGE (ETSI 27.007: "GSM w/EGPRS")

1 << 5

UMTS (ETSI 27.007: "UTRAN")

1 << 6

HSDPA (ETSI 27.007: "UTRAN w/HSDPA")

1 << 7

HSUPA (ETSI 27.007: "UTRAN w/HSUPA")

1 << 8

HSPA (ETSI 27.007: "UTRAN w/HSDPA and HSUPA")

1 << 9

HSPA+ (ETSI 27.007: "UTRAN w/HSPA+")

1 << 10

CDMA2000 1xRTT

1 << 11

CDMA2000 EVDO revision 0

1 << 12

CDMA2000 EVDO revision A

1 << 13

CDMA2000 EVDO revision B

1 << 14

LTE (ETSI 27.007: "E-UTRAN")

0xFFFFFFFF

Mask specifying all access technologies

"SignalQuality":
"STRING"

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.

"OwnNumbers":
"STRING"

List of numbers being currently handled by this modem.

"PowerState":
"STRING"

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

"SupportedModes":
"STRING"

This property exposes the supported mode combinations, given as an array 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.

"CurrentModes":
"STRING"

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.

"SupportedBands":
"STRING"

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

"CurrentBands":
"STRING"

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

"SupportedIpFamilies":
"STRING"

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

}
}
}
}

OTHER NOTES

KILOVIEW Device HTTP API, v1.0