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 _GSM3MOBILEACCESSPROVIDER_
|
---|
35 | #define _GSM3MOBILEACCESSPROVIDER_
|
---|
36 |
|
---|
37 | enum GSM3_NetworkStatus_t { ERROR, IDLE, CONNECTING, GSM_READY, GPRS_READY, TRANSPARENT_CONNECTED, OFF};
|
---|
38 |
|
---|
39 | class GSM3MobileAccessProvider
|
---|
40 | {
|
---|
41 | public:
|
---|
42 | // Access functions
|
---|
43 | //Configuration functions.
|
---|
44 | /** Establish GSM connection
|
---|
45 | @param pin PIN code
|
---|
46 | @param restart Determines if hardware restart
|
---|
47 | @param synchronous Determines sync mode
|
---|
48 | @return If synchronous, GSM3_NetworkStatus_t. If asynchronous, returns 0.
|
---|
49 | */
|
---|
50 | virtual inline GSM3_NetworkStatus_t begin(char* pin=0,bool restart=true, bool synchronous=true)=0;
|
---|
51 |
|
---|
52 | /** Check network access status
|
---|
53 | @return 1 if Alive, 0 if down
|
---|
54 | */
|
---|
55 | virtual inline int isAccessAlive()=0;
|
---|
56 |
|
---|
57 | /** Shutdown the modem (power off really)
|
---|
58 | @return true if successful
|
---|
59 | */
|
---|
60 | virtual inline bool shutdown()=0;
|
---|
61 |
|
---|
62 | /** Secure shutdown the modem (power off really)
|
---|
63 | @return always true
|
---|
64 | */
|
---|
65 | virtual inline bool secureShutdown()=0;
|
---|
66 |
|
---|
67 | /** Get last command status
|
---|
68 | @return returns 0 if last command is still executing, 1 success, >1 error
|
---|
69 | */
|
---|
70 | virtual int ready()=0;
|
---|
71 | };
|
---|
72 |
|
---|
73 | #endif
|
---|