mbed official / SprintUSBModem

USB Host Library for Sprint Dongles

Dependencies:   Socket USBHostWANDongleSprint lwip-sys lwip

Dependents:   SprintUSBModemWebsocketTest SprintUSBModemHTTPClientTest SprintUSBModemNTPClientTest SprintUSBModemSMSTest ... more

Fork of SprintUSBModem_bleedingedge by Donatien Garnier

SprintUSBModem.h@14:f6f17843e5ef, 2012-12-10 (annotated)

Committer:
donatien
Date:
Mon Dec 10 18:23:49 2012 +0000
Revision:
14:f6f17843e5ef
Parent:
4:23100b0757d6 
Separate USB/Sprint dev flows, fix regression in mbed rev. 41+ lib

Who changed what in which revision?

UserRevisionLine numberNew contents of line
donatien 0:8f57713b2147 1 /* SprintUSBModem.h */
donatien 0:8f57713b2147 2 /* Copyright (C) 2012 mbed.org, MIT License
donatien 0:8f57713b2147 3 *
donatien 0:8f57713b2147 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
donatien 0:8f57713b2147 5 * and associated documentation files (the "Software"), to deal in the Software without restriction,
donatien 0:8f57713b2147 6 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
donatien 0:8f57713b2147 7 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
donatien 0:8f57713b2147 8 * furnished to do so, subject to the following conditions:
donatien 0:8f57713b2147 9 *
donatien 0:8f57713b2147 10 * The above copyright notice and this permission notice shall be included in all copies or
donatien 0:8f57713b2147 11 * substantial portions of the Software.
donatien 0:8f57713b2147 12 *
donatien 0:8f57713b2147 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
donatien 0:8f57713b2147 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
donatien 0:8f57713b2147 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
donatien 0:8f57713b2147 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
donatien 0:8f57713b2147 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
donatien 0:8f57713b2147 18 */
donatien 0:8f57713b2147 19
donatien 0:8f57713b2147 20 #ifndef SPRINTUSBMODEM_H_
donatien 0:8f57713b2147 21 #define SPRINTUSBMODEM_H_
donatien 0:8f57713b2147 22
donatien 0:8f57713b2147 23 #include "core/fwk.h"
donatien 0:8f57713b2147 24
donatien 0:8f57713b2147 25 #include "WANDongle.h"
donatien 0:8f57713b2147 26 #include "at/ATCommandsInterface.h"
donatien 0:8f57713b2147 27 #include "serial/usb/USBSerialStream.h"
donatien 0:8f57713b2147 28 #include "ip/PPPIPInterface.h"
donatien 0:8f57713b2147 29 #include "sms/SMSInterface.h"
donatien 0:8f57713b2147 30
donatien 0:8f57713b2147 31 /** Sprint USB Modem (Sierra Wireless 598U)
donatien 0:8f57713b2147 32 */
donatien 0:8f57713b2147 33 class SprintUSBModem
donatien 0:8f57713b2147 34 {
donatien 0:8f57713b2147 35 public:
donatien 0:8f57713b2147 36 /** Create Sprint USB Modem (Sierra Wireless 598U) API instance
donatien 2:f4d9c4ea17f9 37 @param powerGatingPin Optional pin commanding a power gating transistor on the modem's power line
donatien 2:f4d9c4ea17f9 38 @param powerGatingOnWhenPinHigh true if the pin needs to be high to power the dongle, defaults to true
donatien 0:8f57713b2147 39 */
donatien 2:f4d9c4ea17f9 40 SprintUSBModem(PinName powerGatingPin = NC, bool powerGatingOnWhenPinHigh = true);
donatien 0:8f57713b2147 41
donatien 0:8f57713b2147 42 //Internet-related functions
donatien 0:8f57713b2147 43
donatien 0:8f57713b2147 44 /** Open a 3G internet connection
donatien 0:8f57713b2147 45 @return 0 on success, error code on failure
donatien 0:8f57713b2147 46 */
donatien 0:8f57713b2147 47 int connect(const char* apn = NULL, const char* user = NULL, const char* password = NULL);
donatien 0:8f57713b2147 48
donatien 0:8f57713b2147 49 /** Close the internet connection
donatien 0:8f57713b2147 50 @return 0 on success, error code on failure
donatien 0:8f57713b2147 51 */
donatien 0:8f57713b2147 52 int disconnect();
donatien 0:8f57713b2147 53
donatien 0:8f57713b2147 54
donatien 0:8f57713b2147 55 /** Send a SM
donatien 0:8f57713b2147 56 @param number The receiver's phone number
donatien 0:8f57713b2147 57 @param message The message to send
donatien 0:8f57713b2147 58 @return 0 on success, error code on failure
donatien 0:8f57713b2147 59 */
donatien 0:8f57713b2147 60 int sendSM(const char* number, const char* message);
donatien 0:8f57713b2147 61
donatien 0:8f57713b2147 62
donatien 0:8f57713b2147 63 /** Receive a SM
donatien 0:8f57713b2147 64 @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:8f57713b2147 65 @param message Pointer to a buffer to store the the incoming message
donatien 0:8f57713b2147 66 @param maxLength Maximum message length that can be stored in buffer (including null-terminating character)
donatien 0:8f57713b2147 67 @return 0 on success, error code on failure
donatien 0:8f57713b2147 68 */
donatien 0:8f57713b2147 69 int getSM(char* number, char* message, size_t maxLength);
donatien 0:8f57713b2147 70
donatien 0:8f57713b2147 71 /** Get the number of SMs in the incoming box
donatien 0:8f57713b2147 72 @param pCount pointer to store the number of unprocessed SMs on
donatien 0:8f57713b2147 73 @return 0 on success, error code on failure
donatien 0:8f57713b2147 74 */
donatien 0:8f57713b2147 75 int getSMCount(size_t* pCount);
donatien 0:8f57713b2147 76
donatien 0:8f57713b2147 77 /** Get the ATCommandsInterface instance
donatien 0:8f57713b2147 78 @return Pointer to the ATCommandsInterface instance
donatien 0:8f57713b2147 79 */
donatien 0:8f57713b2147 80 ATCommandsInterface* getATCommandsInterface();
donatien 0:8f57713b2147 81
donatien 2:f4d9c4ea17f9 82 /** Switch power on or off
donatien 2:f4d9c4ea17f9 83 In order to use this function, a pin name must have been entered in the constructor
donatien 2:f4d9c4ea17f9 84 @param enable true to switch the dongle on, false to switch it off
donatien 2:f4d9c4ea17f9 85 @return 0 on success, error code on failure
donatien 2:f4d9c4ea17f9 86 */
donatien 2:f4d9c4ea17f9 87 int power(bool enable);
donatien 2:f4d9c4ea17f9 88
donatien 0:8f57713b2147 89 protected:
donatien 2:f4d9c4ea17f9 90 bool power();
donatien 2:f4d9c4ea17f9 91
donatien 0:8f57713b2147 92 int init();
donatien 2:f4d9c4ea17f9 93 int cleanup();
donatien 0:8f57713b2147 94
donatien 0:8f57713b2147 95 private:
donatien 0:8f57713b2147 96 WANDongle m_dongle;
donatien 0:8f57713b2147 97
donatien 4:23100b0757d6 98 USBSerialStream m_stream;
donatien 0:8f57713b2147 99
donatien 0:8f57713b2147 100 ATCommandsInterface m_at;
donatien 0:8f57713b2147 101
donatien 0:8f57713b2147 102 SMSInterface m_sms;
donatien 0:8f57713b2147 103
donatien 0:8f57713b2147 104 PPPIPInterface m_ppp;
donatien 0:8f57713b2147 105
donatien 0:8f57713b2147 106 bool m_dongleConnected;
donatien 0:8f57713b2147 107 bool m_ipInit;
donatien 0:8f57713b2147 108 bool m_smsInit;
donatien 0:8f57713b2147 109 bool m_atOpen;
donatien 2:f4d9c4ea17f9 110
donatien 2:f4d9c4ea17f9 111 PinName m_powerGatingPin;
donatien 2:f4d9c4ea17f9 112 bool m_powerGatingOnWhenPinHigh;
donatien 0:8f57713b2147 113 };
donatien 0:8f57713b2147 114
donatien 0:8f57713b2147 115
donatien 0:8f57713b2147 116 #endif /* SPRINTUSBMODEM_H_ */