GPRS Class Reference

API for the GPRS Module. More...

Detailed Description

• ID: gprs
• Name: GPRS Module
• Other Names: Grove GPRS Module
• Category: wifi
• Manufacturer: seeed
• Connection: uart
• Link: http://www.seeedstudio.com/wiki/GPRS_Shield_V2.0

The driver was tested with the GPRS Module, V2. It's a GSM GPRS module based on the SIM900. This module uses a standard 'AT' command set. See the datasheet for a full list of available commands and their possible responses:

http://www.seeedstudio.com/wiki/images/7/72/AT_Commands_v1.11.pdf

It is connected via a UART at 19200 baud.

  // Instantiate a GPRS Module on UART 0
  upm::GPRS* sensor = new upm::GPRS(0);

  // Set the baud rate, 19200 baud is the default.
  if (sensor->setBaudRate(19200) != mraa::SUCCESS)
    {
      cerr << "Failed to set tty baud rate" << endl;
      return 1;
    }

  printUsage(argv[0]);

  if (argc > 1)
    {
      cout << "Sending command line argument (" << argv[1] << ")..." << endl;
      sendCommand(sensor, argv[1]);
    }
  else
    {
      // query the module manufacturer
      cout << "Querying module manufacturer (AT+CGMI)..." << endl;
      sendCommand(sensor, "AT+CGMI");

      sleep(1);

      // query the saved profiles
      cout << "Querying the saved profiles (AT&V)..." << endl;
      sendCommand(sensor, "AT&V");

      // A comprehensive list is available from the datasheet at:
      // http://www.seeedstudio.com/wiki/images/7/72/AT_Commands_v1.11.pdf
    }

Public Member Functions
	GPRS (int uart=GPRS_DEFAULT_UART)
	~GPRS ()
bool	dataAvailable (unsigned int millis)
int	readData (char *buffer, unsigned int len)
std::string	readDataStr (int len)
int	writeData (char *buffer, unsigned len)
int	writeDataStr (std::string data)
mraa::Result	setBaudRate (int baud=19200)

Protected Attributes
mraa::Uart	m_uart

Constructor & Destructor Documentation

GPRS

(

int

uart = GPRS_DEFAULT_UART

)

GPRS object constructor

Parameters

uart	Default UART to use (0 or 1). Default is 0.

~GPRS

(

)

GPRS object destructor

Member Function Documentation

bool dataAvailable

(

unsigned int

millis

)

Checks to see if there is data available for reading

Parameters

millis

Number of milliseconds to wait; 0 means no waiting

Returns

true if there is data available for reading

int readData	(	char *	buffer,
		unsigned int	len
	)

Reads any available data into a user-supplied buffer. Note: the call blocks until data is available for reading. Use dataAvailable() to determine whether there is data available beforehand, to avoid blocking.

Parameters

buffer	Buffer to hold the data read
len	Length of the buffer

Returns

Number of bytes read

std::string readDataStr

(

int

len

)

Reads any available data and returns it in a std::string. Note: the call blocks until data is available for reading. Use dataAvailable() to determine whether there is data available beforehand, to avoid blocking.

Parameters

len	Maximum length of the data to be returned

Returns

Number of bytes read

int writeData	(	char *	buffer,
		unsigned	len
	)

Writes the data in the buffer to the device. If you are writing a command, be sure to terminate it with a carriage return ()

Parameters

buffer	Buffer to hold the data to write
len	Length of the buffer

Returns

Number of bytes written

int writeDataStr

(

std::string

data

)

Writes the std:string data to the device. If you are writing a command, be sure to terminate it with a carriage return ()

Parameters

data	Buffer to write to the device

Returns

Number of bytes written

mraa::Result setBaudRate

(

int

baud = 19200

)

Sets the baud rate for the device. The default is 19200.

Parameters

baud	Desired baud rate.

Returns

true if successful

---

The documentation for this class was generated from the following files:

• /iotdk/jenkins/workspace/upm-doc-stable/src/gprs/gprs.hpp
• /iotdk/jenkins/workspace/upm-doc-stable/src/gprs/gprs.cxx