Donatien Garnier / VodafoneUSBModem

Dependencies:   Socket

Embed: (wiki syntax)

« Back to documentation index

VodafoneUSBModem Class Reference

VodafoneUSBModem Class Reference

Vodafone USB Modem (K3770/K3772-Z) dongle. More...

#include <VodafoneUSBModem.h>

Public Member Functions

 VodafoneUSBModem ()
 Create Vodafone USB Modem (K3770/K3772-Z) dongle API instance.
int connect (const char *apn=NULL, const char *user=NULL, const char *password=NULL)
 Open a 3G internet connection.
int disconnect ()
 Close the internet connection.
int sendSM (const char *number, const char *message)
 Send a SM.
int getSM (char *number, char *message, size_t maxLength)
 Receive a SM.
int getSMCount (size_t *pCount)
 Get the number of SMs in the incoming box.
int sendUSSD (const char *command, char *result, size_t maxLength)
 Send a USSD command & wait for its result.
int getLinkState (int *pRssi, LinkMonitor::REGISTRATION_STATE *pRegistrationState, LinkMonitor::BEARER *pBearer)
 Get link state.
ATCommandsInterfacegetATCommandsInterface ()
 Get the ATCommandsInterface instance.

Detailed Description

Vodafone USB Modem (K3770/K3772-Z) dongle.

Definition at line 37 of file VodafoneUSBModem.h.


Constructor & Destructor Documentation

Create Vodafone USB Modem (K3770/K3772-Z) dongle API instance.


Member Function Documentation

int connect ( const char *  apn = NULL,
const char *  user = NULL,
const char *  password = NULL 
)

Open a 3G internet connection.

Returns:
0 on success, error code on failure
int disconnect (  )

Close the internet connection.

Returns:
0 on success, error code on failure
ATCommandsInterface* getATCommandsInterface (  )

Get the ATCommandsInterface instance.

Returns:
Pointer to the ATCommandsInterface instance
int getLinkState ( int *  pRssi,
LinkMonitor::REGISTRATION_STATE pRegistrationState,
LinkMonitor::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
int getSM ( char *  number,
char *  message,
size_t  maxLength 
)

Receive a SM.

Parameters:
numberPointer to a buffer to store the sender's phone number (must be at least 17 characters-long, including the sapce for the null-terminating char)
messagePointer to a buffer to store the the incoming message
maxLengthMaximum message length that can be stored in buffer (including null-terminating character)
Returns:
0 on success, error code on failure
int getSMCount ( size_t *  pCount )

Get the number of SMs in the incoming box.

Parameters:
pCountpointer to store the number of unprocessed SMs on
Returns:
0 on success, error code on failure
int sendSM ( const char *  number,
const char *  message 
)

Send a SM.

Parameters:
numberThe receiver's phone number
messageThe message to send
Returns:
0 on success, error code on failure
int sendUSSD ( const char *  command,
char *  result,
size_t  maxLength 
)

Send a USSD command & wait for its result.

Parameters:
commandThe command to send
resultBuffer in which to store the result
maxLengthMaximum result length that can be stored in buffer (including null-terminating character)
Returns:
0 on success, error code on failure