PHS module SMA-01 library. see: https://developer.mbed.org/users/phsfan/notebook/abitusbmodem/

Dependencies:   Socket lwip-sys lwip

Dependents:   AbitUSBModem_HTTPTest AbitUSBModem_MQTTTest AbitUSBModem_WebsocketTest AbitUSBModem_SMSTest

Fork of VodafoneUSBModem by mbed official

Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers SMSInterface.h Source File

SMSInterface.h

00001 /* SMSInterface.h */
00002 /* Copyright (C) 2012 mbed.org, MIT License
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
00005  * and associated documentation files (the "Software"), to deal in the Software without restriction,
00006  * including without limitation the rights to use, copy, modify, merge, publish, distribute,
00007  * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
00008  * furnished to do so, subject to the following conditions:
00009  *
00010  * The above copyright notice and this permission notice shall be included in all copies or
00011  * substantial portions of the Software.
00012  *
00013  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
00014  * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
00015  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
00016  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00017  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00018  */
00019 
00020 #ifndef SMSINTERFACE_H_
00021 #define SMSINTERFACE_H_
00022 
00023 #include "core/fwk.h"
00024 
00025 #include "rtos.h"
00026 
00027 #include "at/ATCommandsInterface.h"
00028 
00029 /** Component to use the Short Messages Service (SMS)
00030  *
00031  */
00032 class SMSInterface : protected IATCommandsProcessor, IATEventsHandler
00033 {
00034 public:
00035   /** Create SMSInterface instance
00036      @param pIf Pointer to the ATCommandsInterface instance to use
00037    */
00038   SMSInterface(ATCommandsInterface* pIf);
00039 
00040   /** Initialize interface
00041     Configure SMS commands & register for SMS-related unsolicited result codes
00042    */
00043   int init();
00044 
00045   /** Send a SM
00046      @param number The receiver's phone number
00047      @param message The message to send
00048      @return 0 on success, error code on failure
00049    */
00050   int send(const char* number, const char* message);
00051 
00052 
00053   /** Receive a SM
00054      @param number Pointer to a buffer to store the sender's phone number (must be at least 17 characters-long, including the space for the null-terminating char)
00055      @param message Pointer to a buffer to store the the incoming message
00056      @param maxLength Maximum message length that can be stored in buffer (including null-terminating character)
00057      @return 0 on success, error code on failure
00058    */
00059   int get(char* number, char* message, size_t maxLength);
00060 
00061 protected:
00062   //IATCommandsProcessor
00063   virtual int onNewATResponseLine(ATCommandsInterface* pInst, const char* line);
00064   virtual int onNewEntryPrompt(ATCommandsInterface* pInst);
00065 
00066   //IATEventsHandler
00067   virtual bool isATCodeHandled(const char* atCode); //Is this AT code handled
00068   virtual void onDispatchStart();
00069   virtual void onDispatchStop();
00070   virtual char* getEventsEnableCommand();
00071   virtual char* getEventsDisableCommand();
00072   virtual void onEvent(const char* atCode, const char* evt);
00073 
00074 private:
00075   ATCommandsInterface* m_pIf;
00076 
00077   //Current message
00078   char* m_msg;
00079   size_t m_maxMsgLength;
00080   char* m_msisdn;
00081   char m_caller[12];
00082 
00083   enum { SMS_IDLE, SMS_SEND_CMD_SENT, SMS_GET_CMD_SENT, SMS_RING, SMS_CMD_BUSY, SMS_CMD_PROCESSED } m_state;
00084 };
00085 
00086 #endif /* SMSINTERFACE_H_ */