mbed official / CellularModem

Base library for cellular modem implementations

Dependencies:   Socket lwip-sys lwip

Dependents:   CellularUSBModem CellularUSBModem

Deprecated

This is an mbed 2 networking library. For mbed 5, the networking libraries have been revised to better support additional network stacks and thread safety here.

ussd/USSDInterface.h@8:944cd194963e, 2014-05-08 (annotated)

Committer:
mbed_official
Date:
Thu May 08 11:00:26 2014 +0100
Revision:
8:944cd194963e
Parent:
1:4a23efdf0da9 
Synchronized with git revision df12bf01ac7dbb50751e2b16a351c894994e1dcf



Full URL: https://github.com/mbedmicro/mbed/commit/df12bf01ac7dbb50751e2b16a351c894994e1dcf/

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 1:4a23efdf0da9 1 /* USSDInterface.h */
bogdanm 1:4a23efdf0da9 2 /* Copyright (C) 2012 mbed.org, MIT License
bogdanm 1:4a23efdf0da9 3 *
bogdanm 1:4a23efdf0da9 4 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
bogdanm 1:4a23efdf0da9 5 * and associated documentation files (the "Software"), to deal in the Software without restriction,
bogdanm 1:4a23efdf0da9 6 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
bogdanm 1:4a23efdf0da9 7 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
bogdanm 1:4a23efdf0da9 8 * furnished to do so, subject to the following conditions:
bogdanm 1:4a23efdf0da9 9 *
bogdanm 1:4a23efdf0da9 10 * The above copyright notice and this permission notice shall be included in all copies or
bogdanm 1:4a23efdf0da9 11 * substantial portions of the Software.
bogdanm 1:4a23efdf0da9 12 *
bogdanm 1:4a23efdf0da9 13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
bogdanm 1:4a23efdf0da9 14 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
bogdanm 1:4a23efdf0da9 15 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
bogdanm 1:4a23efdf0da9 16 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
bogdanm 1:4a23efdf0da9 17 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
bogdanm 1:4a23efdf0da9 18 */
bogdanm 1:4a23efdf0da9 19
bogdanm 1:4a23efdf0da9 20 #ifndef USSDINTERFACE_H_
bogdanm 1:4a23efdf0da9 21 #define USSDINTERFACE_H_
bogdanm 1:4a23efdf0da9 22
bogdanm 1:4a23efdf0da9 23 #include "core/fwk.h"
bogdanm 1:4a23efdf0da9 24
bogdanm 1:4a23efdf0da9 25 #include "rtos.h"
bogdanm 1:4a23efdf0da9 26
bogdanm 1:4a23efdf0da9 27 #include "at/ATCommandsInterface.h"
bogdanm 1:4a23efdf0da9 28
bogdanm 1:4a23efdf0da9 29 /** Component to send/receive Unstructured Supplementary Service Data (USSD)
bogdanm 1:4a23efdf0da9 30 *
bogdanm 1:4a23efdf0da9 31 */
bogdanm 1:4a23efdf0da9 32 class USSDInterface : protected IATCommandsProcessor, IATEventsHandler
bogdanm 1:4a23efdf0da9 33 {
bogdanm 1:4a23efdf0da9 34 public:
bogdanm 1:4a23efdf0da9 35 /** Create USSDInterface instance
bogdanm 1:4a23efdf0da9 36 @param pIf Pointer to the ATCommandsInterface instance to use
bogdanm 1:4a23efdf0da9 37 */
bogdanm 1:4a23efdf0da9 38 USSDInterface(ATCommandsInterface* pIf);
bogdanm 1:4a23efdf0da9 39
bogdanm 1:4a23efdf0da9 40 /** Initialize interface
bogdanm 1:4a23efdf0da9 41 Configure USSD commands & register for USSD-related unsolicited result codes
bogdanm 1:4a23efdf0da9 42 */
bogdanm 1:4a23efdf0da9 43 int init();
bogdanm 1:4a23efdf0da9 44
bogdanm 1:4a23efdf0da9 45 /** Send a USSD command & wait for its result
bogdanm 1:4a23efdf0da9 46 @param command The command to send
bogdanm 1:4a23efdf0da9 47 @param result Buffer in which to store the result
bogdanm 1:4a23efdf0da9 48 @param maxLength Maximum result length that can be stored in buffer (including null-terminating character)
bogdanm 1:4a23efdf0da9 49 @return 0 on success, error code on failure
bogdanm 1:4a23efdf0da9 50 */
bogdanm 1:4a23efdf0da9 51 int send(const char* command, char* result, size_t maxLength);
bogdanm 1:4a23efdf0da9 52
bogdanm 1:4a23efdf0da9 53 protected:
bogdanm 1:4a23efdf0da9 54 //IATCommandsProcessor, needed for implementations of 3GGP standard < r06
bogdanm 1:4a23efdf0da9 55 virtual int onNewATResponseLine(ATCommandsInterface* pInst, const char* line);
bogdanm 1:4a23efdf0da9 56 virtual int onNewEntryPrompt(ATCommandsInterface* pInst);
bogdanm 1:4a23efdf0da9 57
bogdanm 1:4a23efdf0da9 58 //IATEventsHandler, needed for implementations of 3GGP standard >= r06
bogdanm 1:4a23efdf0da9 59 virtual bool isATCodeHandled(const char* atCode); //Is this AT code handled
bogdanm 1:4a23efdf0da9 60 virtual void onDispatchStart();
bogdanm 1:4a23efdf0da9 61 virtual void onDispatchStop();
bogdanm 1:4a23efdf0da9 62 virtual char* getEventsEnableCommand();
bogdanm 1:4a23efdf0da9 63 virtual char* getEventsDisableCommand();
bogdanm 1:4a23efdf0da9 64 virtual void onEvent(const char* atCode, const char* evt);
bogdanm 1:4a23efdf0da9 65
bogdanm 1:4a23efdf0da9 66 private:
bogdanm 1:4a23efdf0da9 67 void processResult(const char* data);
bogdanm 1:4a23efdf0da9 68
bogdanm 1:4a23efdf0da9 69 ATCommandsInterface* m_pIf;
bogdanm 1:4a23efdf0da9 70 Mutex m_responseMtx; //To protect concurrent accesses btw the user's thread and the AT thread
bogdanm 1:4a23efdf0da9 71 Semaphore m_responseSphre;
bogdanm 1:4a23efdf0da9 72
bogdanm 1:4a23efdf0da9 73 //Result
bogdanm 1:4a23efdf0da9 74 volatile char* m_result;
bogdanm 1:4a23efdf0da9 75 volatile size_t m_maxResultLength;
bogdanm 1:4a23efdf0da9 76
bogdanm 1:4a23efdf0da9 77 };
bogdanm 1:4a23efdf0da9 78
bogdanm 1:4a23efdf0da9 79
bogdanm 1:4a23efdf0da9 80 #endif /* USSDINTERFACE_H_ */