1
0
mirror of https://github.com/arduino/Arduino.git synced 2024-12-10 21:24:12 +01:00
Arduino/hardware/arduino/avr/libraries/GSM/GSM3MobileSMSProvider.h

92 lines
2.7 KiB
C
Raw Normal View History

2013-03-11 12:17:08 +01:00
/*
This file is part of the GSM3 communications library for Arduino
-- Multi-transport communications platform
-- Fully asynchronous
-- Includes code for the Arduino-Telefonica GSM/GPRS Shield V1
-- Voice calls
-- SMS
-- TCP/IP connections
-- HTTP basic clients
This library has been developed by Telef<EFBFBD>nica Digital - PDI -
- Physical Internet Lab, as part as its collaboration with
Arduino and the Open Hardware Community.
September-December 2012
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
The latest version of this library can always be found at
https://github.com/BlueVia/Official-Arduino
*/
#ifndef _GSM3MOBILESMSPROVIDER_
#define _GSM3MOBILESMSPROVIDER_
class GSM3MobileSMSProvider
{
public:
/** Begin a SMS to send it
@param to Destination
@return error command if it exists
*/
virtual inline int beginSMS(const char* to){return 0;};
/** Write a SMS character by character
@param c Character
*/
virtual inline void writeSMS(const char c){};
/** End SMS
@return error command if it exists
*/
virtual inline int endSMS(){return 0;};
/** Check if SMS available and prepare it to be read
@return number of bytes in a received SMS
*/
virtual inline int availableSMS(){return 0;};
/** Read a byte but do not advance the buffer header (circular buffer)
@return character
*/
virtual inline int peekSMS(){return 0;};
/** Delete the SMS from Modem memory and proccess answer
*/
virtual inline void flushSMS(){return;};
/** Read sender number phone
@param number Buffer for save number phone
@param nlength Buffer length
@return 1 success, >1 error
*/
virtual inline int remoteSMSNumber(char* number, int nlength){return 0;};
/** Read one char for SMS buffer (advance circular buffer)
@return character
*/
virtual inline int readSMS(){return 0;};
/** Get last command status
@return returns 0 if last command is still executing, 1 success, >1 error
*/
virtual int ready()=0;
};
extern GSM3MobileSMSProvider* theGSM3SMSProvider;
#endif