Get LTE Network Information (Coming Soon)
Read a device's LTE network information to diagnose connectivity quality, network registration, and field communication problems.
Capability preview
This endpoint is not yet available. The content below introduces the planned use case. The documentation published with the endpoint will define the final contract.
Planned Response Fields
The endpoint will use the standard response envelope. The fields below are inside data. Except for deviceId, systemMode, and collectedAt, a field may be null or omitted when the device is not registered, has no service, or the module does not support the corresponding value.
| Field | Type | Required | Description |
|---|---|---|---|
deviceId | string | Yes | Device ID |
systemMode | string | Yes | Current network technology; see the enum below |
operationMode | string | No | Current cellular-module operating mode; see the enum below |
registrationStatus | string | No | LTE registration status; see the enum below |
mcc | string | No | Mobile Country Code with leading zeros preserved |
mnc | string | No | Mobile Network Code with leading zeros preserved |
trackingAreaCode | string | No | LTE Tracking Area Code as a hexadecimal string without the 0x prefix |
servingCellId | string | No | Current serving-cell ID; represented as a string to avoid integer precision loss |
physicalCellId | integer | No | LTE Physical Cell ID |
currentBand | integer | No | Current LTE band number; for example, Band 3 is returned as 3 |
earfcn | integer | No | E-UTRA Absolute Radio Frequency Channel Number |
signal | object | No | Currently available signal measurements |
signal.csq | integer | No | Module signal-quality level from 0 to 31; 99 means unknown or undetectable |
signal.bitErrorRateLevel | integer | No | Bit-error-rate level from 0 to 7; 99 means unknown |
signal.rsrpDbm | number | No | LTE Reference Signal Received Power in dBm |
signal.rsrqDb | number | No | LTE Reference Signal Received Quality in dB |
signal.rssiDbm | number | No | Received Signal Strength Indicator in dBm |
collectedAt | string | Yes | Data collection time in RFC3339 UTC |
csq is a discrete level defined by the module, not a percentage. Clients must not interpret 99 as a strong signal and should not assess connection quality from a single signal measurement.
operationMode describes the cellular module's operating mode. It is not the same as the online or offline state of an OpenAPI device object. Use status from the device endpoint or WebSocket connection events to determine device connectivity.
systemMode
| Value | Description |
|---|---|
NO_SERVICE | No network service is currently available |
GSM | Current network technology is GSM |
WCDMA | Current network technology is WCDMA |
LTE | Current network technology is LTE |
operationMode
| Value | Description |
|---|---|
UNKNOWN | The module did not provide a recognized operating mode |
ONLINE | Normal online mode |
OFFLINE | Offline mode |
FACTORY_TEST | Factory test mode |
RESET | Reset in progress |
LOW_POWER | Low-power mode |
FLIGHT | Flight mode |
registrationStatus
| Value | Description |
|---|---|
NOT_REGISTERED | Not registered and not currently searching for a network |
REGISTERED_HOME | Registered on the home network |
SEARCHING | Searching for or attempting to register on a network |
DENIED | Network registration was denied |
UNKNOWN | Registration status is unknown or currently outside coverage |
REGISTERED_ROAMING | Registered on a roaming network |
SMS_ONLY_HOME | SMS-only service on the home network |
SMS_ONLY_ROAMING | SMS-only service on a roaming network |
EMERGENCY_ONLY | Emergency bearer services only |
The information available may differ by device, cellular module, or firmware. The released endpoint will not use 0 or an empty string in place of data that the module did not return.
Planned Usage
This capability is primarily intended for:
- Diagnosing device connectivity problems
- Showing the latest cellular-network state in operational interfaces
- Comparing network information before and after a device goes offline
- Confirming the current state before a network-configuration operation
Callers only need to process the standardized fields returned by OpenAPI.
Data Freshness
Device network information may come from the most recent device report or from an active platform query. The released endpoint will explicitly document:
- How and when the data is updated
- Behavior when a device is offline
- Rate limits, timeouts, and retry rules for active queries
Field Basis
The fields above are based on official SIMCom A76XX definitions for network system, LTE registration, cell, and signal measurements. OpenAPI will normalize enum names, convert signal units, and handle missing values without exposing raw vendor codes to callers.
Vendor fields omitted from the first response version will not be promised before implementation. For example, signal values whose units cannot be converted reliably and bandwidth codes that describe only internal module configuration will not be added as inferred values.