From a34945661d36c1f0f64c4d4b5689d8a800e32778 Mon Sep 17 00:00:00 2001 From: Bogdan Marinescu Date: Thu, 17 Oct 2013 15:40:46 +0300 Subject: [PATCH] Added CellularModem as an abstract base class for modem implementations Now both UbloxUSBGSMModem and UbloxUSBCDMAModem inherit from CellularModem. --- .../cellular/CellularModem/CellularModem.h | 78 +++++++++++++++++++ .../UbloxUSBModem/UbloxUSBCDMAModem.h | 17 ++-- .../cellular/UbloxUSBModem/UbloxUSBGSMModem.h | 17 ++-- 3 files changed, 96 insertions(+), 16 deletions(-) create mode 100644 libraries/net/cellular/CellularModem/CellularModem.h diff --git a/libraries/net/cellular/CellularModem/CellularModem.h b/libraries/net/cellular/CellularModem/CellularModem.h new file mode 100644 index 0000000000..fd47622c86 --- /dev/null +++ b/libraries/net/cellular/CellularModem/CellularModem.h @@ -0,0 +1,78 @@ +/* CellularModem.h */ +/* Copyright (C) 2013 mbed.org, MIT License + * + * Permission is hereby granted, free of charge, to any person obtaining a copy of this software + * and associated documentation files (the "Software"), to deal in the Software without restriction, + * including without limitation the rights to use, copy, modify, merge, publish, distribute, + * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all copies or + * substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ + +#ifndef CELLULARMODEM_H_ +#define CELLULARMODEM_H_ + +#include "core/fwk.h" +#include "at/ATCommandsInterface.h" + +class CellularModem +{ +public: + //Internet-related functions + + /** Open a 3G internet connection + @return 0 on success, error code on failure + */ + virtual int connect(const char* apn = NULL, const char* user = NULL, const char* password = NULL) = 0; + + /** Close the internet connection + @return 0 on success, error code on failure + */ + virtual int disconnect() = 0; + + + /** Send a SM + @param number The receiver's phone number + @param message The message to send + @return 0 on success, error code on failure + */ + virtual int sendSM(const char* number, const char* message) = 0; + + + /** Receive a SM + @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) + @param message Pointer to a buffer to store the the incoming message + @param maxLength Maximum message length that can be stored in buffer (including null-terminating character) + @return 0 on success, error code on failure + */ + virtual int getSM(char* number, char* message, size_t maxLength) = 0; + + /** Get the number of SMs in the incoming box + @param pCount pointer to store the number of unprocessed SMs on + @return 0 on success, error code on failure + */ + virtual int getSMCount(size_t* pCount) = 0; + + /** Get the ATCommandsInterface instance + @return Pointer to the ATCommandsInterface instance + */ + virtual ATCommandsInterface* getATCommandsInterface() = 0; + + /** Switch power on or off + In order to use this function, a pin name must have been entered in the constructor + @param enable true to switch the dongle on, false to switch it off + @return 0 on success, error code on failure + */ + virtual int power(bool enable) = 0; +}; + + +#endif /* CELLULARMODEM_H_ */ diff --git a/libraries/net/cellular/UbloxUSBModem/UbloxUSBCDMAModem.h b/libraries/net/cellular/UbloxUSBModem/UbloxUSBCDMAModem.h index d9e4f3133c..988afb29ad 100644 --- a/libraries/net/cellular/UbloxUSBModem/UbloxUSBCDMAModem.h +++ b/libraries/net/cellular/UbloxUSBModem/UbloxUSBCDMAModem.h @@ -27,10 +27,11 @@ #include "USBSerialStream.h" #include "ip/PPPIPInterface.h" #include "sms/CDMASMSInterface.h" +#include "CellularModem.h" /** u-blox LISA-C200 modem */ -class UbloxUSBCDMAModem +class UbloxUSBCDMAModem: public CellularModem { public: /** Create Sprint USB Modem (Sierra Wireless 598U) API instance @@ -44,12 +45,12 @@ public: /** Open a 3G internet connection @return 0 on success, error code on failure */ - int connect(const char* apn = NULL, const char* user = NULL, const char* password = NULL); + virtual int connect(const char* apn = NULL, const char* user = NULL, const char* password = NULL); /** Close the internet connection @return 0 on success, error code on failure */ - int disconnect(); + virtual int disconnect(); /** Send a SM @@ -57,7 +58,7 @@ public: @param message The message to send @return 0 on success, error code on failure */ - int sendSM(const char* number, const char* message); + virtual int sendSM(const char* number, const char* message); /** Receive a SM @@ -66,25 +67,25 @@ public: @param maxLength Maximum message length that can be stored in buffer (including null-terminating character) @return 0 on success, error code on failure */ - int getSM(char* number, char* message, size_t maxLength); + virtual int getSM(char* number, char* message, size_t maxLength); /** Get the number of SMs in the incoming box @param pCount pointer to store the number of unprocessed SMs on @return 0 on success, error code on failure */ - int getSMCount(size_t* pCount); + virtual int getSMCount(size_t* pCount); /** Get the ATCommandsInterface instance @return Pointer to the ATCommandsInterface instance */ - ATCommandsInterface* getATCommandsInterface(); + virtual ATCommandsInterface* getATCommandsInterface(); /** Switch power on or off In order to use this function, a pin name must have been entered in the constructor @param enable true to switch the dongle on, false to switch it off @return 0 on success, error code on failure */ - int power(bool enable); + virtual int power(bool enable); protected: bool power(); diff --git a/libraries/net/cellular/UbloxUSBModem/UbloxUSBGSMModem.h b/libraries/net/cellular/UbloxUSBModem/UbloxUSBGSMModem.h index 73cc2d0041..2cc432a2c2 100644 --- a/libraries/net/cellular/UbloxUSBModem/UbloxUSBGSMModem.h +++ b/libraries/net/cellular/UbloxUSBModem/UbloxUSBGSMModem.h @@ -29,10 +29,11 @@ #include "sms/GSMSMSInterface.h" #include "ussd/USSDInterface.h" #include "link/LinkMonitor.h" +#include "CellularModem.h" /** u-blox WCDMA modem (LISA-U200) */ -class UbloxUSBGSMModem +class UbloxUSBGSMModem: public CellularModem { public: /** Create u-blox API instance @@ -46,12 +47,12 @@ public: /** Open a 3G internet connection @return 0 on success, error code on failure */ - int connect(const char* apn = NULL, const char* user = NULL, const char* password = NULL); + virtual int connect(const char* apn = NULL, const char* user = NULL, const char* password = NULL); /** Close the internet connection @return 0 on success, error code on failure */ - int disconnect(); + virtual int disconnect(); /** Send a SM @@ -59,7 +60,7 @@ public: @param message The message to send @return 0 on success, error code on failure */ - int sendSM(const char* number, const char* message); + virtual int sendSM(const char* number, const char* message); /** Receive a SM @@ -68,13 +69,13 @@ public: @param maxLength Maximum message length that can be stored in buffer (including null-terminating character) @return 0 on success, error code on failure */ - int getSM(char* number, char* message, size_t maxLength); + virtual int getSM(char* number, char* message, size_t maxLength); /** Get the number of SMs in the incoming box @param pCount pointer to store the number of unprocessed SMs on @return 0 on success, error code on failure */ - int getSMCount(size_t* pCount); + virtual int getSMCount(size_t* pCount); /** Send a USSD command & wait for its result @param command The command to send @@ -95,14 +96,14 @@ public: /** Get the ATCommandsInterface instance @return Pointer to the ATCommandsInterface instance */ - ATCommandsInterface* getATCommandsInterface(); + virtual ATCommandsInterface* getATCommandsInterface(); /** Switch power on or off In order to use this function, a pin name must have been entered in the constructor @param enable true to switch the dongle on, false to switch it off @return 0 on success, error code on failure */ - int power(bool enable); + virtual int power(bool enable); protected: bool power(); //< Turn power to USB dongle ON.