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.
AT_CellularSMS.h
00001 /* 00002 * Copyright (c) 2017, Arm Limited and affiliates. 00003 * SPDX-License-Identifier: Apache-2.0 00004 * 00005 * Licensed under the Apache License, Version 2.0 (the "License"); 00006 * you may not use this file except in compliance with the License. 00007 * You may obtain a copy of the License at 00008 * 00009 * http://www.apache.org/licenses/LICENSE-2.0 00010 * 00011 * Unless required by applicable law or agreed to in writing, software 00012 * distributed under the License is distributed on an "AS IS" BASIS, 00013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 00014 * See the License for the specific language governing permissions and 00015 * limitations under the License. 00016 */ 00017 00018 #ifndef AT_CELLULAR_SMS_H_ 00019 #define AT_CELLULAR_SMS_H_ 00020 00021 #include "CellularSMS.h" 00022 #include "AT_CellularBase.h" 00023 #include "Callback.h" 00024 #include <time.h> 00025 00026 namespace mbed { 00027 00028 /** 00029 * Class AT_CellularSMS 00030 * 00031 * Class for SMS sending, reading and deleting. 00032 */ 00033 class AT_CellularSMS: public CellularSMS, public AT_CellularBase { 00034 00035 public: 00036 AT_CellularSMS(ATHandler &atHandler); 00037 virtual ~AT_CellularSMS(); 00038 00039 public: 00040 // from CellularSMS 00041 00042 virtual nsapi_error_t initialize(CellularSMSMmode mode); 00043 00044 virtual nsapi_size_or_error_t send_sms(const char *phone_number, const char *message, int msg_len); 00045 00046 virtual nsapi_size_or_error_t get_sms(char *buf, uint16_t buf_len, char *phone_num, uint16_t phone_len, 00047 char *time_stamp, uint16_t time_len, int *buf_size); 00048 00049 virtual void set_sms_callback(Callback<void()> func); 00050 00051 virtual nsapi_error_t set_cpms(const char *memr, const char *memw, const char *mems); 00052 00053 virtual nsapi_error_t set_csca(const char *sca, int type); 00054 00055 virtual nsapi_size_or_error_t set_cscs(const char *chr_set); 00056 00057 virtual nsapi_error_t delete_all_messages(); 00058 00059 virtual void set_extra_sim_wait_time(int sim_wait_time); 00060 00061 private: 00062 00063 struct sms_info_t { 00064 char date[SMS_MAX_TIME_STAMP_SIZE]; 00065 uint16_t msg_index[50]; // can hold up to 50 concatenated msg parts, indexes are in correct order. So max sms size is 50*140 = 7kb 00066 uint16_t msg_size; 00067 uint8_t parts; 00068 uint8_t parts_added; 00069 uint16_t msg_ref_number; 00070 struct sms_info_t *next_info; 00071 sms_info_t() : msg_size(0), parts(1), parts_added(1), msg_ref_number(0), next_info(0) {}; 00072 }; 00073 00074 // application callback function for received sms 00075 Callback<void()> _cb; 00076 CellularSMSMmode _mode; 00077 bool _use_8bit_encoding; 00078 uint32_t _sim_wait_time; 00079 uint16_t _sms_message_ref_number; 00080 sms_info_t *_sms_info; 00081 00082 // SMS urc's 00083 void cmt_urc(); 00084 void cmti_urc(); 00085 00086 /** Set command selects the format of messages used with send, list, read and write commands. 00087 * 00088 * @param msg_format 0 PDU mode, 1 text mode 00089 * @return zero for success 00090 */ 00091 nsapi_error_t set_cmgf(int msg_format); 00092 00093 /** Set how receiving of new messages from the network is indicated to the TE. 00094 * 00095 * @return zero for success 00096 */ 00097 nsapi_error_t set_cnmi(); 00098 00099 /** Set Text Mode Parameters 00100 * 00101 * @param fo See more from 3GPP TS 27.005 for all params. 00102 * @param vp 00103 * @param pid 00104 * @param dcs 00105 * @return zero for success 00106 */ 00107 nsapi_error_t set_csmp(int fo, int vp, int pid, int dcs); 00108 00109 /** CSDH - Set command controls whether detailed header information is shown in text mode (AT+CMGF=1) result codes. 00110 * 00111 * @param show_header 1 to show detailed header in text mode, 0 for not showing. 00112 * @return zero for success 00113 */ 00114 nsapi_error_t set_csdh(int show_header); 00115 00116 /** Delete SMS in the given message position(s) in the storage 00117 * 00118 * @param sms struct containing index array to delete 00119 * @return zero for success 00120 */ 00121 nsapi_error_t delete_sms(sms_info_t *sms); 00122 00123 /** 00124 * Internal helper methods 00125 */ 00126 nsapi_error_t list_messages(); 00127 int read_sms_params(char *, char *); 00128 void free_linked_list(); 00129 void add_info(sms_info_t *info, int index, int part_number); 00130 int read_udh_from_pdu(const char *pdu, sms_info_t *info, int &part_number, int &padding_bits); 00131 nsapi_size_or_error_t get_data_from_pdu(const char *pdu, sms_info_t *info, int *part_number, 00132 char *phone_number = NULL, char *msg = NULL); 00133 nsapi_size_or_error_t read_pdu_payload(const char *pdu, int msg_len, int scheme, char *msg, int padding_bits); 00134 sms_info_t *get_oldest_sms_index(); 00135 bool create_time(const char *time_string, time_t *time); 00136 int compare_time_strings(const char *time_string_1, const char *time_string_2); 00137 char *create_pdu(const char *phone_number, const char *message, uint8_t message_length, uint8_t msg_parts, 00138 uint8_t msg_part_number, uint8_t &header_size); 00139 nsapi_size_or_error_t read_sms_from_index(int msg_index, char *buf, uint16_t len, char *phone_num, 00140 char *time_stamp); 00141 nsapi_size_or_error_t read_sms(sms_info_t *sms, char *buf, char *phone_num, char *time_stamp); 00142 00143 /** Packs the given str from ascii to 7bit gsm format and converts it to hex to the given buf. 00144 * 00145 * @param str string that is to be converted 00146 * @param len length of the str buffer 00147 * @param buf preallocated buffer that holds the converted string in hex format after successful call 00148 * @param number_of_padding_bit padding bits needed to keep the octet boundary 00149 * @return length of buffer buf or zero on failure 00150 */ 00151 uint16_t pack_7_bit_gsm_and_hex(const char *str, uint16_t len, char *buf, int number_of_padding_bit); 00152 00153 /** Unpacks the given hex- and 7-bit gsm encoded str to ascii string 00154 * 00155 * @param str string to convert to ascii string and write to buf 00156 * @param len length of the str divided by two as str is hexencoded 00157 * @param buf preallocated destination buffer 00158 * @param padding_bits number of padding bits needed to hold the octet boundary 00159 * @param msg_len Length of the received message, which is coded in str 00160 * @return length of the destination buffer buf 00161 * 00162 */ 00163 uint16_t unpack_7_bit_gsm_to_str(const char *str, int len, char *buf, int padding_bits, 00164 int msg_len); 00165 }; 00166 00167 } // namespace mbed 00168 00169 #endif // AT_CELLULAR_SMS_H_
Generated on Tue Aug 9 2022 00:37:03 by
