Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
LinkMonitor Class Reference
Component to monitor link quality. More...
#include <LinkMonitor.h>
Inherits IATCommandsProcessor.
Public Types | |
| enum | REGISTRATION_STATE { REGISTRATION_STATE_UNKNOWN, REGISTRATION_STATE_REGISTERING, REGISTRATION_STATE_DENIED, REGISTRATION_STATE_NO_SIGNAL, REGISTRATION_STATE_HOME_NETWORK, REGISTRATION_STATE_ROAMING } |
Registration State. More... | |
| enum | BEARER { BEARER_UNKNOWN, BEARER_GSM, BEARER_EDGE, BEARER_UMTS, BEARER_HSPA, BEARER_LTE } |
Bearer type. More... | |
Public Member Functions | |
| LinkMonitor (ATCommandsInterface *pIf) | |
| Create LinkMonitor instance. | |
| int | init (bool gsm=true) |
| Initialize monitor. | |
| int | getState (int *pRssi, REGISTRATION_STATE *pRegistrationState, BEARER *pBearer) |
| Get link state. | |
| int | getPhoneNumber (char *phoneNumber) |
| Get my phone number. | |
Friends | |
| class | ATCommandsInterface |
Detailed Description
Component to monitor link quality.
Definition at line 32 of file LinkMonitor.h.
Member Enumeration Documentation
| enum BEARER |
Bearer type.
- Enumerator:
BEARER_UNKNOWN Unknown.
BEARER_GSM GSM (2G)
BEARER_EDGE EDGE (2.5G)
BEARER_UMTS UMTS (3G)
BEARER_HSPA HSPA (3G+)
BEARER_LTE LTE (4G)
Definition at line 58 of file LinkMonitor.h.
| enum REGISTRATION_STATE |
Registration State.
- Enumerator:
Definition at line 46 of file LinkMonitor.h.
Constructor & Destructor Documentation
| LinkMonitor | ( | ATCommandsInterface * | pIf ) |
Create LinkMonitor instance.
- Parameters:
-
pIf Pointer to the ATCommandsInterface instance to use
Definition at line 34 of file LinkMonitor.cpp.
Member Function Documentation
| int getPhoneNumber | ( | char * | phoneNumber ) |
Get my phone number.
- Parameters:
-
phoneNumber pointer to store the current phoneNumber
- Returns:
- 0 on success, error code on failure
Definition at line 163 of file LinkMonitor.cpp.
| int getState | ( | int * | pRssi, |
| REGISTRATION_STATE * | pRegistrationState, | ||
| BEARER * | pBearer | ||
| ) |
Get link state.
- Parameters:
-
pRssi pointer to store the current RSSI in dBm, between -51 dBm and -113 dBm if known; -51 dBm means -51 dBm or more; -113 dBm means -113 dBm or less; 0 if unknown pRegistrationState pointer to store the current registration state pBearer pointer to store the current bearer
- Returns:
- 0 on success, error code on failure
Definition at line 147 of file LinkMonitor.cpp.
| int init | ( | bool | gsm = true ) |
Initialize monitor.
Definition at line 39 of file LinkMonitor.cpp.
Generated on Tue Jul 12 2022 17:35:11 by
1.7.2