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 #define MAX_SM 8
00030 
00031 /** Component to use the Short Messages Service (SMS)
00032  *
00033  */
00034 class SMSInterface : protected IATCommandsProcessor, IATEventsHandler
00035 {
00036 public:
00037   /** Create SMSInterface instance
00038      @param pIf Pointer to the ATCommandsInterface instance to use
00039    */
00040   SMSInterface(ATCommandsInterface* pIf);
00041 
00042   /** Initialize interface
00043     Configure SMS commands & register for SMS-related unsolicited result codes
00044    */
00045   int init();
00046 
00047   /** Send a SM
00048      @param number The receiver's phone number
00049      @param message The message to send
00050      @return 0 on success, error code on failure
00051    */
00052   int send(const char* number, const char* message);
00053 
00054 
00055   /** Receive a SM
00056      @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)
00057      @param message Pointer to a buffer to store the the incoming message
00058      @param maxLength Maximum message length that can be stored in buffer (including null-terminating character)
00059      @return 0 on success, error code on failure
00060    */
00061   int get(char* number, char* message, size_t maxLength);
00062 
00063 
00064   /** Get the number of SMs in the incoming box
00065      @param pCount pointer to store the number of unprocessed SMs on
00066      @return 0 on success, error code on failure
00067    */
00068   int getCount(size_t* pCount);
00069 
00070 protected:
00071   //IATCommandsProcessor
00072   virtual int onNewATResponseLine(ATCommandsInterface* pInst, const char* line);
00073   virtual int onNewEntryPrompt(ATCommandsInterface* pInst);
00074 
00075   //IATEventsHandler
00076   virtual bool isATCodeHandled(const char* atCode); //Is this AT code handled
00077   virtual void onDispatchStart();
00078   virtual void onDispatchStop();
00079   virtual char* getEventsEnableCommand();
00080   virtual char* getEventsDisableCommand();
00081   virtual void onEvent(const char* atCode, const char* evt);
00082 
00083   //Updates messages count/references
00084   int updateInbox();
00085 
00086 private:
00087   ATCommandsInterface* m_pIf;
00088 
00089   //Current message
00090   char* m_msg;
00091   size_t m_maxMsgLength;
00092   char* m_msisdn;
00093 
00094   //Messages list
00095   int m_msgRefList[MAX_SM];
00096   size_t m_msgRefListCount;
00097   bool m_needsUpdate;
00098   Mutex m_inboxMtx; //To protect concurrent accesses btw the user's thread and the AT thread
00099 
00100   enum { SMS_IDLE, SMS_SEND_CMD_SENT, SMS_GET_CMD_SENT, SMS_GET_HDR_RECEIVED, SMS_GET_COUNT_CMD_SENT, SMS_GET_COUNT_HDR_RECEIVED, SMS_CMD_PROCESSED } m_state;
00101 };
00102 
00103 #endif /* SMSINTERFACE_H_ */