Keil Studio Cloud
Mistake on this page?
Report an issue in GitHub or email us
AT_CellularSMS.h
1 /*
2  * Copyright (c) 2017, Arm Limited and affiliates.
3  * SPDX-License-Identifier: Apache-2.0
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #ifndef AT_CELLULAR_SMS_H_
19 #define AT_CELLULAR_SMS_H_
20 
21 #if MBED_CONF_CELLULAR_USE_SMS
22 
23 #include "CellularSMS.h"
24 #include "ATHandler.h"
25 #include "Callback.h"
26 #include "AT_CellularDevice.h"
27 #include <time.h>
28 
29 namespace mbed {
30 
31 /**
32  * Class AT_CellularSMS
33  *
34  * Class for SMS sending, reading and deleting.
35  */
36 class AT_CellularSMS: public CellularSMS {
37 
38 public:
39  AT_CellularSMS(ATHandler &atHandler, AT_CellularDevice &device);
40  virtual ~AT_CellularSMS();
41 
42 public:
43  // from CellularSMS
44 
45  virtual nsapi_error_t initialize(CellularSMSMmode mode,
46  CellularSMSEncoding encoding = CellularSMSEncoding7Bit);
47 
48  virtual nsapi_size_or_error_t send_sms(const char *phone_number, const char *message, int msg_len);
49 
50  virtual nsapi_size_or_error_t get_sms(char *buf, uint16_t buf_len, char *phone_num, uint16_t phone_len,
51  char *time_stamp, uint16_t time_len, int *buf_size);
52 
53  virtual void set_sms_callback(Callback<void()> func);
54 
55  virtual nsapi_error_t set_cpms(const char *memr, const char *memw, const char *mems);
56 
57  virtual nsapi_error_t set_csca(const char *sca, int type);
58 
59  virtual nsapi_size_or_error_t set_cscs(const char *chr_set);
60 
61  virtual nsapi_error_t delete_all_messages();
62 
63  virtual void set_extra_sim_wait_time(int sim_wait_time);
64 
65 private:
66  struct sms_info_t {
67  char date[SMS_MAX_TIME_STAMP_SIZE];
68  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
69  uint16_t msg_size;
70  uint8_t parts;
71  uint8_t parts_added;
72  uint16_t msg_ref_number;
73  struct sms_info_t *next_info;
74  sms_info_t() : msg_size(0), parts(1), parts_added(1), msg_ref_number(0), next_info(0) {};
75  };
76 
77  // SMS urc's
78  void cmt_urc();
79  void cmti_urc();
80 
81  /** Set command selects the format of messages used with send, list, read and write commands.
82  *
83  * @param msg_format 0 PDU mode, 1 text mode
84  * @return zero for success
85  */
86  nsapi_error_t set_cmgf(int msg_format);
87 
88  /** Set how receiving of new messages from the network is indicated to the TE.
89  *
90  * @return zero for success
91  */
92  nsapi_error_t set_cnmi();
93 
94  /** Set Text Mode Parameters
95  *
96  * @param fo See more from 3GPP TS 27.005 for all params.
97  * @param vp
98  * @param pid
99  * @param dcs
100  * @return zero for success
101  */
102  nsapi_error_t set_csmp(int fo, int vp, int pid, int dcs);
103 
104  /** CSDH - Set command controls whether detailed header information is shown in text mode (AT+CMGF=1) result codes.
105  *
106  * @param show_header 1 to show detailed header in text mode, 0 for not showing.
107  * @return zero for success
108  */
109  nsapi_error_t set_csdh(int show_header);
110 
111  /** Delete SMS in the given message position(s) in the storage
112  *
113  * @param sms struct containing index array to delete
114  * @return zero for success
115  */
116  nsapi_error_t delete_sms(sms_info_t *sms);
117 
118  /**
119  * Internal helper methods
120  */
121  nsapi_error_t list_messages();
122  int read_sms_params(char *, char *);
123  void free_linked_list();
124  void add_info(sms_info_t *info, int index, int part_number);
125  int read_udh_from_pdu(const char *pdu, sms_info_t *info, int &part_number, int &padding_bits);
126  nsapi_size_or_error_t get_data_from_pdu(const char *pdu, sms_info_t *info, int *part_number,
127  char *phone_number = NULL, char *msg = NULL);
128  nsapi_size_or_error_t read_pdu_payload(const char *pdu, int msg_len, int scheme, char *msg, int padding_bits);
129  sms_info_t *get_oldest_sms_index();
130  bool create_time(const char *time_string, time_t *time);
131  int compare_time_strings(const char *time_string_1, const char *time_string_2);
132  char *create_pdu(const char *phone_number, const char *message, uint8_t message_length, uint8_t msg_parts,
133  uint8_t msg_part_number, uint8_t &header_size);
134  nsapi_size_or_error_t read_sms_from_index(int msg_index, char *buf, uint16_t len, char *phone_num,
135  char *time_stamp);
136  nsapi_size_or_error_t read_sms(sms_info_t *sms, char *buf, char *phone_num, char *time_stamp);
137 
138  /** Packs the given str from ascii to 7bit gsm format and converts it to hex to the given buf.
139  *
140  * @param str string that is to be converted
141  * @param len length of the str buffer
142  * @param buf preallocated buffer that holds the converted string in hex format after successful call
143  * @param number_of_padding_bit padding bits needed to keep the octet boundary
144  * @return length of buffer buf or zero on failure
145  */
146  uint16_t pack_7_bit_gsm_and_hex(const char *str, uint16_t len, char *buf, int number_of_padding_bit);
147 
148  /** Unpacks the given hex- and 7-bit gsm encoded str to ascii string
149  *
150  * @param str string to convert to ascii string and write to buf
151  * @param len length of the str divided by two as str is hexencoded
152  * @param buf preallocated destination buffer
153  * @param padding_bits number of padding bits needed to hold the octet boundary
154  * @param msg_len Length of the received message, which is coded in str
155  * @return length of the destination buffer buf
156  *
157  */
158  uint16_t unpack_7_bit_gsm_to_str(const char *str, int len, char *buf, int padding_bits,
159  int msg_len);
160 
161 private:
162  // application callback function for received sms
163  Callback<void()> _cb;
164  CellularSMSMmode _mode;
165  bool _use_8bit_encoding;
166  uint32_t _sim_wait_time;
167  uint16_t _sms_message_ref_number;
168  sms_info_t *_sms_info;
169 
170  ATHandler &_at;
171  AT_CellularDevice &_device;
172 };
173 
174 } // namespace mbed
175 
176 #endif //MBED_CONF_CELLULAR_USE_SMS
177 
178 #endif // AT_CELLULAR_SMS_H_
info
The key size.
Definition: kvstore_global_api.h:38
nsapi_error_t
signed int nsapi_error_t
Type used to represent error codes.
Definition: nsapi_types.h:140
nsapi_size_or_error_t
signed int nsapi_size_or_error_t
Type used to represent either a size or error passed through sockets.
Definition: nsapi_types.h:151
mbed
Definition: ATHandler.h:46
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.