Michiel Berckvens / Mbed 2 deprecated ProjectHTTP

Berckvens Michiel & Basteyns Jonas

Dependencies:   DS1307 TextLCD mbed

NetServices/if/umtsstick/UMTSStickNetIf.h@5:6878defcfeb9, 2014-12-11 (annotated)

Committer:
Michielber
Date:
Thu Dec 11 16:07:34 2014 +0000
Revision:
5:6878defcfeb9
Parent:
0:f615d151a72c 
Project updated belastingslijn

Who changed what in which revision?

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