Multi-Hackers / SocketModem

A library for talking to Multi-Tech's Cellular SocketModem Devices.

Dependents:   M2X_dev axeda_wrapper_dev MTS_M2x_Example1 MTS_Cellular_Connect_Example ... more

cellular/Cellular.h@87:5db6c084adc7, 2013-12-27 (annotated)

Committer:
jengbrecht
Date:
Fri Dec 27 16:47:09 2013 +0000
Revision:
87:5db6c084adc7
Parent:
82:5aa75004e553
Child:
89:9e5da66e4f1e
Updated First example in Cellular and tested, also moved getCodeNames from Cellular to vars

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jengbrecht 0:563b70517320 1 #ifndef CELLULAR_H
jengbrecht 0:563b70517320 2 #define CELLULAR_H
jengbrecht 0:563b70517320 3
sgodinez 11:134435d8a2d5 4 #include "IPStack.h"
sgodinez 11:134435d8a2d5 5 #include "MTSBufferedIO.h"
jengbrecht 0:563b70517320 6 #include "mbed.h"
jengbrecht 0:563b70517320 7 #include <string>
sgodinez 4:6561c9128c6f 8 #include <vector>
jengbrecht 0:563b70517320 9
jengbrecht 56:e5e5351f14b3 10 namespace mts
jengbrecht 56:e5e5351f14b3 11 {
mfiore 39:6e94520a3217 12
jengbrecht 36:bb6b293c7495 13 /** This is a class for communicating with a Multi-Tech Systems SocketModem iCell. The
jengbrecht 27:8e6188cbcfd4 14 * SocketModem iCell is a family of carrier certified embedded cellular radio modules with
jengbrecht 27:8e6188cbcfd4 15 * a common hardware footprint and AT command set for built in IP-stack functionality.
jengbrecht 36:bb6b293c7495 16 * This class supports three main types of cellular radio interactions including:
jengbrecht 27:8e6188cbcfd4 17 * configuration and status AT command processing, SMS processing, and TCP/UDP Socket
jengbrecht 36:bb6b293c7495 18 * data connections. It should be noted that the radio can not process commands or
jengbrecht 27:8e6188cbcfd4 19 * SMS messages while having an open data connection at the same time. The concurrent
jengbrecht 27:8e6188cbcfd4 20 * capability may be added in a future release. This class also inherits from IPStack
jengbrecht 27:8e6188cbcfd4 21 * providing a common set of commands for communication devices that have an onboard
jengbrecht 27:8e6188cbcfd4 22 * IP Stack. It is also integrated with the standard Mbed Sockets package and can therefore
jengbrecht 27:8e6188cbcfd4 23 * be used seamlessly with clients and services built on top of this interface already within
jengbrecht 56:e5e5351f14b3 24 * the mbed library.
jengbrecht 36:bb6b293c7495 25 *
jengbrecht 27:8e6188cbcfd4 26 * All of the following examples use the Pin Names for the Freedom KL46Z board coupled with
jengbrecht 36:bb6b293c7495 27 * the SocketModem Shield Arduino compatible board. Please chage Pin Names accordingly to
jengbrecht 27:8e6188cbcfd4 28 * match your hardware configuration. It also assumes the use of RTS/CTS hardware handshaking
jengbrecht 27:8e6188cbcfd4 29 * using GPIOs. To disable this you will need to change settings on the radio module and
jengbrecht 27:8e6188cbcfd4 30 * and use the MTSSerial class instead of MTSSerialFlowControl. The default baud rate for the
jengbrecht 27:8e6188cbcfd4 31 * cellular radio is 115200 bps.
jengbrecht 36:bb6b293c7495 32 *
jengbrecht 27:8e6188cbcfd4 33 * The following set of example code demonstrates how to send and receive configuration and
jengbrecht 62:83ccef1e94db 34 * status AT commands with the radio, create a data connection and test it:
jengbrecht 27:8e6188cbcfd4 35 * @code
jengbrecht 27:8e6188cbcfd4 36 * #include "mbed.h"
jengbrecht 27:8e6188cbcfd4 37 * #include "Cellular.h"
jengbrecht 27:8e6188cbcfd4 38 * #include "MTSSerialFlowControl.h"
jengbrecht 36:bb6b293c7495 39 *
jengbrecht 62:83ccef1e94db 40 * using namespace mts;
jengbrecht 82:5aa75004e553 41 *
jengbrecht 27:8e6188cbcfd4 42 * main() {
jengbrecht 27:8e6188cbcfd4 43 * //Wait for radio to boot up
jengbrecht 87:5db6c084adc7 44 * for (int i = 30; i >= 0; i = i - 5) {
jengbrecht 87:5db6c084adc7 45 * wait(5);
jengbrecht 87:5db6c084adc7 46 * printf("Waiting %d seconds...\n\r", i);
jengbrecht 87:5db6c084adc7 47 * }
jengbrecht 36:bb6b293c7495 48 *
jengbrecht 27:8e6188cbcfd4 49 * //Setup serial interface to radio
jengbrecht 27:8e6188cbcfd4 50 * MTSSerialFlowControl* serial = new MTSSerialFlowControl(PTD3, PTD2, PTA12, PTC8);
jengbrecht 27:8e6188cbcfd4 51 * serial->baud(115200);
jengbrecht 27:8e6188cbcfd4 52 *
jengbrecht 27:8e6188cbcfd4 53 * //Setup Cellular class
jengbrecht 56:e5e5351f14b3 54 * Cellular* cellular = Cellular::getInstance();
jengbrecht 56:e5e5351f14b3 55 * cellular->init(serial);
jengbrecht 36:bb6b293c7495 56 *
jengbrecht 62:83ccef1e94db 57 * //Run status and configuration commands
jengbrecht 87:5db6c084adc7 58 * printf("\n\r////Start Status and Configuration Commands////\n\r");
jengbrecht 87:5db6c084adc7 59 * printf("Command Test: %s\n\r", getCodeNames(cellular->test()).c_str());
jengbrecht 62:83ccef1e94db 60 * printf("Signal Strength: %d\n\r", cellular->getSignalStrength());
jengbrecht 62:83ccef1e94db 61 * printf("Registration State: %s\n\r", Cellular::getRegistrationNames(cellular->getRegistration()).c_str());
jengbrecht 87:5db6c084adc7 62 * printf("Send Basic Command (AT): %s\n\r", getCodeNames(cellular->sendBasicCommand("AT", 1000)).c_str());
jengbrecht 62:83ccef1e94db 63 * printf("Send Command (AT+CSQ): %s\n\r", cellular->sendCommand("AT+CSQ", 1000).c_str());
jengbrecht 82:5aa75004e553 64 *
jengbrecht 27:8e6188cbcfd4 65 * //Start Test
jengbrecht 87:5db6c084adc7 66 * printf("\n\r////Start Network Connectivity Test////\n\r");
jengbrecht 87:5db6c084adc7 67 * printf("Set APN: %s\n\r", getCodeNames(cellular->setApn("wap.cingular")).c_str()); //Use APN from service provider!!!
jengbrecht 36:bb6b293c7495 68 *
jengbrecht 27:8e6188cbcfd4 69 * //Setup a data connection
jengbrecht 87:5db6c084adc7 70 * printf("Attempting to Connect, this may take some time...\n\r");
jengbrecht 87:5db6c084adc7 71 * while (!cellular->connect()) {
jengbrecht 87:5db6c084adc7 72 * printf("Failed to connect... Trying again.\n\r");
jengbrecht 27:8e6188cbcfd4 73 * wait(1);
jengbrecht 27:8e6188cbcfd4 74 * }
jengbrecht 62:83ccef1e94db 75 * printf("Connected to the Network!\n\r");
jengbrecht 36:bb6b293c7495 76 *
jengbrecht 27:8e6188cbcfd4 77 * //Try pinging default server "8.8.8.8"
jengbrecht 27:8e6188cbcfd4 78 * printf("Ping Valid: %s\n\r", cellular->ping() ? "true" : "false");
jengbrecht 36:bb6b293c7495 79 *
jengbrecht 27:8e6188cbcfd4 80 * printf("End Program\n\r");
jengbrecht 27:8e6188cbcfd4 81 * }
jengbrecht 27:8e6188cbcfd4 82 * @endcode
jengbrecht 36:bb6b293c7495 83 *
jengbrecht 62:83ccef1e94db 84 * The following set of example code demonstrates how process SMS messages:
jengbrecht 62:83ccef1e94db 85 * @code
jengbrecht 62:83ccef1e94db 86 * #include "mbed.h"
jengbrecht 62:83ccef1e94db 87 * #include "Cellular.h"
jengbrecht 62:83ccef1e94db 88 * #include "MTSSerialFlowControl.h"
jengbrecht 62:83ccef1e94db 89 *
jengbrecht 62:83ccef1e94db 90 * using namespace mts;
jengbrecht 82:5aa75004e553 91 *
jengbrecht 62:83ccef1e94db 92 * main() {
jengbrecht 62:83ccef1e94db 93 * //Wait for radio to boot up
jengbrecht 62:83ccef1e94db 94 * wait(30);
jengbrecht 62:83ccef1e94db 95 *
jengbrecht 62:83ccef1e94db 96 * //Setup serial interface to radio
jengbrecht 62:83ccef1e94db 97 * MTSSerialFlowControl* serial = new MTSSerialFlowControl(PTD3, PTD2, PTA12, PTC8);
jengbrecht 62:83ccef1e94db 98 * serial->baud(115200);
jengbrecht 62:83ccef1e94db 99 *
jengbrecht 62:83ccef1e94db 100 * //Setup Cellular class
jengbrecht 62:83ccef1e94db 101 * Cellular* cellular = Cellular::getInstance();
jengbrecht 62:83ccef1e94db 102 * cellular->init(serial);
jengbrecht 82:5aa75004e553 103 *
jengbrecht 62:83ccef1e94db 104 * //Start test
jengbrecht 62:83ccef1e94db 105 * printf("Test: %s\n\r", Cellular::getCodeNames(cellular->test()).c_str());
jengbrecht 82:5aa75004e553 106 *
jengbrecht 62:83ccef1e94db 107 * //Send SMS Message
jengbrecht 62:83ccef1e94db 108 * Cellular::Code code;
jengbrecht 62:83ccef1e94db 109 * std::string sMsg("Hello from Multi-Tech MBED!");
jengbrecht 62:83ccef1e94db 110 * std::string sPhoneNum("16128675309"); //Put your phone number here or leave Jenny's...
jengbrecht 82:5aa75004e553 111 *
jengbrecht 62:83ccef1e94db 112 * printf("Sending message [%s] to [%s]\r\n", sMsg.c_str(), sPhoneNum.c_str());
jengbrecht 62:83ccef1e94db 113 * code = cellular->sendSMS(sPhoneNum, sMsg);
jengbrecht 82:5aa75004e553 114 *
jengbrecht 62:83ccef1e94db 115 * if(code != Cellular::CELL_OK) {
jengbrecht 62:83ccef1e94db 116 * printf("Error during SMS send [%s]\r\n", Cellular::getCodeNames(code).c_str());
jengbrecht 62:83ccef1e94db 117 * } else {
jengbrecht 62:83ccef1e94db 118 * printf("Success!\r\n");
jengbrecht 62:83ccef1e94db 119 * }
jengbrecht 82:5aa75004e553 120 *
jengbrecht 62:83ccef1e94db 121 * //Try and receive SMS messages
jengbrecht 62:83ccef1e94db 122 * //To determine your radio's phone number send yourself an SMS and check the received #
jengbrecht 62:83ccef1e94db 123 * printf("Checking Received Messages\r\n");
jengbrecht 62:83ccef1e94db 124 * std::vector<Cellular::Sms> vSms = cellular->getReceivedSms();
jengbrecht 62:83ccef1e94db 125 * printf("\r\n");
jengbrecht 62:83ccef1e94db 126 * for(unsigned int i = 0; i < vSms.size(); i++) {
jengbrecht 82:5aa75004e553 127 * printf("[%d][%s][%s][%s]\r\n", i, vSms[i].timestamp.c_str(),
jengbrecht 62:83ccef1e94db 128 * vSms[i].phoneNumber.c_str(), vSms[i].message.c_str());
jengbrecht 62:83ccef1e94db 129 * }
jengbrecht 62:83ccef1e94db 130 * printf("End Program\n\r");
jengbrecht 62:83ccef1e94db 131 * }
jengbrecht 62:83ccef1e94db 132 * @endcode
jengbrecht 62:83ccef1e94db 133 *
jengbrecht 27:8e6188cbcfd4 134 * The following set of example code demonstrates how to setup and use a TCP socket connection
jengbrecht 27:8e6188cbcfd4 135 * using the native commands from this class:
jengbrecht 27:8e6188cbcfd4 136 * @code
jengbrecht 27:8e6188cbcfd4 137 * #include "mbed.h"
jengbrecht 62:83ccef1e94db 138 * #include "Cellular.h"
jengbrecht 62:83ccef1e94db 139 * #include "MTSSerialFlowControl.h"
jengbrecht 62:83ccef1e94db 140 *
jengbrecht 62:83ccef1e94db 141 * using namespace mts;
jengbrecht 82:5aa75004e553 142 *
jengbrecht 62:83ccef1e94db 143 * main() {
jengbrecht 62:83ccef1e94db 144 * //Define connection parameters
jengbrecht 62:83ccef1e94db 145 * Cellular::Code code;
jengbrecht 62:83ccef1e94db 146 * const int TEST_PORT = 7000;
jengbrecht 82:5aa75004e553 147 * //const std::string TEST_SERVER("204.26.122.5");
jengbrecht 62:83ccef1e94db 148 * const std::string TEST_SERVER("ws://echo.websocket.org");
jengbrecht 62:83ccef1e94db 149 *
jengbrecht 62:83ccef1e94db 150 * //Wait for radio to boot up
jengbrecht 62:83ccef1e94db 151 * wait(30);
jengbrecht 62:83ccef1e94db 152 *
jengbrecht 62:83ccef1e94db 153 * //Setup serial interface to radio
jengbrecht 62:83ccef1e94db 154 * MTSSerialFlowControl* serial = new MTSSerialFlowControl(PTD3, PTD2, PTA12, PTC8);
jengbrecht 62:83ccef1e94db 155 * serial->baud(115200);
jengbrecht 62:83ccef1e94db 156 *
jengbrecht 62:83ccef1e94db 157 * //Setup Cellular class
jengbrecht 62:83ccef1e94db 158 * Cellular* cellular = Cellular::getInstance();
jengbrecht 62:83ccef1e94db 159 * cellular->init(serial);
jengbrecht 82:5aa75004e553 160 *
jengbrecht 62:83ccef1e94db 161 * //Start test
jengbrecht 62:83ccef1e94db 162 * printf("Test: %s\n\r", Cellular::getCodeNames(cellular->test()).c_str());
jengbrecht 82:5aa75004e553 163 *
jengbrecht 62:83ccef1e94db 164 * printf("Setting APN\r\n");
jengbrecht 62:83ccef1e94db 165 * code = cellular->setApn("wap.cingular"); // Use from your service provider
jengbrecht 62:83ccef1e94db 166 * if(code == Cellular::CELL_OK) {
jengbrecht 62:83ccef1e94db 167 * printf("Success!\r\n");
jengbrecht 62:83ccef1e94db 168 * } else {
jengbrecht 62:83ccef1e94db 169 * printf("Error during APN setup [%s]\r\n", cellular->getCodeNames(code).c_str());
jengbrecht 62:83ccef1e94db 170 * }
jengbrecht 62:83ccef1e94db 171 *
jengbrecht 62:83ccef1e94db 172 * printf("Signal Strength: %d\n\r", cellular->getSignalStrength());
jengbrecht 62:83ccef1e94db 173 * printf("Registration State: %s\n\r", Cellular::getRegistrationNames(cellular->getRegistration()).c_str());
jengbrecht 62:83ccef1e94db 174 *
jengbrecht 62:83ccef1e94db 175 * //Setup a data connection
jengbrecht 62:83ccef1e94db 176 * printf("Attempting to Connect\n\r");
jengbrecht 62:83ccef1e94db 177 * while (cellular->connect()) {
jengbrecht 62:83ccef1e94db 178 * wait(1);
jengbrecht 62:83ccef1e94db 179 * }
jengbrecht 82:5aa75004e553 180 * printf("Connected to the Network!\n\r");
jengbrecht 82:5aa75004e553 181 *
jengbrecht 62:83ccef1e94db 182 * printf("Opening a TCP Socket\r\n");
jengbrecht 62:83ccef1e94db 183 * if(cellular->open(TEST_SERVER, TEST_PORT, IPStack::TCP)) {
jengbrecht 82:5aa75004e553 184 * printf("Success!\r\n");
jengbrecht 62:83ccef1e94db 185 * } else {
jengbrecht 62:83ccef1e94db 186 * printf("Error during TCP socket open [%s:%d]\r\n", TEST_SERVER.c_str(), TEST_PORT);
jengbrecht 62:83ccef1e94db 187 * }
jengbrecht 82:5aa75004e553 188 *
jengbrecht 62:83ccef1e94db 189 * printf("Writing to socket\r\n");
jengbrecht 62:83ccef1e94db 190 * char data[] = "My Test Echo Message!!!";
jengbrecht 62:83ccef1e94db 191 * int bytesWritten = cellular->write(data, sizeof(data), 10000);
jengbrecht 62:83ccef1e94db 192 * if(bytesWritten == sizeof(data)) {
jengbrecht 62:83ccef1e94db 193 * printf("Successfully wrote message!\r\n");
jengbrecht 62:83ccef1e94db 194 * } else {
jengbrecht 82:5aa75004e553 195 * printf("Failed to write message!\r\n");
jengbrecht 62:83ccef1e94db 196 * }
jengbrecht 82:5aa75004e553 197 *
jengbrecht 62:83ccef1e94db 198 * printf("Waiting 5 seconds\r\n");
jengbrecht 62:83ccef1e94db 199 * wait(5);
jengbrecht 62:83ccef1e94db 200 *
jengbrecht 62:83ccef1e94db 201 * printf("Reading from socket for 10 seconds\r\n");
jengbrecht 62:83ccef1e94db 202 * char response[sizeof(data)];
jengbrecht 62:83ccef1e94db 203 * int bytesRead = cellular->read(response, sizeof(data), 10000);
jengbrecht 62:83ccef1e94db 204 * printf("READ: [%d] [%s]\r\n", bytesRead, response);
jengbrecht 82:5aa75004e553 205 *
jengbrecht 62:83ccef1e94db 206 * printf("Closing socket\r\n");
jengbrecht 62:83ccef1e94db 207 * cellular->close();
jengbrecht 82:5aa75004e553 208 *
jengbrecht 62:83ccef1e94db 209 * printf("Disconnecting\r\n");
jengbrecht 62:83ccef1e94db 210 * cellular->disconnect();
jengbrecht 82:5aa75004e553 211 *
jengbrecht 62:83ccef1e94db 212 * printf("End Program\n\r");
jengbrecht 62:83ccef1e94db 213 * }
jengbrecht 27:8e6188cbcfd4 214 * @endcode
jengbrecht 27:8e6188cbcfd4 215 *
jengbrecht 27:8e6188cbcfd4 216 * The following set of example code demonstrates how to setup and use a TCP socket connection
jengbrecht 27:8e6188cbcfd4 217 * using the Mbed compatible Socket interfaces.
jengbrecht 27:8e6188cbcfd4 218 * @code
jengbrecht 27:8e6188cbcfd4 219 * #include "mbed.h"
jengbrecht 27:8e6188cbcfd4 220 * @endcode
jengbrecht 27:8e6188cbcfd4 221 */
jengbrecht 23:bc6f98a1eb22 222
mfiore 39:6e94520a3217 223 class Cellular : virtual mts::IPStack
jengbrecht 0:563b70517320 224 {
jengbrecht 0:563b70517320 225 public:
jengbrecht 0:563b70517320 226
jengbrecht 27:8e6188cbcfd4 227 /// An enumeration of radio registration states with a cell tower.
jengbrecht 0:563b70517320 228 enum Registration {
jengbrecht 0:563b70517320 229 NOT_REGISTERED, REGISTERED, SEARCHING, DENIED, UNKNOWN, ROAMING
jengbrecht 0:563b70517320 230 };
jengbrecht 0:563b70517320 231
jengbrecht 56:e5e5351f14b3 232 /** This structure contains the data for an SMS message.
jengbrecht 56:e5e5351f14b3 233 */
sgodinez 4:6561c9128c6f 234 struct Sms {
jengbrecht 56:e5e5351f14b3 235 /// Message Phone Number
jengbrecht 27:8e6188cbcfd4 236 std::string phoneNumber;
jengbrecht 56:e5e5351f14b3 237 /// Message Body
jengbrecht 27:8e6188cbcfd4 238 std::string message;
jengbrecht 56:e5e5351f14b3 239 /// Message Timestamp
jengbrecht 27:8e6188cbcfd4 240 std::string timestamp;
sgodinez 4:6561c9128c6f 241 };
jengbrecht 27:8e6188cbcfd4 242
jengbrecht 27:8e6188cbcfd4 243 /** Destructs a Cellular object and frees all related resources.
jengbrecht 27:8e6188cbcfd4 244 */
jengbrecht 0:563b70517320 245 ~Cellular();
jengbrecht 27:8e6188cbcfd4 246
jengbrecht 56:e5e5351f14b3 247 /** This static function is used to create or get a reference to a
jengbrecht 56:e5e5351f14b3 248 * Cellular object. Cellular uses the singleton pattern, which means
jengbrecht 56:e5e5351f14b3 249 * that you can only have one existing at a time. The first time you
jengbrecht 56:e5e5351f14b3 250 * call getInstance this method creates a new uninitialized Cellular
jengbrecht 56:e5e5351f14b3 251 * object and returns it. All future calls to this method will return
jengbrecht 56:e5e5351f14b3 252 * a reference to the instance created during the first call. Note that
jengbrecht 56:e5e5351f14b3 253 * you must call init on the returned instance before mnaking any other
jengbrecht 56:e5e5351f14b3 254 * calls. If using this class'e bindings to any of the Socket package
jengbrecht 56:e5e5351f14b3 255 * classes like TCPSocketConnection, you must call this method and the
jengbrecht 56:e5e5351f14b3 256 * init method on the returned object first, before even creating the
jengbrecht 56:e5e5351f14b3 257 * other objects.
jengbrecht 56:e5e5351f14b3 258 *
jengbrecht 56:e5e5351f14b3 259 * @returns a reference to the single Cellular obect that has been created.
jengbrecht 56:e5e5351f14b3 260 */
sgodinez 19:38794784e009 261 static Cellular* getInstance();
jengbrecht 82:5aa75004e553 262
jengbrecht 56:e5e5351f14b3 263 /** This method initializes the object with the underlying radio
jengbrecht 56:e5e5351f14b3 264 * interface to use. Note that this function MUST be called before
jengbrecht 56:e5e5351f14b3 265 * any other calls will function correctly on an Cellular object. Also
jengbrecht 56:e5e5351f14b3 266 * note that MTSBufferedIO is abstract, so you must use one of
jengbrecht 82:5aa75004e553 267 * its inherited classes like MTSSerial or MTSSerialFlowControl.
jengbrecht 56:e5e5351f14b3 268 *
jengbrecht 56:e5e5351f14b3 269 * @param io the buffered io interface that is attached to the cellular
jengbrecht 56:e5e5351f14b3 270 * radio.
jengbrecht 82:5aa75004e553 271 * @param DCD this is the dcd signal from the radio. If attached the
jengbrecht 82:5aa75004e553 272 * the pin must be passed in here for this class to operate correctly.
jengbrecht 82:5aa75004e553 273 * The default is not connected.
jengbrecht 82:5aa75004e553 274 * @param DTR this is the dtr signal from the radio. If attached the
jengbrecht 82:5aa75004e553 275 * the pin must be passed in here for this class to operate correctly.
jengbrecht 82:5aa75004e553 276 * The default is not connected.
jengbrecht 56:e5e5351f14b3 277 * @returns true if the init was successful, otherwise false.
jengbrecht 56:e5e5351f14b3 278 */
jengbrecht 82:5aa75004e553 279 bool init(MTSBufferedIO* io, PinName DCD = NC, PinName DTR = NC);
jengbrecht 0:563b70517320 280
jengbrecht 36:bb6b293c7495 281 // Radio link related commands
jengbrecht 27:8e6188cbcfd4 282 /** This method establishes a data connection on the cellular radio.
jengbrecht 27:8e6188cbcfd4 283 * Note that before calling you must have an activated radio and if
jengbrecht 27:8e6188cbcfd4 284 * using a SIM card set the APN using the setApn method. The APN can
jengbrecht 27:8e6188cbcfd4 285 * be obtained from your cellular service provider.
jengbrecht 27:8e6188cbcfd4 286 *
jengbrecht 27:8e6188cbcfd4 287 * @returns true if the connection was successfully established, otherwise
jengbrecht 27:8e6188cbcfd4 288 * false on an error.
jengbrecht 27:8e6188cbcfd4 289 */
jengbrecht 27:8e6188cbcfd4 290 virtual bool connect();
jengbrecht 27:8e6188cbcfd4 291
jengbrecht 27:8e6188cbcfd4 292 /** This method is used to stop a previously established cellular data connection.
jengbrecht 27:8e6188cbcfd4 293 */
sgodinez 11:134435d8a2d5 294 virtual void disconnect();
jengbrecht 27:8e6188cbcfd4 295
jengbrecht 27:8e6188cbcfd4 296 /** This method is used to check if the radio currently has a data connection
jengbrecht 27:8e6188cbcfd4 297 * established.
jengbrecht 27:8e6188cbcfd4 298 *
jengbrecht 27:8e6188cbcfd4 299 * @returns true if a data connection exists, otherwise false.
jengbrecht 27:8e6188cbcfd4 300 */
sgodinez 11:134435d8a2d5 301 virtual bool isConnected();
jengbrecht 56:e5e5351f14b3 302
jengbrecht 36:bb6b293c7495 303 // TCP and UDP Socket related commands
jengbrecht 36:bb6b293c7495 304 // For behavior of the following methods refer to IPStack.h documentation
sgodinez 11:134435d8a2d5 305 virtual bool bind(unsigned int port);
sgodinez 11:134435d8a2d5 306 virtual bool open(const std::string& address, unsigned int port, Mode mode);
sgodinez 11:134435d8a2d5 307 virtual bool isOpen();
sgodinez 17:2d7c4ea7491b 308 virtual bool close();
sgodinez 11:134435d8a2d5 309 virtual int read(char* data, int max, int timeout = -1);
sgodinez 41:81d035fb0b6a 310 virtual int write(const char* data, int length, int timeout = -1);
sgodinez 11:134435d8a2d5 311 virtual unsigned int readable();
sgodinez 11:134435d8a2d5 312 virtual unsigned int writeable();
jengbrecht 27:8e6188cbcfd4 313
sgodinez 11:134435d8a2d5 314 //Other
mfiore 29:7408b1bdad37 315 /** A method to reset the Multi-Tech Socket Modem. This command brings down the
mfiore 29:7408b1bdad37 316 * PPP link if it is up. After this function is called, at least 30 seconds should
mfiore 29:7408b1bdad37 317 * be allowed for the cellular radio to come back up before any other Cellular
mfiore 29:7408b1bdad37 318 * functions are called.
mfiore 29:7408b1bdad37 319 */
mfiore 29:7408b1bdad37 320 /** this needs to be investigated. After we tell the radio to reset and wait 30 seconds,
mfiore 29:7408b1bdad37 321 * we can't seem to get it to respond to even a simple signal strength query.
mfiore 29:7408b1bdad37 322 */
jengbrecht 27:8e6188cbcfd4 323 virtual void reset();
sgodinez 11:134435d8a2d5 324
sgodinez 11:134435d8a2d5 325 //Cellular Radio Specific
jengbrecht 27:8e6188cbcfd4 326 /** A method for sending a generic AT command to the radio. Note that you cannot
jengbrecht 27:8e6188cbcfd4 327 * send commands and have a data connection at the same time.
jengbrecht 36:bb6b293c7495 328 *
jengbrecht 27:8e6188cbcfd4 329 * @param command the command to send to the radio without the escape character.
jengbrecht 27:8e6188cbcfd4 330 * @param timeoutMillis the time in millis to wait for a response before returning.
jengbrecht 27:8e6188cbcfd4 331 * @param esc escape character to add at the end of the command, defaults to
sgodinez 71:82205735732b 332 * carriage return (CR). Does not append any character if esc == 0.
jengbrecht 27:8e6188cbcfd4 333 * @returns all data received from the radio after the command as a string.
jengbrecht 27:8e6188cbcfd4 334 */
sgodinez 71:82205735732b 335 std::string sendCommand(const std::string& command, unsigned int timeoutMillis, char esc = CR);
jengbrecht 36:bb6b293c7495 336
jengbrecht 36:bb6b293c7495 337 /** A method for sending a basic AT command to the radio. A basic AT command is
jengbrecht 27:8e6188cbcfd4 338 * one that simply has a response of either OK or ERROR without any other information.
jengbrecht 27:8e6188cbcfd4 339 * Note that you cannot send commands and have a data connection at the same time.
jengbrecht 36:bb6b293c7495 340 *
jengbrecht 27:8e6188cbcfd4 341 * @param command the command to send to the radio without the escape character.
jengbrecht 27:8e6188cbcfd4 342 * @param timeoutMillis the time in millis to wait for a response before returning.
jengbrecht 27:8e6188cbcfd4 343 * @param esc escape character to add at the end of the command, defaults to
jengbrecht 27:8e6188cbcfd4 344 * carriage return (CR).
jengbrecht 27:8e6188cbcfd4 345 * @returns the standard AT Code enumeration.
jengbrecht 27:8e6188cbcfd4 346 */
sgodinez 71:82205735732b 347 Code sendBasicCommand(const std::string& command, unsigned int timeoutMillis, char esc = CR);
sgodinez 11:134435d8a2d5 348
jengbrecht 23:bc6f98a1eb22 349 /** A method for testing command access to the radio. This method sends the
jengbrecht 27:8e6188cbcfd4 350 * command "AT" to the radio, which is a standard radio test to see if you
jengbrecht 23:bc6f98a1eb22 351 * have command access to the radio.
jengbrecht 23:bc6f98a1eb22 352 *
jengbrecht 23:bc6f98a1eb22 353 * @returns the standard AT Code enumeration.
jengbrecht 23:bc6f98a1eb22 354 */
sgodinez 11:134435d8a2d5 355 Code test();
jengbrecht 27:8e6188cbcfd4 356
jengbrecht 23:bc6f98a1eb22 357 /** A method for configuring command ehco capability on the radio. This command
jengbrecht 23:bc6f98a1eb22 358 * sets whether sent characters are echoed back from the radio, in which case you
jengbrecht 23:bc6f98a1eb22 359 * will receive back every command you send.
jengbrecht 23:bc6f98a1eb22 360 *
jengbrecht 23:bc6f98a1eb22 361 * @param state if true echo will be turned off, otherwise it will be turned on.
jengbrecht 23:bc6f98a1eb22 362 * @returns the standard AT Code enumeration.
jengbrecht 23:bc6f98a1eb22 363 */
mfiore 29:7408b1bdad37 364 Code echo(bool state);
jengbrecht 36:bb6b293c7495 365
jengbrecht 23:bc6f98a1eb22 366 /** A method for getting the signal strength of the radio. This method allows you to
jengbrecht 23:bc6f98a1eb22 367 * get a value that maps to signal strength in dBm. Here 0-1 is Poor, 2-9 is Marginal,
jengbrecht 23:bc6f98a1eb22 368 * 10-14 is Ok, 15-19 is Good, and 20+ is Excellent. If you get a result of 99 the
jengbrecht 27:8e6188cbcfd4 369 * signal strength is not known or not detectable.
jengbrecht 23:bc6f98a1eb22 370 *
jengbrecht 23:bc6f98a1eb22 371 * @returns an integer representing the signal strength.
jengbrecht 23:bc6f98a1eb22 372 */
jengbrecht 0:563b70517320 373 int getSignalStrength();
jengbrecht 36:bb6b293c7495 374
jengbrecht 27:8e6188cbcfd4 375 /** This method is used to check the registration state of the radio with the cell tower.
jengbrecht 27:8e6188cbcfd4 376 * If not appropriatley registered with the tower you cannot make a cellular connection.
jengbrecht 27:8e6188cbcfd4 377 *
jengbrecht 27:8e6188cbcfd4 378 * @returns the registration state as an enumeration type.
jengbrecht 27:8e6188cbcfd4 379 */
sgodinez 5:93e889a5abc6 380 Registration getRegistration();
jengbrecht 27:8e6188cbcfd4 381
jengbrecht 27:8e6188cbcfd4 382 /** This method is used to set the radios APN if using a SIM card. Note that the APN
jengbrecht 27:8e6188cbcfd4 383 * must be set correctly before you can make a data connection. The APN for your SIM
jengbrecht 27:8e6188cbcfd4 384 * can be obtained by contacting your cellular service provider.
jengbrecht 27:8e6188cbcfd4 385 *
jengbrecht 27:8e6188cbcfd4 386 * @param the APN as a string.
jengbrecht 27:8e6188cbcfd4 387 * @returns the standard AT Code enumeration.
jengbrecht 27:8e6188cbcfd4 388 */
sgodinez 11:134435d8a2d5 389 Code setApn(const std::string& apn);
jengbrecht 27:8e6188cbcfd4 390
jengbrecht 27:8e6188cbcfd4 391 /** This method is used to set the DNS which enables the use of URLs instead
jengbrecht 27:8e6188cbcfd4 392 * of IP addresses when making a socket connection.
jengbrecht 27:8e6188cbcfd4 393 *
jengbrecht 27:8e6188cbcfd4 394 * @param the DNS server address as a string in form xxx.xxx.xxx.xxx.
jengbrecht 27:8e6188cbcfd4 395 * @returns the standard AT Code enumeration.
jengbrecht 27:8e6188cbcfd4 396 */
sgodinez 41:81d035fb0b6a 397 Code setDns(const std::string& primary, const std::string& secondary = "0.0.0.0");
jengbrecht 27:8e6188cbcfd4 398
jengbrecht 27:8e6188cbcfd4 399 /** This method is used test network connectivity by pinging a server.
jengbrecht 27:8e6188cbcfd4 400 *
jengbrecht 27:8e6188cbcfd4 401 * @param address the address of the server in format xxx.xxx.xxx.xxx.
jengbrecht 27:8e6188cbcfd4 402 * @returns true if the ping was successful, otherwise false.
jengbrecht 27:8e6188cbcfd4 403 */
jengbrecht 23:bc6f98a1eb22 404 bool ping(const std::string& address = "8.8.8.8");
jengbrecht 56:e5e5351f14b3 405
jengbrecht 56:e5e5351f14b3 406 /** This method can be used to trade socket functionality for performance.
jengbrecht 56:e5e5351f14b3 407 * In order to enable a socket connection to be closed by the client side programtically,
jengbrecht 56:e5e5351f14b3 408 * this class must process all read and write data on the socket to guard the special
jengbrecht 56:e5e5351f14b3 409 * escape character used to close an open socket connection. It is recommened that you
jengbrecht 56:e5e5351f14b3 410 * use the default of true unless the overhead of these operations is too significant.
jengbrecht 56:e5e5351f14b3 411 *
jengbrecht 56:e5e5351f14b3 412 * @param enabled set to true if you want the socket closeable, otherwise false. The default
jengbrecht 56:e5e5351f14b3 413 * is true.
jengbrecht 56:e5e5351f14b3 414 * @returns the standard AT Code enumeration.
jengbrecht 56:e5e5351f14b3 415 */
sgodinez 17:2d7c4ea7491b 416 Code setSocketCloseable(bool enabled = true); //ETX closes socket (ETX and DLE in payload are escaped with DLE)
jengbrecht 27:8e6188cbcfd4 417
jengbrecht 27:8e6188cbcfd4 418 /** This method is used to send an SMS message. Note that you cannot send an
jengbrecht 27:8e6188cbcfd4 419 * SMS message and have a data connection open at the same time.
jengbrecht 27:8e6188cbcfd4 420 *
jengbrecht 27:8e6188cbcfd4 421 * @param phoneNumber the phone number to send the message to as a string.
jengbrecht 27:8e6188cbcfd4 422 * @param message the text message to be sent.
jengbrecht 27:8e6188cbcfd4 423 * @returns the standard AT Code enumeration.
jengbrecht 27:8e6188cbcfd4 424 */
jengbrecht 27:8e6188cbcfd4 425 Code sendSMS(const std::string& phoneNumber, const std::string& message);
jengbrecht 36:bb6b293c7495 426
jengbrecht 27:8e6188cbcfd4 427 /** This method is used to send an SMS message. Note that you cannot send an
jengbrecht 27:8e6188cbcfd4 428 * SMS message and have a data connection open at the same time.
jengbrecht 27:8e6188cbcfd4 429 *
jengbrecht 27:8e6188cbcfd4 430 * @param sms an Sms struct that contains all SMS transaction information.
jengbrecht 27:8e6188cbcfd4 431 * @returns the standard AT Code enumeration.
jengbrecht 27:8e6188cbcfd4 432 */
sgodinez 4:6561c9128c6f 433 Code sendSMS(const Sms& sms);
jengbrecht 36:bb6b293c7495 434
jengbrecht 56:e5e5351f14b3 435 /** This method retrieves all of the SMS messages currently available for
jengbrecht 56:e5e5351f14b3 436 * this phone number.
jengbrecht 27:8e6188cbcfd4 437 *
jengbrecht 56:e5e5351f14b3 438 * @returns a vector of existing SMS messages each as an Sms struct.
jengbrecht 27:8e6188cbcfd4 439 */
sgodinez 4:6561c9128c6f 440 std::vector<Cellular::Sms> getReceivedSms();
jengbrecht 56:e5e5351f14b3 441
jengbrecht 56:e5e5351f14b3 442 /** This method can be used to remove/delete all received SMS messages
jengbrecht 56:e5e5351f14b3 443 * even if they have never been retrieved or read.
jengbrecht 56:e5e5351f14b3 444 *
jengbrecht 56:e5e5351f14b3 445 * @returns the standard AT Code enumeration.
jengbrecht 56:e5e5351f14b3 446 */
sgodinez 4:6561c9128c6f 447 Code deleteAllReceivedSms();
jengbrecht 56:e5e5351f14b3 448
jengbrecht 56:e5e5351f14b3 449 /** This method can be used to remove/delete all received SMS messages
jengbrecht 56:e5e5351f14b3 450 * that have been retrieved by the user through the getReceivedSms method.
jengbrecht 56:e5e5351f14b3 451 * Messages that have not been retrieved yet will be unaffected.
jengbrecht 56:e5e5351f14b3 452 *
jengbrecht 56:e5e5351f14b3 453 * @returns the standard AT Code enumeration.
jengbrecht 56:e5e5351f14b3 454 */
sgodinez 4:6561c9128c6f 455 Code deleteOnlyReceivedReadSms();
sgodinez 19:38794784e009 456
jengbrecht 56:e5e5351f14b3 457 /** A static method for getting a string representation for the Registration
jengbrecht 56:e5e5351f14b3 458 * enumeration.
jengbrecht 56:e5e5351f14b3 459 *
jengbrecht 56:e5e5351f14b3 460 * @param code a Registration enumeration.
jengbrecht 56:e5e5351f14b3 461 * @returns the enumeration name as a string.
jengbrecht 56:e5e5351f14b3 462 */
jengbrecht 56:e5e5351f14b3 463 static std::string getRegistrationNames(Registration registration);
jengbrecht 27:8e6188cbcfd4 464
jengbrecht 0:563b70517320 465 private:
jengbrecht 23:bc6f98a1eb22 466 static Cellular* instance; //Static pointer to the single Cellular object.
sgodinez 19:38794784e009 467
jengbrecht 23:bc6f98a1eb22 468 MTSBufferedIO* io; //IO interface obect that the radio is accessed through.
jengbrecht 23:bc6f98a1eb22 469 bool echoMode; //Specifies if the echo mode is currently enabled.
jengbrecht 27:8e6188cbcfd4 470
jengbrecht 23:bc6f98a1eb22 471 bool pppConnected; //Specifies if a PPP session is currently connected.
jengbrecht 23:bc6f98a1eb22 472 std::string apn; //A string that holds the APN for the radio.
jengbrecht 27:8e6188cbcfd4 473
jengbrecht 56:e5e5351f14b3 474 Mode mode; //The current socket Mode.
jengbrecht 23:bc6f98a1eb22 475 bool socketOpened; //Specifies if a Socket is presently opened.
jengbrecht 23:bc6f98a1eb22 476 bool socketCloseable; //Specifies is a Socket can be closed.
jengbrecht 27:8e6188cbcfd4 477 unsigned int local_port; //Holds the local port for socket connections.
jengbrecht 27:8e6188cbcfd4 478 std::string local_address; //Holds the local address for socket connections.
jengbrecht 27:8e6188cbcfd4 479 unsigned int host_port; //Holds the remote port for socket connections.
jengbrecht 27:8e6188cbcfd4 480 std::string host_address; //Holds the remote address for socket connections.
jengbrecht 56:e5e5351f14b3 481 DigitalIn* dcd; //Maps to the radios dcd signal
jengbrecht 56:e5e5351f14b3 482 DigitalOut* dtr; //Maps to the radios dtr signal
sgodinez 11:134435d8a2d5 483
jengbrecht 23:bc6f98a1eb22 484 Cellular(); //Private constructor, use the getInstance() method.
mfiore 29:7408b1bdad37 485 Cellular(MTSBufferedIO* io); //Private constructor, use the getInstance() method.
jengbrecht 0:563b70517320 486 };
jengbrecht 0:563b70517320 487
mfiore 39:6e94520a3217 488 }
mfiore 39:6e94520a3217 489
jengbrecht 0:563b70517320 490 #endif /* CELLULAR_H */