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.
sms/SMSInterface.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?
User | Revision | Line number | New contents of line |
---|---|---|---|
bogdanm | 1:4a23efdf0da9 | 1 | /* SMSInterface.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 ISMSINTERFACE_H_ |
bogdanm | 1:4a23efdf0da9 | 21 | #define ISMSINTERFACE_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 | #define MAX_SM 8 |
bogdanm | 1:4a23efdf0da9 | 30 | |
bogdanm | 1:4a23efdf0da9 | 31 | /** Component to use the Short Messages Service (SMS) |
bogdanm | 1:4a23efdf0da9 | 32 | * |
bogdanm | 1:4a23efdf0da9 | 33 | */ |
bogdanm | 1:4a23efdf0da9 | 34 | class ISMSInterface |
bogdanm | 1:4a23efdf0da9 | 35 | { |
bogdanm | 1:4a23efdf0da9 | 36 | public: |
bogdanm | 1:4a23efdf0da9 | 37 | /** Initialize interface |
bogdanm | 1:4a23efdf0da9 | 38 | Configure SMS commands & register for SMS-related unsolicited result codes |
bogdanm | 1:4a23efdf0da9 | 39 | */ |
bogdanm | 1:4a23efdf0da9 | 40 | virtual int init() = 0; |
bogdanm | 1:4a23efdf0da9 | 41 | |
bogdanm | 1:4a23efdf0da9 | 42 | |
bogdanm | 1:4a23efdf0da9 | 43 | /** Send a SM |
bogdanm | 1:4a23efdf0da9 | 44 | @param number The receiver's phone number |
bogdanm | 1:4a23efdf0da9 | 45 | @param message The message to send |
bogdanm | 1:4a23efdf0da9 | 46 | @return 0 on success, error code on failure |
bogdanm | 1:4a23efdf0da9 | 47 | */ |
bogdanm | 1:4a23efdf0da9 | 48 | virtual int send(const char* number, const char* message) = 0; |
bogdanm | 1:4a23efdf0da9 | 49 | |
bogdanm | 1:4a23efdf0da9 | 50 | |
bogdanm | 1:4a23efdf0da9 | 51 | /** Receive a SM |
bogdanm | 1:4a23efdf0da9 | 52 | @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) |
bogdanm | 1:4a23efdf0da9 | 53 | @param message Pointer to a buffer to store the the incoming message |
bogdanm | 1:4a23efdf0da9 | 54 | @param maxLength Maximum message length that can be stored in buffer (including null-terminating character) |
bogdanm | 1:4a23efdf0da9 | 55 | @return 0 on success, error code on failure |
bogdanm | 1:4a23efdf0da9 | 56 | */ |
bogdanm | 1:4a23efdf0da9 | 57 | virtual int get(char* number, char* message, size_t maxLength) = 0; |
bogdanm | 1:4a23efdf0da9 | 58 | |
bogdanm | 1:4a23efdf0da9 | 59 | |
bogdanm | 1:4a23efdf0da9 | 60 | /** Get the number of SMs in the incoming box |
bogdanm | 1:4a23efdf0da9 | 61 | @param pCount pointer to store the number of unprocessed SMs on |
bogdanm | 1:4a23efdf0da9 | 62 | @return 0 on success, error code on failure |
bogdanm | 1:4a23efdf0da9 | 63 | */ |
bogdanm | 1:4a23efdf0da9 | 64 | virtual int getCount(size_t* pCount) = 0; |
bogdanm | 1:4a23efdf0da9 | 65 | }; |
bogdanm | 1:4a23efdf0da9 | 66 | |
bogdanm | 1:4a23efdf0da9 | 67 | #endif /* ISMSINTERFACE_H_ */ |