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