This class is used to return the rssi and qual values (AT+CSQ) More...
#include <CellularHelper.h>
Inheritance diagram for CellularHelperRSSIQualResponse:
Public Member Functions | |
| void | postProcess () |
| Parses string and stores the results in rssi and qual. | |
| 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 | |
| int | rssi = 99 |
| RSSI Received Signal Strength Indication value. More... | |
| int | qual = 99 |
| Signal quality value. 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
This class is used to return the rssi and qual values (AT+CSQ)
Note that for 2G, qual is not available and 99 is always returned.
Since it inherits from CellularHelperPlusStringResponse and CellularHelperCommonResponse you can check resp == RESP_OK to make sure the call succeeded.
This class is the result of CellularHelper.getRSSIQual(); you normally wouldn't instantiate one of these directly.
Member Function Documentation
◆ toString()
| String CellularHelperRSSIQualResponse::toString | ( | ) | const |
Converts this object into a string.
The string will be of the format rssi=-50 qual=3. If either value is unknown, it will show as 99.
Field Documentation
◆ qual
| int CellularHelperRSSIQualResponse::qual = 99 |
Signal quality value.
Values:
- 0..7: Signal quality, 0 = good, 7 = bad
- 99: not known or not detectable or currently not available
◆ rssi
| int CellularHelperRSSIQualResponse::rssi = 99 |
RSSI Received Signal Strength Indication value.
Values:
- 0: -113 dBm or less
- 1: -111 dBm
- 2..30: from -109 to -53 dBm with 2 dBm steps
- 31: -51 dBm or greater
- 99: not known or not detectable or currently not available
The documentation for this class was generated from the following files:
- src/CellularHelper.h
- src/CellularHelper.cpp
