uses pushing box to write to google spreadsheets
Fork of
DCS
by DCS_TEAM
« Back to documentation index
GPRS Class Reference
The GPRS class.
More...
#include <GPRS.h >
Inherits Modem .
Inherited by GPRSInterface .
GPRS (PinName tx, PinName rx, int baudRate, const char *apn, const char *userName=NULL, const char *passWord=NULL) Constructor. bool join (void) Connect the GPRS module to the network. bool disconnect (void) Disconnect the GPRS module from the network. bool close (int socket) Close a tcp connection. bool connect (int socket, Protocol ptl, const char *host, int port, int timeout=DEFAULT_TIMEOUT) Open a tcp/udp connection with the specified host on the specified port. bool setProtocol (int socket, Protocol p) Set the protocol (UDP or TCP) void reset () Reset the GPRS module. bool readable (void) Check if GPRS module is readable or not. int wait_readable (int socket, int wait_time) Wait a few time to check if GPRS module is readable or not. int wait_writeable (int socket, int req_size) Wait a few time to check if GPRS module is writeable or not. bool is_connected (int socket) Check if a tcp link is active. int send (int socket, const char *str, int len) Send data to socket. int recv (int socket, char *buf, int len) Read data from socket. bool gethostbyname (const char *host, uint32_t *ip) Convert the host to ip. bool preInit () Power on Modem . static GPRS * getInstance () Get instance of GPRS class. char readByte (void) read one byte from serialModem int readBuffer (char *buffer, int count, unsigned int timeOut) read from Modem module and save to buffer array void cleanBuffer (char *buffer, int count) clean Buffer void sendCmd (const char *cmd) send AT command to Modem module void sendATTest (void) send "AT" to Modem module bool respCmp (const char *resp, unsigned int len, unsigned int timeout) compare the response from GPRS module with a string int waitForResp (const char *resp, unsigned int timeout, DataType type) check Modem module response before time out int sendCmdAndWaitForResp (const char *data, const char *resp, unsigned timeout, DataType type) send AT command to GPRS module and wait for correct response
Detailed Description
The GPRS class.
Definition at line 41 of file GPRS.h .
Constructor & Destructor Documentation
GPRS (
PinName
tx ,
PinName
rx ,
int
baudRate ,
const char *
apn ,
const char *
userName = NULL,
const char *
passWord = NULL
)
Constructor.
Parameters:
tx mbed pin to use for tx line of Serial interface rx mbed pin to use for rx line of Serial interface baudRate serial communicate baud rate apn name of the gateway for GPRS to connect to the network userName apn's username, usually is NULL passWord apn's password, usually is NULL
Definition at line 32 of file GPRS.cpp .
Member Function Documentation
void cleanBuffer
(
char *
buffer ,
int
count
)
[protected, inherited]
clean Buffer
Parameters:
buffer buffer to clean count number of bytes to clean
Definition at line 147 of file modem.cpp .
bool close
(
int
socket )
Close a tcp connection.
Returns: true if successful Definition at line 305 of file GPRS.cpp .
bool connect
(
int
socket ,
Protocol
ptl ,
const char *
host ,
int
port ,
int
timeout = DEFAULT_TIMEOUT
)
Open a tcp/udp connection with the specified host on the specified port.
Parameters:
socket an endpoint of an inter-process communication flow of GPRS module,for SIM900 module, it is in [0,6] ptl protocol for socket, TCP/UDP can be choosen host host (can be either an ip address or a name. If a name is provided, a dns request will be established) port port timeout wait seconds till connected
Returns: true if successful Definition at line 242 of file GPRS.cpp .
Disconnect the GPRS module from the network.
Returns: true if successful Reimplemented in GPRSInterface .
Definition at line 278 of file GPRS.cpp .
bool gethostbyname
(
const char *
host ,
uint32_t *
ip
)
Convert the host to ip.
Parameters:
host host ip string, ex. 10.11.12.13 ip long int ip address, ex. 0x11223344
Returns: true if successful Definition at line 266 of file GPRS.cpp .
static GPRS * getInstance
(
)
[static]
Get instance of GPRS class.
Definition at line 57 of file GPRS.h .
bool is_connected
(
int
socket )
Check if a tcp link is active.
Returns: true if successful Definition at line 284 of file GPRS.cpp .
Connect the GPRS module to the network.
Returns: true if connected, false otherwise Definition at line 120 of file GPRS.cpp .
Check if GPRS module is readable or not.
Returns: true if readable Reimplemented from Modem .
Definition at line 325 of file GPRS.cpp .
int readBuffer
(
char *
buffer ,
int
count ,
unsigned int
timeOut
)
[protected, inherited]
read from Modem module and save to buffer array
Parameters:
buffer buffer array to save what read from Modem module count the maximal bytes number read from Modem module timeOut time to wait for reading from Modem module
Returns: 0 on success -1 on error Definition at line 127 of file modem.cpp .
char readByte
(
void
)
[protected, inherited]
read one byte from serialModem
Returns: one byte read from serialModem Definition at line 117 of file modem.cpp .
int recv
(
int
socket ,
char *
buf ,
int
len
)
Read data from socket.
Parameters:
socket socket buf buffer that will store the data read from socket len string length need to read from socket
Returns: bytes that actually read Definition at line 383 of file GPRS.cpp .
bool respCmp
(
const char *
resp ,
unsigned int
len ,
unsigned int
timeout
)
[protected, inherited]
compare the response from GPRS module with a string
Parameters:
resp buffer to be compared len length that will be compared timeout waiting seconds till timeout
Definition at line 190 of file modem.cpp .
int send
(
int
socket ,
const char *
str ,
int
len
)
Send data to socket.
Parameters:
socket socket str string to be sent len string length
Returns: return bytes that actually been send Definition at line 363 of file GPRS.cpp .
void sendATTest
(
void
)
[protected, inherited]
void sendCmd
(
const char *
cmd )
[protected, inherited]
send AT command to Modem module
Parameters:
cmd command array which will be send to GPRS module
Definition at line 154 of file modem.cpp .
int sendCmdAndWaitForResp
(
const char *
data ,
const char *
resp ,
unsigned
timeout ,
DataType
type
)
[protected, inherited]
send AT command to GPRS module and wait for correct response
Parameters:
*cmd AT command which will be send to GPRS module *resp correct response which GPRS module will return *timeout waiting seconds till timeout
Returns: 0 on success -1 on error Definition at line 244 of file modem.cpp .
bool setProtocol
(
int
socket ,
Protocol
p
)
Set the protocol (UDP or TCP)
Parameters:
Returns: true if successful Definition at line 233 of file GPRS.cpp .
int wait_readable
(
int
socket ,
int
wait_time
)
Wait a few time to check if GPRS module is readable or not.
Parameters:
socket socket wait_time time of waiting
Definition at line 330 of file GPRS.cpp .
int wait_writeable
(
int
socket ,
int
req_size
)
Wait a few time to check if GPRS module is writeable or not.
Parameters:
socket socket wait_time time of waiting
Definition at line 355 of file GPRS.cpp .
int waitForResp
(
const char *
resp ,
unsigned int
timeout ,
DataType
type
)
[protected, inherited]
check Modem module response before time out
Parameters:
*resp correct response which Modem module will return *timeout waiting seconds till timeout
Returns: 0 on success -1 on error Definition at line 213 of file modem.cpp .
DCS_TEAM
1.7.2