ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Copy edit CellularSMS.h 

Copy edit file for parallelism, consistent capitalization and minor grammar nits.
pull/7768/head
Amanda Butler 2018-08-20 15:41:25 -05:00 committed by GitHub
parent 23da904f8e
commit 9f5a71a7bb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
features/cellular/framework/API/CellularSMS.h
View File

@ -57,53 +57,53 @@ public:
CellularSMSMmodeText
};
/** Does all the necessary initializations needed for receiving and sending sms.
/** Does all the necessary initializations needed for receiving and sending SMS.
*
* @param mode enumeration for choosing the correct mode: text/pdu
* @return NSAPI_ERROR_OK on success
* NSAPI_ERROR_NO_MEMORY on case of memory failure
* NSAPI_ERROR_DEVICE_ERROR on case of other failures
* NSAPI_ERROR_NO_MEMORY on memory failure
* NSAPI_ERROR_DEVICE_ERROR on other failures
*/
virtual nsapi_error_t initialize(CellularSMSMmode mode) = 0;
/** Send the SMS with the given parameters
*
* @param phone_number Phone number where to send sms
* @param phone_number Phone number where to send SMS
* @param message SMS message content
* @param msg_len Length of the message
* @return On success, length of the sent sms (positive value)
* @return On success, length of the sent SMS (positive value)
* NSAPI_ERROR_PARAMETER if invalid parameters
* NSAPI_ERROR_NO_MEMORY on case of memory failure
* NSAPI_ERROR_DEVICE_ERROR on case of other failures
* NSAPI_ERROR_NO_MEMORY on memory failure
* NSAPI_ERROR_DEVICE_ERROR on other failures
*/
virtual nsapi_size_or_error_t send_sms(const char *phone_number, const char *message, int msg_len) = 0;
/** Gets the oldest received sms.
*
* @param buf preallocated buffer for sms message content
* @param buf preallocated buffer for SMS message content
* @param buf_len length of allocated buf
* @param phone_num preallocated buffer for phone number where sms was sent
* @param phone_num preallocated buffer for phone number where SMS was sent
* @param phone_len length of allocated phone_num buffer
* @param time_stamp preallocated buffer for TP-Service Centre Time Stamp (format: yy/MM/dd,hh:mm:ss-+zz). +-zz is timezone.
* The unit of time zone is a quarter of an hour relative to GMT. For example +32 would be GMT+8.
* @param time_len length of allocated time_stamp buffer
* @param buf_size if method return error NSAPI_ERROR_NO_MEMORY because the given buf was not big enough this will
* hold the size which is enough. Otherwise zero.
* @return On success, length of the received sms, (length of the buf, positive value)
* @param buf_size if method return error NSAPI_ERROR_NO_MEMORY because the given buf was not big enough, this
* holds the size which is enough. Otherwise zero.
* @return On success, length of the received SMS, (length of the buf, positive value)
* NSAPI_ERROR_PARAMETER if invalid parameters
* NSAPI_ERROR_NO_MEMORY on case of memory failure
* SMS_ERROR_MULTIPART_ALL_PARTS_NOT_READ if sms was multipart but not all parts are present/failed to read.
* -1 if no sms was found
* NSAPI_ERROR_DEVICE_ERROR on case of other failures
* NSAPI_ERROR_NO_MEMORY on memory failure
* SMS_ERROR_MULTIPART_ALL_PARTS_NOT_READ if SMS was multipart but not all parts are present/failed to read.
* -1 if no SMS was found
* NSAPI_ERROR_DEVICE_ERROR on other failures
*/
virtual nsapi_size_or_error_t get_sms(char *buf, uint16_t buf_len, char *phone_num, uint16_t phone_len,
char *time_stamp, uint16_t time_len, int *buf_size) = 0;
/** Callback which is called when new sms is received. SMS can be fetched via method get_sms().
/** Callback that is called when new SMS is received. SMS can be fetched using method get_sms().
*
* @remark In PDU mode there can be multipart sms and callback is called for every received part.
* @remark In PDU mode, there can be multipart SMS, and callback is called for every received part.
*
* @param func Callback function which is called when new sms is received.
* @param func Callback function that is called when new SMS is received.
*/
virtual void set_sms_callback(Callback<void()> func) = 0;
@ -120,7 +120,7 @@ public:
* "ME" - NVM SMS storage
*
* @return NSAPI_ERROR_OK on success
* NSAPI_ERROR_DEVICE_ERROR on case of failure
* NSAPI_ERROR_DEVICE_ERROR on failure
*/
virtual nsapi_error_t set_cpms(const char *memr, const char *memw, const char *mems) = 0;
@ -130,7 +130,7 @@ public:
* @param type 129 - national numbering scheme, 145 - international numbering scheme (contains the character "+")
*
* @return NSAPI_ERROR_OK on success
* NSAPI_ERROR_DEVICE_ERROR on case of failure
* NSAPI_ERROR_DEVICE_ERROR on failure
*/
virtual nsapi_error_t set_csca(const char *sca, int type) = 0;
@ -138,24 +138,24 @@ public:
*
* @remark Current implementation support only ASCII so choose the correct character set.
*
* @param chr_set preferred character set list (comma separated). Modem might not support the wanted character set
* @param chr_set preferred character set list (comma separated). Modem might not support the wanted character set,
* so chr_set list is looped from start until supported set is found. Used character set index is returned.
* See more from 3GPP TS 27.005.
* @return Used character set index from the given list in case of success.
* NSAPI_ERROR_DEVICE_ERROR on case of failure
* NSAPI_ERROR_DEVICE_ERROR on failure
*/
virtual nsapi_size_or_error_t set_cscs(const char *chr_set) = 0;
/** Deletes all messages from the currently set memory/SIM
*
* @return NSAPI_ERROR_OK on success
* NSAPI_ERROR_DEVICE_ERROR on case of failure
* NSAPI_ERROR_DEVICE_ERROR on failure
*/
virtual nsapi_error_t delete_all_messages() = 0;
/** Some modems need extra time between AT commands and responses or there will be error -314, SIM busy.
* If SIM busy errors are an issue this time should be increased. It can also be set to zero to make
* operations faster and more energy efficient if no errors will follow. By default wait time is zero.
/** Some modems need extra time between AT commands and responses, or there will be error -314, SIM busy.
* If SIM busy errors are an issue, this time should be increased. It can also be set to zero to make
* operations faster and more energy efficient if no errors will follow. By default, wait time is zero.
*
* @param sim_wait_time
*/