Vodafone K3770/K3772-Z modems driver & networking library

Dependencies:   Socket USBHostWANDongle lwip-sys lwip

Dependents:   VodafoneUSBModemHTTPClientTest VodafoneUSBModemNTPClientTest VodafoneUSBModemSMSTest VodafoneUSBModemUSSDTest ... more

Fork of VodafoneUSBModem_bleedingedge by Donatien Garnier

This is the driver for the Vodafone K3700 & K3772-Z Dongles:

K3770

More details and instructions can be found here.

Committer:
donatien
Date:
Tue Jun 26 13:44:59 2012 +0000
Revision:
8:04b6a042595f
Child:
12:66dc2c8eba2d
Bleeding edge - test with two different interfaces

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 8:04b6a042595f 1 /* VodafoneK3770.h */
donatien 8:04b6a042595f 2 /*
donatien 8:04b6a042595f 3 Copyright (C) 2012 ARM Limited.
donatien 8:04b6a042595f 4
donatien 8:04b6a042595f 5 Permission is hereby granted, free of charge, to any person obtaining a copy of
donatien 8:04b6a042595f 6 this software and associated documentation files (the "Software"), to deal in
donatien 8:04b6a042595f 7 the Software without restriction, including without limitation the rights to
donatien 8:04b6a042595f 8 use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
donatien 8:04b6a042595f 9 of the Software, and to permit persons to whom the Software is furnished to do
donatien 8:04b6a042595f 10 so, subject to the following conditions:
donatien 8:04b6a042595f 11
donatien 8:04b6a042595f 12 The above copyright notice and this permission notice shall be included in all
donatien 8:04b6a042595f 13 copies or substantial portions of the Software.
donatien 8:04b6a042595f 14
donatien 8:04b6a042595f 15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
donatien 8:04b6a042595f 16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
donatien 8:04b6a042595f 17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
donatien 8:04b6a042595f 18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
donatien 8:04b6a042595f 19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien 8:04b6a042595f 20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
donatien 8:04b6a042595f 21 SOFTWARE.
donatien 8:04b6a042595f 22 */
donatien 8:04b6a042595f 23
donatien 8:04b6a042595f 24 #ifndef VODAFONEK3770_H_
donatien 8:04b6a042595f 25 #define VODAFONEK3770_H_
donatien 8:04b6a042595f 26
donatien 8:04b6a042595f 27 #include "core/fwk.h"
donatien 8:04b6a042595f 28
donatien 8:04b6a042595f 29 #include "WANDongle.h"
donatien 8:04b6a042595f 30 #include "at/ATCommandsInterface.h"
donatien 8:04b6a042595f 31 #include "serial/usb/USBSerialStream.h"
donatien 8:04b6a042595f 32 #include "ip/PPPIPInterface.h"
donatien 8:04b6a042595f 33 #include "sms/SMSInterface.h"
donatien 8:04b6a042595f 34 #include "ussd/USSDInterface.h"
donatien 8:04b6a042595f 35
donatien 8:04b6a042595f 36 /** Vodafone K3770 dongle
donatien 8:04b6a042595f 37 */
donatien 8:04b6a042595f 38 class VodafoneK3770
donatien 8:04b6a042595f 39 {
donatien 8:04b6a042595f 40 public:
donatien 8:04b6a042595f 41 /** Create Vodafone K3770 dongle API instance
donatien 8:04b6a042595f 42
donatien 8:04b6a042595f 43 */
donatien 8:04b6a042595f 44 VodafoneK3770();
donatien 8:04b6a042595f 45
donatien 8:04b6a042595f 46 //Internet-related functions
donatien 8:04b6a042595f 47
donatien 8:04b6a042595f 48 /** Open a 3G internet connection
donatien 8:04b6a042595f 49 @return 0 on success, error code on failure
donatien 8:04b6a042595f 50 */
donatien 8:04b6a042595f 51 int connect(const char* apn = NULL, const char* user = NULL, const char* password = NULL);
donatien 8:04b6a042595f 52
donatien 8:04b6a042595f 53 /** Close the internet connection
donatien 8:04b6a042595f 54 @return 0 on success, error code on failure
donatien 8:04b6a042595f 55 */
donatien 8:04b6a042595f 56 int disconnect();
donatien 8:04b6a042595f 57
donatien 8:04b6a042595f 58
donatien 8:04b6a042595f 59 /** Send a SM
donatien 8:04b6a042595f 60 @param number The receiver's phone number
donatien 8:04b6a042595f 61 @param message The message to send
donatien 8:04b6a042595f 62 @return 0 on success, error code on failure
donatien 8:04b6a042595f 63 */
donatien 8:04b6a042595f 64 int sendSM(const char* number, const char* message);
donatien 8:04b6a042595f 65
donatien 8:04b6a042595f 66
donatien 8:04b6a042595f 67 /** Receive a SM
donatien 8:04b6a042595f 68 @param number Pointer to a buffer to store the sender's phone number (must be at least 17 characters-long, including the sapce for the null-terminating char)
donatien 8:04b6a042595f 69 @param message Pointer to a buffer to store the the incoming message
donatien 8:04b6a042595f 70 @param maxLength Maximum message length that can be stored in buffer (including null-terminating character)
donatien 8:04b6a042595f 71 @return 0 on success, error code on failure
donatien 8:04b6a042595f 72 */
donatien 8:04b6a042595f 73 int getSM(char* number, char* message, size_t maxLength);
donatien 8:04b6a042595f 74
donatien 8:04b6a042595f 75 /** Get the number of SMs in the incoming box
donatien 8:04b6a042595f 76 @param pCount pointer to store the number of unprocessed SMs on
donatien 8:04b6a042595f 77 @return 0 on success, error code on failure
donatien 8:04b6a042595f 78 */
donatien 8:04b6a042595f 79 int getSMCount(size_t* pCount);
donatien 8:04b6a042595f 80
donatien 8:04b6a042595f 81 /** Send a USSD command & wait for its result
donatien 8:04b6a042595f 82 @param command The command to send
donatien 8:04b6a042595f 83 @param result Buffer in which to store the result
donatien 8:04b6a042595f 84 @param maxLength Maximum result length that can be stored in buffer (including null-terminating character)
donatien 8:04b6a042595f 85 @return 0 on success, error code on failure
donatien 8:04b6a042595f 86 */
donatien 8:04b6a042595f 87 int sendUSSD(const char* command, char* result, size_t maxLength);
donatien 8:04b6a042595f 88
donatien 8:04b6a042595f 89 /** Get the ATCommandsInterface instance
donatien 8:04b6a042595f 90 @return Pointer to the ATCommandsInterface instance
donatien 8:04b6a042595f 91 */
donatien 8:04b6a042595f 92 ATCommandsInterface* getATCommandsInterface();
donatien 8:04b6a042595f 93
donatien 8:04b6a042595f 94 protected:
donatien 8:04b6a042595f 95 int init();
donatien 8:04b6a042595f 96
donatien 8:04b6a042595f 97 private:
donatien 8:04b6a042595f 98 WANDongle m_dongle;
donatien 8:04b6a042595f 99
donatien 8:04b6a042595f 100 USBSerialStream m_atStream;
donatien 8:04b6a042595f 101 USBSerialStream m_pppStream;
donatien 8:04b6a042595f 102
donatien 8:04b6a042595f 103 ATCommandsInterface m_at;
donatien 8:04b6a042595f 104
donatien 8:04b6a042595f 105 SMSInterface m_sms;
donatien 8:04b6a042595f 106 USSDInterface m_ussd;
donatien 8:04b6a042595f 107
donatien 8:04b6a042595f 108 PPPIPInterface m_ppp;
donatien 8:04b6a042595f 109
donatien 8:04b6a042595f 110 bool m_dongleConnected;
donatien 8:04b6a042595f 111 bool m_ipInit;
donatien 8:04b6a042595f 112 bool m_smsInit;
donatien 8:04b6a042595f 113 bool m_ussdInit;
donatien 8:04b6a042595f 114 bool m_atOpen;
donatien 8:04b6a042595f 115 };
donatien 8:04b6a042595f 116
donatien 8:04b6a042595f 117
donatien 8:04b6a042595f 118 #endif /* VODAFONEK3770_H_ */