Nino Der Kinderen / Mbed 2 deprecated InetTest

Embedded C project:18/12/2014

Dependencies:   DS1307 TextLCD mbed

NetServices/if/umtsstick/UMTSStickNetIf.h@0:8d87bc453349, 2014-12-18 (annotated)

Committer:
ninoderkinderen
Date:
Thu Dec 18 09:35:49 2014 +0000
Revision:
0:8d87bc453349
Programma embedded C

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ninoderkinderen 0:8d87bc453349 1
ninoderkinderen 0:8d87bc453349 2 /*
ninoderkinderen 0:8d87bc453349 3 Copyright (c) 2010 Donatien Garnier (donatiengar [at] gmail [dot] com)
ninoderkinderen 0:8d87bc453349 4
ninoderkinderen 0:8d87bc453349 5 Permission is hereby granted, free of charge, to any person obtaining a copy
ninoderkinderen 0:8d87bc453349 6 of this software and associated documentation files (the "Software"), to deal
ninoderkinderen 0:8d87bc453349 7 in the Software without restriction, including without limitation the rights
ninoderkinderen 0:8d87bc453349 8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
ninoderkinderen 0:8d87bc453349 9 copies of the Software, and to permit persons to whom the Software is
ninoderkinderen 0:8d87bc453349 10 furnished to do so, subject to the following conditions:
ninoderkinderen 0:8d87bc453349 11
ninoderkinderen 0:8d87bc453349 12 The above copyright notice and this permission notice shall be included in
ninoderkinderen 0:8d87bc453349 13 all copies or substantial portions of the Software.
ninoderkinderen 0:8d87bc453349 14
ninoderkinderen 0:8d87bc453349 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
ninoderkinderen 0:8d87bc453349 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
ninoderkinderen 0:8d87bc453349 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
ninoderkinderen 0:8d87bc453349 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
ninoderkinderen 0:8d87bc453349 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
ninoderkinderen 0:8d87bc453349 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
ninoderkinderen 0:8d87bc453349 21 THE SOFTWARE.
ninoderkinderen 0:8d87bc453349 22 */
ninoderkinderen 0:8d87bc453349 23
ninoderkinderen 0:8d87bc453349 24 /** \file
ninoderkinderen 0:8d87bc453349 25 UMTS Stick network interface header file
ninoderkinderen 0:8d87bc453349 26 */
ninoderkinderen 0:8d87bc453349 27
ninoderkinderen 0:8d87bc453349 28 #ifndef UMTSSTICKNETIF_H
ninoderkinderen 0:8d87bc453349 29 #define UMTSSTICKNETIF_H
ninoderkinderen 0:8d87bc453349 30
ninoderkinderen 0:8d87bc453349 31 #include "mbed.h"
ninoderkinderen 0:8d87bc453349 32
ninoderkinderen 0:8d87bc453349 33 #include "core/net.h"
ninoderkinderen 0:8d87bc453349 34 #include "if/ppp/PPPNetIf.h"
ninoderkinderen 0:8d87bc453349 35
ninoderkinderen 0:8d87bc453349 36 #include "drv/umtsstick/UMTSStick.h"
ninoderkinderen 0:8d87bc453349 37
ninoderkinderen 0:8d87bc453349 38 ///UMTS Stick network interface
ninoderkinderen 0:8d87bc453349 39 /**
ninoderkinderen 0:8d87bc453349 40 This class provides connectivity to the stack using a 3G (or LTE etc...) stick
ninoderkinderen 0:8d87bc453349 41 Plug it to your USB host using two Pull-down resistors on the D+/D- lines
ninoderkinderen 0:8d87bc453349 42 */
ninoderkinderen 0:8d87bc453349 43 class UMTSStickNetIf : public LwipNetIf, protected PPPNetIf
ninoderkinderen 0:8d87bc453349 44 {
ninoderkinderen 0:8d87bc453349 45 public:
ninoderkinderen 0:8d87bc453349 46 ///Instantiates the Interface and register it against the stack
ninoderkinderen 0:8d87bc453349 47 UMTSStickNetIf();
ninoderkinderen 0:8d87bc453349 48 virtual ~UMTSStickNetIf();
ninoderkinderen 0:8d87bc453349 49
ninoderkinderen 0:8d87bc453349 50 ///Tries to connect to the stick
ninoderkinderen 0:8d87bc453349 51 /**
ninoderkinderen 0:8d87bc453349 52 This method tries to obtain a virtual serial port interface from the stick
ninoderkinderen 0:8d87bc453349 53 It waits for a stick to be connected, switches it from CDFS to virtual serial port mode if needed,
ninoderkinderen 0:8d87bc453349 54 and obtains a virtual serial port from it
ninoderkinderen 0:8d87bc453349 55 @return : A negative error code on error or 0 on success
ninoderkinderen 0:8d87bc453349 56 */
ninoderkinderen 0:8d87bc453349 57 UMTSStickErr setup(); //UMTSStickErr is from /drv/umtsstick/UMTSStick.h
ninoderkinderen 0:8d87bc453349 58
ninoderkinderen 0:8d87bc453349 59 ///Establishes a PPP connection
ninoderkinderen 0:8d87bc453349 60 /**
ninoderkinderen 0:8d87bc453349 61 This method opens an AT interface on the serial interface, initializes and configures the stick,
ninoderkinderen 0:8d87bc453349 62 then opens a PPP connection and authenticates with the parameters
ninoderkinderen 0:8d87bc453349 63 \param apn : APN of the interface, if NULL uses the SIM default value
ninoderkinderen 0:8d87bc453349 64 \param userId : user with which to authenticate during the PPP connection, if NULL does not authenticate
ninoderkinderen 0:8d87bc453349 65 \param password : associated password
ninoderkinderen 0:8d87bc453349 66 @return : A negative error code on error or 0 on success
ninoderkinderen 0:8d87bc453349 67 */
ninoderkinderen 0:8d87bc453349 68 PPPErr connect(const char* apn = NULL, const char* userId = NULL, const char* password = NULL); //Connect using GPRS
ninoderkinderen 0:8d87bc453349 69
ninoderkinderen 0:8d87bc453349 70 ///Disconnects the PPP connection
ninoderkinderen 0:8d87bc453349 71 PPPErr disconnect();
ninoderkinderen 0:8d87bc453349 72
ninoderkinderen 0:8d87bc453349 73 private:
ninoderkinderen 0:8d87bc453349 74 UMTSStick m_umtsStick;
ninoderkinderen 0:8d87bc453349 75 UsbSerial* m_pUsbSerial;
ninoderkinderen 0:8d87bc453349 76
ninoderkinderen 0:8d87bc453349 77 };
ninoderkinderen 0:8d87bc453349 78
ninoderkinderen 0:8d87bc453349 79 #endif
ninoderkinderen 0:8d87bc453349 80