Rahol Rajan / NetServices-Traffic

Used in Live Traffic Update Nokia LCD Display Project

Fork of NetServices by Segundo Equipo

if/umtsstick/UMTSStickNetIf.h@8:92b57208ab99, 2013-03-06 (annotated)

Committer:
rrajan8
Date:
Wed Mar 06 19:07:23 2013 +0000
Revision:
8:92b57208ab99
Parent:
0:ac1725ba162c 
This project utilizes mbed's networking features to display live traffic updates on the Nokia LCD using the MapQuest API's Traffic Web Service.

Who changed what in which revision?

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