module.coverage

The module.coverage command is used to acquire a module's cellular coverage. The module can be identified by thingKey, ESN, ICCID, IMEI, IMSI, MEID, or MSISDN. Only one of these identifying fields is required.

TR50 Request

{
  "cmd": {
    "command": "module.coverage",
    "params": {
      "thingKey": "mything",
      "mode": "tr50"
    }
  }
}

Request Parameters

Name Type Required Description
thingKey String Yes* Key of the Thing
thingId String Id of the Thing
esn String Esn of the thing
iccid String Iccid of the thing
imei String Imei of the thing
imsi String Imsi of the thing
meid String Meid of the thing
msisdn String Msisdn of the thing
*One of the above parameters is required to identify the thing.
mode String The mode to send the command ('tr50' or 'sms'). Default is auto.

TR50 Response

If the command is sent successfully a success message is returned and other variable information. Otherwise, an error and error message will be returned.

// 2G example
{
  "cmd": {
    "success": true,
    "params": {
      "afrcn": 100,
      "bsic": 15,
      "rssi": -38,
      "cellId": 8381,
      "lac": 10424,
      "mcc": 425,
      "mnc": 1,
      "ta": 0,
      "networkName": "Orange IL"
    }
  }
}
 
// 3G example
{
    "1": {
        "success": true,
        "params": {
            "cellId": 6013313,
            "dbm": -66,
            "drx": 64,
            "ecio": -8,
            "lac": 33911,
            "mcc": 425,
            "mnc": 2,
            "networkName": "Cellcom IL ",
            "nom": "II",
            "psc": 171,
            "radioTech": "3G",
            "rscp": -74,
            "scr": 2736,
            "sd": 3,
            "uarfcn": 10763
        }
    }
}

Response Parameters

Name Type Description
afrcn Integer Absolute Radio Frequency Channel Number.
bsic Integer Base Station Identity Code.
cellId Integer The Cell ID.
dbm Integer Signal strength in decibel milliwatts.
drx Integer Discontinuous reception cycle length.
ecio Float Ratio of the received energy per chip.
gprs Boolean General packet radio service.
lac Integer Local area connection.
mcc Integer Mobile country code.
mnc String Mobile network code.
networkName Integer The name of the network.
nom String Network Operation Mode.
pat Integer Priority Access Threshold.
psc Integer Primary Scrambling Code.
rac Integer Routing Area Code.
radioTech String The radio transmission technology used: "2G" or "3G".
rscp Integer Received Signal Code Power.
rssi Integer Received Signal Strength Indicator.
sd Integer Service Domain.
ta Integer Time advance.
uarfcn Integer UTRA Absolute Radio Frequency Channel Number.