1 | /*
|
---|
2 | This file is part of the GSM3 communications library for Arduino
|
---|
3 | -- Multi-transport communications platform
|
---|
4 | -- Fully asynchronous
|
---|
5 | -- Includes code for the Arduino-Telefonica GSM/GPRS Shield V1
|
---|
6 | -- Voice calls
|
---|
7 | -- SMS
|
---|
8 | -- TCP/IP connections
|
---|
9 | -- HTTP basic clients
|
---|
10 |
|
---|
11 | This library has been developed by Telefónica Digital - PDI -
|
---|
12 | - Physical Internet Lab, as part as its collaboration with
|
---|
13 | Arduino and the Open Hardware Community.
|
---|
14 |
|
---|
15 | September-December 2012
|
---|
16 |
|
---|
17 | This library is free software; you can redistribute it and/or
|
---|
18 | modify it under the terms of the GNU Lesser General Public
|
---|
19 | License as published by the Free Software Foundation; either
|
---|
20 | version 2.1 of the License, or (at your option) any later version.
|
---|
21 |
|
---|
22 | This library is distributed in the hope that it will be useful,
|
---|
23 | but WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
24 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
---|
25 | Lesser General Public License for more details.
|
---|
26 |
|
---|
27 | You should have received a copy of the GNU Lesser General Public
|
---|
28 | License along with this library; if not, write to the Free Software
|
---|
29 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
---|
30 |
|
---|
31 | The latest version of this library can always be found at
|
---|
32 | https://github.com/BlueVia/Official-Arduino
|
---|
33 | */
|
---|
34 | #ifndef _GSM3SHIELDV1BASEPROVIDER_
|
---|
35 | #define _GSM3SHIELDV1BASEPROVIDER_
|
---|
36 |
|
---|
37 | #include <GSM3SoftSerial.h>
|
---|
38 |
|
---|
39 | enum GSM3_commandType_e { XON, NONE, MODEMCONFIG, ALIVETEST, BEGINSMS, ENDSMS, AVAILABLESMS, FLUSHSMS,
|
---|
40 | VOICECALL, ANSWERCALL, HANGCALL, RETRIEVECALLINGNUMBER,
|
---|
41 | ATTACHGPRS, DETACHGPRS, CONNECTTCPCLIENT, DISCONNECTTCP, BEGINWRITESOCKET, ENDWRITESOCKET,
|
---|
42 | AVAILABLESOCKET, FLUSHSOCKET, CONNECTSERVER, GETIP, GETCONNECTSTATUS, GETLOCATION, GETICCID};
|
---|
43 |
|
---|
44 | class GSM3ShieldV1BaseProvider
|
---|
45 | {
|
---|
46 | public:
|
---|
47 |
|
---|
48 | /** Get last command status
|
---|
49 | @return Returns 0 if last command is still executing, 1 success, >1 error
|
---|
50 | */
|
---|
51 | int ready();
|
---|
52 |
|
---|
53 | /** This function locates strings from PROGMEM in the buffer
|
---|
54 | @param str PROGMEN
|
---|
55 | @param auxLocate Buffer where to locate strings
|
---|
56 | */
|
---|
57 | void prepareAuxLocate(PGM_P str, char auxLocate[]);
|
---|
58 |
|
---|
59 | /** Manages modem response
|
---|
60 | @param from Initial byte of buffer
|
---|
61 | @param to Final byte of buffer
|
---|
62 | */
|
---|
63 | virtual void manageResponse(byte from, byte to);
|
---|
64 |
|
---|
65 | /** Recognize URC
|
---|
66 | @param from
|
---|
67 | @return true if successful (default: false)
|
---|
68 | */
|
---|
69 | virtual bool recognizeUnsolicitedEvent(byte from){return false;};
|
---|
70 |
|
---|
71 | };
|
---|
72 |
|
---|
73 | #endif
|
---|