Jonathan Caes / InetTest-8d87bc453349

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   DS1307 TextLCD mbed

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

Committer:
JonathanCaes
Date:
Thu Dec 18 10:34:38 2014 +0000
Revision:
0:a16f60a71395
Project C mbed

Who changed what in which revision?

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