Vodafone K3770/K3772-Z modems driver & networking library

Dependencies:   Socket USBHostWANDongle lwip-sys lwip

Dependents:   VodafoneUSBModemHTTPClientTest VodafoneUSBModemNTPClientTest VodafoneUSBModemSMSTest VodafoneUSBModemUSSDTest ... more

Fork of VodafoneUSBModem_bleedingedge by Donatien Garnier

Embed: (wiki syntax)

« Back to documentation index

LinkMonitor Class Reference

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 ()
 Initialize monitor.
int getState (int *pRssi, REGISTRATION_STATE *pRegistrationState, BEARER *pBearer)
 Get link state.

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.

Registration State.

Enumerator:
REGISTRATION_STATE_UNKNOWN 

Unknown.

REGISTRATION_STATE_REGISTERING 

Registering.

REGISTRATION_STATE_DENIED 

Denied.

REGISTRATION_STATE_NO_SIGNAL 

No Signal.

REGISTRATION_STATE_HOME_NETWORK 

Registered on home network.

REGISTRATION_STATE_ROAMING 

Registered on roaming network.

Definition at line 46 of file LinkMonitor.h.


Constructor & Destructor Documentation

Create LinkMonitor instance.

Parameters:
pIfPointer to the ATCommandsInterface instance to use

Definition at line 34 of file LinkMonitor.cpp.


Member Function Documentation

int getState ( int *  pRssi,
REGISTRATION_STATE pRegistrationState,
BEARER pBearer 
)

Get link state.

Parameters:
pRssipointer 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
pRegistrationStatepointer to store the current registration state
pBearerpointer to store the current bearer
Returns:
0 on success, error code on failure

Definition at line 134 of file LinkMonitor.cpp.

int init (  )

Initialize monitor.

Definition at line 39 of file LinkMonitor.cpp.