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@68:c490e4a51778, 2013-12-24 (annotated)

Committer:
sgodinez
Date:
Tue Dec 24 01:15:44 2013 +0000
Revision:
68:c490e4a51778
Parent:
62:83ccef1e94db
Child:
71:82205735732b
Moved timeout functionality to MTSBufferedIO calls. Improved sendCmd.

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