aboutsummaryrefslogtreecommitdiff
path: root/libraries/GSM/GSM3MobileSMSProvider.h
diff options
context:
space:
mode:
authorCristian Maglie <c.maglie@bug.st>2013-04-03 13:51:04 +0200
committerCristian Maglie <c.maglie@bug.st>2013-04-03 13:51:04 +0200
commitee90e68e86dd61d86f5d17b69080338328765b22 (patch)
treee620c0edc2690ab789b665e567910640597aa6fe /libraries/GSM/GSM3MobileSMSProvider.h
parent0ecdc5ebc96ad4c7c548c438a03d9ce00679db8b (diff)
parentf50c307be280dc6ece9e70c43b301c1db36291a0 (diff)
Merged 1.0.5
Merge remote-tracking branch 'arduino/master' into ide-1.5.x Conflicts: app/src/processing/app/Base.java build/shared/revisions.txt hardware/arduino/avr/cores/arduino/malloc.c hardware/arduino/cores/arduino/avr-libc/malloc.c hardware/arduino/cores/arduino/malloc.c todo.txt
Diffstat (limited to 'libraries/GSM/GSM3MobileSMSProvider.h')
-rw-r--r--libraries/GSM/GSM3MobileSMSProvider.h91
1 files changed, 91 insertions, 0 deletions
diff --git a/libraries/GSM/GSM3MobileSMSProvider.h b/libraries/GSM/GSM3MobileSMSProvider.h
new file mode 100644
index 0000000..aa72711
--- /dev/null
+++ b/libraries/GSM/GSM3MobileSMSProvider.h
@@ -0,0 +1,91 @@
+/*
+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ó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