CellularHelper
Public Member Functions | Data Fields
CellularHelperCREGResponse Class Reference

Reponse class for the AT+CREG? command. This is deprecated and will be removed in the future. More...

#include <CellularHelper.h>

Inheritance diagram for CellularHelperCREGResponse:
CellularHelperPlusStringResponse CellularHelperCommonResponse

Public Member Functions

bool isValid () const
 Returns true if the results were returned from the modem.
 
void postProcess ()
 Converts the data in string into the broken out fields like stat, lac, ci, rat.
 
String toString () const
 Converts this object into a readable string.
 
- 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

bool valid = false
 Set to true if the values have been set.
 
int stat = 0
 Network connection status. More...
 
int lac = 0xFFFF
 Two bytes location area code or tracking area code.
 
int ci = 0xFFFFFFFF
 Cell Identifier (CI)
 
int rat = 0
 Radio access technology (RAT), the AcTStatus value in the response. 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

Reponse class for the AT+CREG? command. This is deprecated and will be removed in the future.

This class is returned from CelluarHelper.getCREG(). You normally won't instantiate one of these directly.

Field Documentation

◆ rat

int CellularHelperCREGResponse::rat = 0

Radio access technology (RAT), the AcTStatus value in the response.

  • 0: GSM
  • 1: GSM COMPACT
  • 2: UTRAN
  • 3: GSM with EDGE availability
  • 4: UTRAN with HSDPA availability
  • 5: UTRAN with HSUPA availability
  • 6: UTRAN with HSDPA and HSUPA availability
  • 7: E-UTRAN
  • 255: the current AcTStatus value is invalid

◆ stat

int CellularHelperCREGResponse::stat = 0

Network connection status.

  • 0: not registered, the MT is not currently searching a new operator to register to
  • 1: registered, home network
  • 2: not registered, but the MT is currently searching a new operator to register to
  • 3: registration denied
  • 4: unknown (e.g. out of GERAN/UTRAN/E-UTRAN coverage)
  • 5: registered, roaming
  • 6: registered for "SMSonly", home network(applicable only when AcTStatus indicates E-UTRAN)
  • 7: registered for "SMSonly",roaming (applicable only when AcTStatus indicates E-UTRAN)
  • 9: registered for "CSFBnotpreferred",home network(applicable only when AcTStatus indicates E-UTRAN)
  • 10 :registered for" CSFBnotpreferred",roaming (applicable only when AcTStatus indicates E-UTRAN)

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