CellularHelper
Public Member Functions | Data Fields
CellularHelperExtendedQualResponse Class Reference

Response class for the AT+CESQ command. More...

#include <CellularHelper.h>

Inheritance diagram for CellularHelperExtendedQualResponse:
CellularHelperPlusStringResponse CellularHelperCommonResponse

Public Member Functions

void postProcess ()
 Converts the data in string into the broken out fields like rxlev, ber, rsrq, etc.
 
String toString () const
 Converts this object into a string. More...
 
- Public Member Functions inherited from CellularHelperPlusStringResponse
virtual int parse (int type, const char *buf, int len)
 Method to parse the output from the modem. More...
 
String getDoubleQuotedPart (bool onlyFirst=true) const
 Gets the double quoted part of a string response. More...
 
- Public Member Functions inherited from CellularHelperCommonResponse
void logCellularDebug (int type, const char *buf, int len) const
 Used when enableDebug is true to log the Cellular.command callback data using Log.info. More...
 

Data Fields

uint8_t rxlev = 99
 Received Signal Strength Indication (RSSI) More...
 
uint8_t ber = 99
 Bit Error Rate (BER) More...
 
uint8_t rscp = 99
 Received Signal Code Power (RSCP) More...
 
uint8_t ecn0 = 255
 Ratio of received energy per PN chip to the total received power spectral density. More...
 
uint8_t rsrq = 255
 Reference Signal Received Quality (RSRQ) More...
 
uint8_t rsrp = 255
 Reference Signal Received Power (RSRP) More...
 
- Data Fields inherited from CellularHelperPlusStringResponse
String command
 Your subclass must set this to the command requesting (not including the AT+ part) More...
 
String string
 Returned string is stored here.
 
- Data Fields inherited from CellularHelperCommonResponse
int resp = RESP_ERROR
 Response code from Cellular.command. More...
 
bool enableDebug = false
 Enables debug mode (default: false) More...
 

Detailed Description

Response class for the AT+CESQ command.

This class is the result of CellularHelper.getExtendedQual(); you normally wouldn't instantiate one of these directly.

Member Function Documentation

◆ toString()

String CellularHelperExtendedQualResponse::toString ( ) const

Converts this object into a string.

The string will be of the format rxlev=99 ber=99 rscp=255 ecn0=255 rsrq=0 rsrp=37. Unknown values for rxlev, ber, and rscp are 99. Unknown values for ecn0, rsrq, rsrp are 255.

Field Documentation

◆ ber

uint8_t CellularHelperExtendedQualResponse::ber = 99

Bit Error Rate (BER)

Values:

  • 0..7: as the RXQUAL values described in GSM TS 05.08 [28]
  • 99: not known or not detectable

◆ ecn0

uint8_t CellularHelperExtendedQualResponse::ecn0 = 255

Ratio of received energy per PN chip to the total received power spectral density.

Values:

  • 0: -24.5 dB or less
  • 1..48: from -24 dB to -0.5 dBm with 0.5 dB steps
  • 49: 0 dB or greater
  • 255: not known or not detectable

◆ rscp

uint8_t CellularHelperExtendedQualResponse::rscp = 99

Received Signal Code Power (RSCP)

Values:

  • 0: -121 dBm or less
  • 1..95: from -120 dBm to -24 dBm with 1 dBm steps
  • 96: -25 dBm or greater
  • 255: not known or not detectable

◆ rsrp

uint8_t CellularHelperExtendedQualResponse::rsrp = 255

Reference Signal Received Power (RSRP)

Values:

  • 0: -141 dBm or less
  • 1..96: from -140 dBm to -45 dBm with 1 dBm steps
  • 97: -44 dBm or greater
  • 255: not known or not detectable

◆ rsrq

uint8_t CellularHelperExtendedQualResponse::rsrq = 255

Reference Signal Received Quality (RSRQ)

Values:

  • 0: -19 dB or less
  • 1..33: from -19.5 dB to -3.5 dB with 0.5 dB steps
  • 34: -3 dB or greater
  • 255: not known or not detectable Number

◆ rxlev

uint8_t CellularHelperExtendedQualResponse::rxlev = 99

Received Signal Strength Indication (RSSI)

Values:

  • 0: less than -110 dBm
  • 1..62: from -110 to -49 dBm with 1 dBm steps
  • 63: -48 dBm or greater
  • 99: not known or not detectable

The documentation for this class was generated from the following files: