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