fork of VodafoneUSBModem with updated USBHost library
Dependencies: Socket USBHost lwip-sys lwip
Dependents: VodafoneUSBModemSMSTest
VodafoneK3770.h@12:66dc2c8eba2d, 2012-07-11 (annotated)
- Committer:
- donatien
- Date:
- Wed Jul 11 21:25:03 2012 +0000
- Revision:
- 12:66dc2c8eba2d
- Parent:
- 8:04b6a042595f
Link Monitoring / Dual serial port support
Who changed what in which revision?
User | Revision | Line number | New 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 | 12:66dc2c8eba2d | 35 | #include "link/LinkMonitor.h" |
donatien | 8:04b6a042595f | 36 | |
donatien | 8:04b6a042595f | 37 | /** Vodafone K3770 dongle |
donatien | 8:04b6a042595f | 38 | */ |
donatien | 8:04b6a042595f | 39 | class VodafoneK3770 |
donatien | 8:04b6a042595f | 40 | { |
donatien | 8:04b6a042595f | 41 | public: |
donatien | 8:04b6a042595f | 42 | /** Create Vodafone K3770 dongle API instance |
donatien | 8:04b6a042595f | 43 | |
donatien | 8:04b6a042595f | 44 | */ |
donatien | 8:04b6a042595f | 45 | VodafoneK3770(); |
donatien | 8:04b6a042595f | 46 | |
donatien | 8:04b6a042595f | 47 | //Internet-related functions |
donatien | 8:04b6a042595f | 48 | |
donatien | 8:04b6a042595f | 49 | /** Open a 3G internet connection |
donatien | 8:04b6a042595f | 50 | @return 0 on success, error code on failure |
donatien | 8:04b6a042595f | 51 | */ |
donatien | 8:04b6a042595f | 52 | int connect(const char* apn = NULL, const char* user = NULL, const char* password = NULL); |
donatien | 8:04b6a042595f | 53 | |
donatien | 8:04b6a042595f | 54 | /** Close the internet connection |
donatien | 8:04b6a042595f | 55 | @return 0 on success, error code on failure |
donatien | 8:04b6a042595f | 56 | */ |
donatien | 8:04b6a042595f | 57 | int disconnect(); |
donatien | 8:04b6a042595f | 58 | |
donatien | 8:04b6a042595f | 59 | |
donatien | 8:04b6a042595f | 60 | /** Send a SM |
donatien | 8:04b6a042595f | 61 | @param number The receiver's phone number |
donatien | 8:04b6a042595f | 62 | @param message The message to send |
donatien | 8:04b6a042595f | 63 | @return 0 on success, error code on failure |
donatien | 8:04b6a042595f | 64 | */ |
donatien | 8:04b6a042595f | 65 | int sendSM(const char* number, const char* message); |
donatien | 8:04b6a042595f | 66 | |
donatien | 8:04b6a042595f | 67 | |
donatien | 8:04b6a042595f | 68 | /** Receive a SM |
donatien | 8:04b6a042595f | 69 | @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 | 70 | @param message Pointer to a buffer to store the the incoming message |
donatien | 8:04b6a042595f | 71 | @param maxLength Maximum message length that can be stored in buffer (including null-terminating character) |
donatien | 8:04b6a042595f | 72 | @return 0 on success, error code on failure |
donatien | 8:04b6a042595f | 73 | */ |
donatien | 8:04b6a042595f | 74 | int getSM(char* number, char* message, size_t maxLength); |
donatien | 8:04b6a042595f | 75 | |
donatien | 8:04b6a042595f | 76 | /** Get the number of SMs in the incoming box |
donatien | 8:04b6a042595f | 77 | @param pCount pointer to store the number of unprocessed SMs on |
donatien | 8:04b6a042595f | 78 | @return 0 on success, error code on failure |
donatien | 8:04b6a042595f | 79 | */ |
donatien | 8:04b6a042595f | 80 | int getSMCount(size_t* pCount); |
donatien | 8:04b6a042595f | 81 | |
donatien | 8:04b6a042595f | 82 | /** Send a USSD command & wait for its result |
donatien | 8:04b6a042595f | 83 | @param command The command to send |
donatien | 8:04b6a042595f | 84 | @param result Buffer in which to store the result |
donatien | 8:04b6a042595f | 85 | @param maxLength Maximum result length that can be stored in buffer (including null-terminating character) |
donatien | 8:04b6a042595f | 86 | @return 0 on success, error code on failure |
donatien | 8:04b6a042595f | 87 | */ |
donatien | 8:04b6a042595f | 88 | int sendUSSD(const char* command, char* result, size_t maxLength); |
donatien | 12:66dc2c8eba2d | 89 | |
donatien | 12:66dc2c8eba2d | 90 | /** Get link state |
donatien | 12:66dc2c8eba2d | 91 | @param pRssi pointer to store the current RSSI in dBm, between -51 dBm and -113 dBm if known; -51 dBm means -51 dBm or more; -113 dBm means -113 dBm or less; 0 if unknown |
donatien | 12:66dc2c8eba2d | 92 | @param pRegistrationState pointer to store the current registration state |
donatien | 12:66dc2c8eba2d | 93 | @param pBearer pointer to store the current bearer |
donatien | 12:66dc2c8eba2d | 94 | @return 0 on success, error code on failure |
donatien | 12:66dc2c8eba2d | 95 | */ |
donatien | 12:66dc2c8eba2d | 96 | int getLinkState(int* pRssi, LinkMonitor::REGISTRATION_STATE* pRegistrationState, LinkMonitor::BEARER* pBearer); |
donatien | 8:04b6a042595f | 97 | |
donatien | 8:04b6a042595f | 98 | /** Get the ATCommandsInterface instance |
donatien | 8:04b6a042595f | 99 | @return Pointer to the ATCommandsInterface instance |
donatien | 8:04b6a042595f | 100 | */ |
donatien | 8:04b6a042595f | 101 | ATCommandsInterface* getATCommandsInterface(); |
donatien | 8:04b6a042595f | 102 | |
donatien | 8:04b6a042595f | 103 | protected: |
donatien | 8:04b6a042595f | 104 | int init(); |
donatien | 8:04b6a042595f | 105 | |
donatien | 8:04b6a042595f | 106 | private: |
donatien | 8:04b6a042595f | 107 | WANDongle m_dongle; |
donatien | 8:04b6a042595f | 108 | |
donatien | 8:04b6a042595f | 109 | USBSerialStream m_atStream; |
donatien | 8:04b6a042595f | 110 | USBSerialStream m_pppStream; |
donatien | 8:04b6a042595f | 111 | |
donatien | 8:04b6a042595f | 112 | ATCommandsInterface m_at; |
donatien | 8:04b6a042595f | 113 | |
donatien | 8:04b6a042595f | 114 | SMSInterface m_sms; |
donatien | 8:04b6a042595f | 115 | USSDInterface m_ussd; |
donatien | 12:66dc2c8eba2d | 116 | LinkMonitor m_linkMonitor; |
donatien | 8:04b6a042595f | 117 | |
donatien | 8:04b6a042595f | 118 | PPPIPInterface m_ppp; |
donatien | 8:04b6a042595f | 119 | |
donatien | 8:04b6a042595f | 120 | bool m_dongleConnected; |
donatien | 8:04b6a042595f | 121 | bool m_ipInit; |
donatien | 8:04b6a042595f | 122 | bool m_smsInit; |
donatien | 8:04b6a042595f | 123 | bool m_ussdInit; |
donatien | 12:66dc2c8eba2d | 124 | bool m_linkMonitorInit; |
donatien | 8:04b6a042595f | 125 | bool m_atOpen; |
donatien | 8:04b6a042595f | 126 | }; |
donatien | 8:04b6a042595f | 127 | |
donatien | 8:04b6a042595f | 128 | |
donatien | 8:04b6a042595f | 129 | #endif /* VODAFONEK3770_H_ */ |