ON Semiconductor / mbed-os

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

features/unsupported/net/cellular/UbloxUSBModem/UbloxUSBGSMModem.h@0:098463de4c5d, 2017-01-25 (annotated)

Committer:
group-onsemi
Date:
Wed Jan 25 20:34:15 2017 +0000
Revision:
0:098463de4c5d
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
group-onsemi 0:098463de4c5d 1 /* VodafoneUSBModem.h */
group-onsemi 0:098463de4c5d 2 /* Copyright (C) 2012 mbed.org, MIT License
group-onsemi 0:098463de4c5d 3 *
group-onsemi 0:098463de4c5d 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
group-onsemi 0:098463de4c5d 5 * and associated documentation files (the "Software"), to deal in the Software without restriction,
group-onsemi 0:098463de4c5d 6 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
group-onsemi 0:098463de4c5d 7 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
group-onsemi 0:098463de4c5d 8 * furnished to do so, subject to the following conditions:
group-onsemi 0:098463de4c5d 9 *
group-onsemi 0:098463de4c5d 10 * The above copyright notice and this permission notice shall be included in all copies or
group-onsemi 0:098463de4c5d 11 * substantial portions of the Software.
group-onsemi 0:098463de4c5d 12 *
group-onsemi 0:098463de4c5d 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
group-onsemi 0:098463de4c5d 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
group-onsemi 0:098463de4c5d 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
group-onsemi 0:098463de4c5d 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
group-onsemi 0:098463de4c5d 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
group-onsemi 0:098463de4c5d 18 */
group-onsemi 0:098463de4c5d 19
group-onsemi 0:098463de4c5d 20 #ifndef UBLOXUSBGSMMODEM_H_
group-onsemi 0:098463de4c5d 21 #define UBLOXUSBGSMMODEM_H_
group-onsemi 0:098463de4c5d 22
group-onsemi 0:098463de4c5d 23 #include "core/fwk.h"
group-onsemi 0:098463de4c5d 24
group-onsemi 0:098463de4c5d 25 #include "WANDongle.h"
group-onsemi 0:098463de4c5d 26 #include "at/ATCommandsInterface.h"
group-onsemi 0:098463de4c5d 27 #include "serial/usb/USBSerialStream.h"
group-onsemi 0:098463de4c5d 28 #include "ip/PPPIPInterface.h"
group-onsemi 0:098463de4c5d 29 #include "sms/GSMSMSInterface.h"
group-onsemi 0:098463de4c5d 30 #include "ussd/USSDInterface.h"
group-onsemi 0:098463de4c5d 31 #include "link/LinkMonitor.h"
group-onsemi 0:098463de4c5d 32 #include "CellularModem.h"
group-onsemi 0:098463de4c5d 33
group-onsemi 0:098463de4c5d 34 /** u-blox WCDMA modem (LISA-U200)
group-onsemi 0:098463de4c5d 35 */
group-onsemi 0:098463de4c5d 36 class UbloxUSBGSMModem: public CellularModem
group-onsemi 0:098463de4c5d 37 {
group-onsemi 0:098463de4c5d 38 public:
group-onsemi 0:098463de4c5d 39 /** Create u-blox API instance
group-onsemi 0:098463de4c5d 40 @param powerGatingPin Optional pin commanding a power gating transistor on the modem's power line
group-onsemi 0:098463de4c5d 41 @param powerGatingOnWhenPinHigh true if the pin needs to be high to power the dongle, defaults to true
group-onsemi 0:098463de4c5d 42 */
group-onsemi 0:098463de4c5d 43 UbloxUSBGSMModem(PinName powerGatingPin = NC, bool powerGatingOnWhenPinHigh = true);
group-onsemi 0:098463de4c5d 44
group-onsemi 0:098463de4c5d 45 //Internet-related functions
group-onsemi 0:098463de4c5d 46
group-onsemi 0:098463de4c5d 47 /** Open a 3G internet connection
group-onsemi 0:098463de4c5d 48 @return 0 on success, error code on failure
group-onsemi 0:098463de4c5d 49 */
group-onsemi 0:098463de4c5d 50 virtual int connect(const char* apn = NULL, const char* user = NULL, const char* password = NULL);
group-onsemi 0:098463de4c5d 51
group-onsemi 0:098463de4c5d 52 /** Close the internet connection
group-onsemi 0:098463de4c5d 53 @return 0 on success, error code on failure
group-onsemi 0:098463de4c5d 54 */
group-onsemi 0:098463de4c5d 55 virtual int disconnect();
group-onsemi 0:098463de4c5d 56
group-onsemi 0:098463de4c5d 57
group-onsemi 0:098463de4c5d 58 /** Send a SM
group-onsemi 0:098463de4c5d 59 @param number The receiver's phone number
group-onsemi 0:098463de4c5d 60 @param message The message to send
group-onsemi 0:098463de4c5d 61 @return 0 on success, error code on failure
group-onsemi 0:098463de4c5d 62 */
group-onsemi 0:098463de4c5d 63 virtual int sendSM(const char* number, const char* message);
group-onsemi 0:098463de4c5d 64
group-onsemi 0:098463de4c5d 65
group-onsemi 0:098463de4c5d 66 /** Receive a SM
group-onsemi 0:098463de4c5d 67 @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)
group-onsemi 0:098463de4c5d 68 @param message Pointer to a buffer to store the the incoming message
group-onsemi 0:098463de4c5d 69 @param maxLength Maximum message length that can be stored in buffer (including null-terminating character)
group-onsemi 0:098463de4c5d 70 @return 0 on success, error code on failure
group-onsemi 0:098463de4c5d 71 */
group-onsemi 0:098463de4c5d 72 virtual int getSM(char* number, char* message, size_t maxLength);
group-onsemi 0:098463de4c5d 73
group-onsemi 0:098463de4c5d 74 /** Get the number of SMs in the incoming box
group-onsemi 0:098463de4c5d 75 @param pCount pointer to store the number of unprocessed SMs on
group-onsemi 0:098463de4c5d 76 @return 0 on success, error code on failure
group-onsemi 0:098463de4c5d 77 */
group-onsemi 0:098463de4c5d 78 virtual int getSMCount(size_t* pCount);
group-onsemi 0:098463de4c5d 79
group-onsemi 0:098463de4c5d 80 /** Send a USSD command & wait for its result
group-onsemi 0:098463de4c5d 81 @param command The command to send
group-onsemi 0:098463de4c5d 82 @param result Buffer in which to store the result
group-onsemi 0:098463de4c5d 83 @param maxLength Maximum result length that can be stored in buffer (including null-terminating character)
group-onsemi 0:098463de4c5d 84 @return 0 on success, error code on failure
group-onsemi 0:098463de4c5d 85 */
group-onsemi 0:098463de4c5d 86 int sendUSSD(const char* command, char* result, size_t maxLength);
group-onsemi 0:098463de4c5d 87
group-onsemi 0:098463de4c5d 88 /** Get link state
group-onsemi 0:098463de4c5d 89 @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
group-onsemi 0:098463de4c5d 90 @param pRegistrationState pointer to store the current registration state
group-onsemi 0:098463de4c5d 91 @param pBearer pointer to store the current bearer
group-onsemi 0:098463de4c5d 92 @return 0 on success, error code on failure
group-onsemi 0:098463de4c5d 93 */
group-onsemi 0:098463de4c5d 94 int getLinkState(int* pRssi, LinkMonitor::REGISTRATION_STATE* pRegistrationState, LinkMonitor::BEARER* pBearer);
group-onsemi 0:098463de4c5d 95
group-onsemi 0:098463de4c5d 96 /** Get the ATCommandsInterface instance
group-onsemi 0:098463de4c5d 97 @return Pointer to the ATCommandsInterface instance
group-onsemi 0:098463de4c5d 98 */
group-onsemi 0:098463de4c5d 99 virtual ATCommandsInterface* getATCommandsInterface();
group-onsemi 0:098463de4c5d 100
group-onsemi 0:098463de4c5d 101 /** Switch power on or off
group-onsemi 0:098463de4c5d 102 In order to use this function, a pin name must have been entered in the constructor
group-onsemi 0:098463de4c5d 103 @param enable true to switch the dongle on, false to switch it off
group-onsemi 0:098463de4c5d 104 @return 0 on success, error code on failure
group-onsemi 0:098463de4c5d 105 */
group-onsemi 0:098463de4c5d 106 virtual int power(bool enable);
group-onsemi 0:098463de4c5d 107
group-onsemi 0:098463de4c5d 108 protected:
group-onsemi 0:098463de4c5d 109 bool power(); //< Turn power to USB dongle ON.
group-onsemi 0:098463de4c5d 110
group-onsemi 0:098463de4c5d 111 /** Initialise dongle.
group-onsemi 0:098463de4c5d 112 * The following actions are performed:
group-onsemi 0:098463de4c5d 113 * 1) Power up
group-onsemi 0:098463de4c5d 114 * 2) Establish USB connection to dongle
group-onsemi 0:098463de4c5d 115 * 3) Start AT interface thread
group-onsemi 0:098463de4c5d 116 * 4) Wait for network registration
group-onsemi 0:098463de4c5d 117 */
group-onsemi 0:098463de4c5d 118 int init();
group-onsemi 0:098463de4c5d 119
group-onsemi 0:098463de4c5d 120 /** De-initialise dongle.
group-onsemi 0:098463de4c5d 121 * The following actions are performed:
group-onsemi 0:098463de4c5d 122 * 1) Tear down PPP session
group-onsemi 0:098463de4c5d 123 * 2) Set SMS,USSD, and LinkMonitor subsystems to un-initialised
group-onsemi 0:098463de4c5d 124 * 3) Close the AT commands interface
group-onsemi 0:098463de4c5d 125 * 4) Tear down the USB connection to dongle
group-onsemi 0:098463de4c5d 126 */
group-onsemi 0:098463de4c5d 127 int cleanup();
group-onsemi 0:098463de4c5d 128
group-onsemi 0:098463de4c5d 129 private:
group-onsemi 0:098463de4c5d 130 WANDongle m_dongle; //< Interface to USB connected WAN dongle
group-onsemi 0:098463de4c5d 131
group-onsemi 0:098463de4c5d 132 USBSerialStream m_atStream; //< Serial interface to AT channel on modem
group-onsemi 0:098463de4c5d 133 USBSerialStream m_pppStream; //< Serial interface to PPP channel on modem
group-onsemi 0:098463de4c5d 134
group-onsemi 0:098463de4c5d 135 ATCommandsInterface m_at; //< Interface to AT commands processing
group-onsemi 0:098463de4c5d 136
group-onsemi 0:098463de4c5d 137 GSMSMSInterface m_sms; //< Interface to SMS manager (send/receive etc)
group-onsemi 0:098463de4c5d 138 USSDInterface m_ussd; //< Interface to USSD manager (send etc)
group-onsemi 0:098463de4c5d 139 LinkMonitor m_linkMonitor; //< Interface to link monitor (RSSI)
group-onsemi 0:098463de4c5d 140
group-onsemi 0:098463de4c5d 141 PPPIPInterface m_ppp; //< Interface to PPP conection manager (IP assignment etc)
group-onsemi 0:098463de4c5d 142
group-onsemi 0:098463de4c5d 143 bool m_dongleConnected; //< Is the dongle physically connected (does the USB stack respond)? true/false
group-onsemi 0:098463de4c5d 144 bool m_ipInit; //< Has PPIPInterface object (m_ppp) been initialised? true/false
group-onsemi 0:098463de4c5d 145 bool m_smsInit; //< Has SMSInterface object (m_sms) been initialised? true/false
group-onsemi 0:098463de4c5d 146 bool m_ussdInit; //< Has USSDInterface object (m_ussd) been initialised? true/false
group-onsemi 0:098463de4c5d 147 bool m_linkMonitorInit; //< Has LinkMonitor object (m_linkMonitor) been initialised? true/false
group-onsemi 0:098463de4c5d 148 bool m_atOpen; //< Is the interface to the ATCommandsInterface open? true/false
group-onsemi 0:098463de4c5d 149
group-onsemi 0:098463de4c5d 150 PinName m_powerGatingPin; //< Pin which toggles power gating
group-onsemi 0:098463de4c5d 151 bool m_powerGatingOnWhenPinHigh; //< Semantics of power gating (whether high or low toggles power gating)
group-onsemi 0:098463de4c5d 152 };
group-onsemi 0:098463de4c5d 153
group-onsemi 0:098463de4c5d 154
group-onsemi 0:098463de4c5d 155 #endif /* UBLOXMODEM_H_ */