Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

CellularSMS Class Reference
Public Member Functions | Protected Member Functions

CellularSMS Class Reference
[Cellular]

Class CellularSMS. More...

#include <CellularSMS.h>

Inherited by AT_CellularSMS.

Public Member Functions

virtual nsapi_error_t initialize (CellularSMSMmode mode, CellularSMSEncoding encoding=CellularSMSEncoding::CellularSMSEncoding7Bit)=0
 Does all the necessary initializations needed for receiving and sending SMS.
virtual nsapi_size_or_error_t send_sms (const char *phone_number, const char *message, int msg_len)=0
 Send the SMS with the given parameters.
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
 Gets the oldest received sms.
virtual void set_sms_callback (Callback< void()> func)=0
 Callback that is called when new SMS is received.
virtual nsapi_error_t set_cpms (const char *memr, const char *memw, const char *mems)=0
 CPMS preferred message storage.
virtual nsapi_error_t set_csca (const char *sca, int type)=0
 CSCA - set Service Center Address.
virtual nsapi_size_or_error_t set_cscs (const char *chr_set)=0
 Set command sets the current character set used by the device.
virtual nsapi_error_t delete_all_messages ()=0
 Deletes all messages from the currently set memory/SIM.
virtual void set_extra_sim_wait_time (int sim_wait_time)=0
 Some modems need extra time between AT commands and responses, or there will be error -314, SIM busy.

Protected Member Functions

virtual ~CellularSMS ()
 virtual Destructor

Detailed Description

Class CellularSMS.

An abstract interface for SMS sending, reading and deleting.

Definition at line 50 of file CellularSMS.h.

Constructor & Destructor Documentation

virtual ~CellularSMS (  ) [protected, virtual]

virtual Destructor

Definition at line 58 of file CellularSMS.h.

Member Function Documentation

virtual nsapi_error_t delete_all_messages (  ) [pure virtual]

Deletes all messages from the currently set memory/SIM.

Returns:
NSAPI_ERROR_OK on success NSAPI_ERROR_DEVICE_ERROR on failure

Implemented in AT_CellularSMS.

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 
) [pure virtual]

Gets the oldest received sms.

Parameters:
bufpreallocated buffer for SMS message content
buf_lenlength of allocated buf
phone_numpreallocated buffer for phone number where SMS was sent
phone_lenlength of allocated phone_num buffer
time_stamppreallocated 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.
time_lenlength of allocated time_stamp buffer
buf_sizeif method return error NSAPI_ERROR_NO_MEMORY because the given buf was not big enough, this holds the size which is enough. Otherwise zero.
Returns:
On success, length of the received SMS, (length of the buf, positive value) NSAPI_ERROR_PARAMETER if invalid parameters 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

Implemented in AT_CellularSMS.

virtual nsapi_error_t initialize ( CellularSMSMmode  mode,
CellularSMSEncoding  encoding = CellularSMSEncoding::CellularSMSEncoding7Bit 
) [pure virtual]

Does all the necessary initializations needed for receiving and sending SMS.

Parameters:
modeenumeration for choosing the correct mode: text/pdu
Returns:
NSAPI_ERROR_OK on success 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 
) [pure virtual]

Send the SMS with the given parameters.

Parameters:
phone_numberPhone number where to send SMS
messageSMS message content
msg_lenLength of the message
Returns:
On success, length of the sent SMS (positive value) NSAPI_ERROR_PARAMETER if invalid parameters NSAPI_ERROR_NO_MEMORY on memory failure NSAPI_ERROR_DEVICE_ERROR on other failures

Implemented in AT_CellularSMS.

virtual nsapi_error_t set_cpms ( const char *  memr,
const char *  memw,
const char *  mems 
) [pure virtual]

CPMS preferred message storage.

Parameters:
memrmemory from which messages are read and deleted "SM" - SIM SMS memory storage (default) "ME" - NVM SMS storage
memwmemory to which writing and sending operations are made "SM" - SIM SMS memory storage (default) "ME" - NVM SMS storage
memsmemory to which received SMs are preferred to be stored "SM" - SIM SMS memory storage (default) "ME" - NVM SMS storage
Returns:
NSAPI_ERROR_OK on success NSAPI_ERROR_DEVICE_ERROR on failure

Implemented in AT_CellularSMS.

virtual nsapi_error_t set_csca ( const char *  sca,
int  type 
) [pure virtual]

CSCA - set Service Center Address.

Parameters:
scaService Center Address to be used for mobile originated SMS transmissions.
type129 - national numbering scheme, 145 - international numbering scheme (contains the character "+")
Returns:
NSAPI_ERROR_OK on success NSAPI_ERROR_DEVICE_ERROR on failure

Implemented in AT_CellularSMS.

virtual nsapi_size_or_error_t set_cscs ( const char *  chr_set ) [pure virtual]

Set command sets the current character set used by the device.

"GSM", "IRA",....

Remarks:
Current implementation support only ASCII so choose the correct character set.
Parameters:
chr_setpreferred 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.
Returns:
Used character set index from the given list in case of success. NSAPI_ERROR_DEVICE_ERROR on failure

Implemented in AT_CellularSMS.

virtual void set_extra_sim_wait_time ( int  sim_wait_time ) [pure virtual]

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.

Parameters:
sim_wait_time

Implemented in AT_CellularSMS.

virtual void set_sms_callback ( Callback< void()>  func ) [pure virtual]

Callback that is called when new SMS is received.

SMS can be fetched using method get_sms().

Remarks:
In PDU mode, there can be multipart SMS, and callback is called for every received part.
Parameters:
funcCallback function that is called when new SMS is received.

Implemented in AT_CellularSMS.

Generated on Tue Jul 12 2022 13:55:43 by  doxygen 1.7.2