diff options
Diffstat (limited to 'libraries/GSM/GSM3ShieldV1ClientProvider.h')
| -rw-r--r-- | libraries/GSM/GSM3ShieldV1ClientProvider.h | 181 |
1 files changed, 181 insertions, 0 deletions
diff --git a/libraries/GSM/GSM3ShieldV1ClientProvider.h b/libraries/GSM/GSM3ShieldV1ClientProvider.h new file mode 100644 index 0000000..fa2f8b5 --- /dev/null +++ b/libraries/GSM/GSM3ShieldV1ClientProvider.h @@ -0,0 +1,181 @@ +/* +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 __GSM3_SHIELDV1CLIENTPROVIDER__ +#define __GSM3_SHIELDV1CLIENTPROVIDER__ + +#include <GSM3MobileClientProvider.h> +#include <GSM3ShieldV1BaseProvider.h> + +class GSM3ShieldV1ClientProvider : public GSM3MobileClientProvider, public GSM3ShieldV1BaseProvider +{ + private: + + int remotePort; //Current operation remote port. + IPAddress remoteIP; // Remote IP address + int idSocket; // Remote ID socket. + + + /** Continue to connect TCP client function + */ + void connectTCPClientContinue(); + + /** Continue to available socket function + */ + void availableSocketContinue(); + + /** Continue to flush socket function + */ + void flushSocketContinue(); + + public: + + /** Constructor */ + GSM3ShieldV1ClientProvider(); + + /** minSocket + @return 0 + */ + int minSocket(){return 0;}; + + /** maxSocket + @return 0 + */ + int maxSocket(){return 0;}; + + /** Connect to a remote TCP server + @param server String with IP or server name + @param port Remote port number + @param id_socket Local socket number + @return 0 if command running, 1 if success, otherwise error + */ + int connectTCPClient(const char* server, int port, int id_socket); + + /** Connect to a remote TCP server + @param add Remote IP address + @param port Remote port number + @param id_socket Local socket number + @return 0 if command running, 1 if success, otherwise error + */ + int connectTCPClient(IPAddress add, int port, int id_socket); + + /** Begin writing through a socket + @param client1Server0 1 if modem acts as client, 0 if acts as server + @param id_socket Local socket number + @return 0 if command running, 1 if success, otherwise error + */ + void beginWriteSocket(bool client1Server0, int id_socket); + + /** Write through a socket. MUST go after beginWriteSocket() + @param buf characters to be written (final 0 will not be written) + */ + void writeSocket(const char* buf); + + /** Write through a socket. MUST go after beginWriteSocket() + @param c character to be written + */ + void writeSocket(uint8_t c); + + /** Finish current writing + */ + void endWriteSocket(); + + /** Check if there are data to be read in socket. + @param client1Server0 1 if modem acts as client, 0 if acts as server + @param id_socket Local socket number + @return 0 if command running, 1 if there are data available, 4 if no data, otherwise error + */ + int availableSocket(bool client, int id_socket); // With "available" and "readSocket" ask the modem for 1500 bytes. + + /** Read data (get a character) available in socket + @return character + */ + int readSocket(); //If Read() gets to the end of the QIRD response, execute again QIRD SYNCHRONOUSLY + + /** Flush socket + */ + void flushSocket(); + + /** Get a character but will not advance the buffer head + @return character + */ + int peekSocket(); + + /** Close a socket + @param client1Server0 1 if modem acts as client, 0 if acts as server + @param id_socket Socket + @return 0 if command running, 1 if success, otherwise error + */ + int disconnectTCP(bool client1Server0, int id_socket); + + /** Recognize unsolicited event + @param oldTail + @return true if successful + */ + bool recognizeUnsolicitedEvent(byte from); + + /** Manages modem response + @param from Initial byte position + @param to Final byte position + */ + void manageResponse(byte from, byte to); + + /** Get last command status + @return returns 0 if last command is still executing, 1 success, >1 error + */ + int ready(){return GSM3ShieldV1BaseProvider::ready();}; + + // Client socket management, just to be compatible + // with the Multi option + + /** Get socket + @param socket Socket + @return socket + */ + int getSocket(int socket=-1); + + /** Release socket + @param socket Socket + */ + void releaseSocket(int socket); + + /** Get socket client status + @param socket Socket + @return 1 if connected, 0 otherwise + */ + bool getStatusSocketClient(uint8_t socket); + +}; + + +#endif
\ No newline at end of file |