gsm3  2.0.0.0
gsm3.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef GSM3_H
29 #define GSM3_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_uart.h"
52 
73 #define GSM3_CMD_AT "AT"
74 #define GSM3_CMD_CFUN "AT+CFUN"
75 #define GSM3_CMD_CREG "AT+CREG"
76 #define GSM3_CMD_CGDCONT "AT+CGDCONT"
77 #define GSM3_CMD_CSQ "AT+CSQ"
78 #define GSM3_CMD_COPS "AT+COPS"
79 #define GSM3_CMD_CMGS "AT+CMGS"
80 #define GSM3_CMD_CMGF "AT+CMGF"
81 #define GSM3_CMD_CIPMUX "AT+CIPMUX"
82 #define GSM3_CMD_CIPSTART "AT+CIPSTART"
83 #define GSM3_CMD_CIPCLOSE "AT+CIPCLOSE"
84 #define GSM3_CMD_CIPSEND "AT+CIPSEND"
85 #define GSM3_CMD_CIPHEAD "AT+CIPHEAD"
86 
91 #define GSM3_RSP_OK "OK"
92 #define GSM3_RSP_ERROR "ERROR"
93 
99 #define GSM3_RX_DRV_BUFFER_SIZE 256
100 #define GSM3_TX_DRV_BUFFER_SIZE 256
101  // gsm3_set
103 
118 #define GSM3_MAP_MIKROBUS( cfg, mikrobus ) \
119  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
120  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
121  cfg.sta = MIKROBUS( mikrobus, MIKROBUS_AN ); \
122  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
123  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
124  cfg.pwk = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
125  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT )
126  // gsm3_map // gsm3
129 
134 typedef struct
135 {
136  // Output pins
137  digital_out_t rst;
138  digital_out_t pwk;
139  digital_out_t rts;
141  // Input pins
142  digital_in_t sta;
143  digital_in_t cts;
145  // Modules
146  uart_t uart;
148  // Buffers
149  uint8_t uart_rx_buffer[ GSM3_RX_DRV_BUFFER_SIZE ];
150  uint8_t uart_tx_buffer[ GSM3_TX_DRV_BUFFER_SIZE ];
152 } gsm3_t;
153 
158 typedef struct
159 {
160  // Communication gpio pins
161  pin_name_t rx_pin;
162  pin_name_t tx_pin;
164  // Additional gpio pins
165  pin_name_t rst;
166  pin_name_t pwk;
167  pin_name_t rts;
168  pin_name_t sta;
169  pin_name_t cts;
171  // Static variable
172  uint32_t baud_rate;
174  uart_data_bits_t data_bit;
175  uart_parity_t parity_bit;
176  uart_stop_bits_t stop_bit;
178 } gsm3_cfg_t;
179 
184 typedef enum
185 {
186  GSM3_OK = 0,
190  GSM3_ERROR_UNKNOWN = -4
191 
193 
210 
224 err_t gsm3_init ( gsm3_t *ctx, gsm3_cfg_t *cfg );
225 
238 err_t gsm3_generic_write ( gsm3_t *ctx, uint8_t *data_in, uint16_t len );
239 
252 err_t gsm3_generic_read ( gsm3_t *ctx, uint8_t *data_out, uint16_t len );
253 
263 void gsm3_set_rst_pin ( gsm3_t *ctx, uint8_t state );
264 
274 void gsm3_set_rts_pin ( gsm3_t *ctx, uint8_t state );
275 
285 void gsm3_set_pwk_pin ( gsm3_t *ctx, uint8_t state );
286 
295 uint8_t gsm3_get_cts_pin ( gsm3_t *ctx );
296 
305 uint8_t gsm3_get_sta_pin ( gsm3_t *ctx );
306 
316 void gsm3_send_cmd ( gsm3_t *ctx, uint8_t *cmd );
317 
328 void gsm3_send_cmd_with_par ( gsm3_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
329 
339 void gsm3_send_cmd_check ( gsm3_t *ctx, uint8_t *at_cmd_buf );
340 
350 void gsm3_send_cmd_par_check ( gsm3_t *ctx, uint8_t *at_cmd_buf );
351 
361 void gsm3_set_sim_apn ( gsm3_t *ctx, uint8_t *sim_apn );
362 
373 void gsm3_send_sms_text ( gsm3_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
374 
388 err_t gsm3_send_sms_pdu ( gsm3_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
389 
390 #ifdef __cplusplus
391 }
392 #endif
393 #endif // GSM3_H
394  // gsm3
396 
397 // ------------------------------------------------------------------------ END
gsm3_set_pwk_pin
void gsm3_set_pwk_pin(gsm3_t *ctx, uint8_t state)
GSM 3 set pwk pin function.
GSM3_ERROR_UNKNOWN
@ GSM3_ERROR_UNKNOWN
Definition: gsm3.h:190
gsm3_init
err_t gsm3_init(gsm3_t *ctx, gsm3_cfg_t *cfg)
GSM 3 initialization function.
GSM3_ERROR
@ GSM3_ERROR
Definition: gsm3.h:187
gsm3_send_sms_text
void gsm3_send_sms_text(gsm3_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
GSM 3 send SMS in text mode.
gsm3_send_cmd
void gsm3_send_cmd(gsm3_t *ctx, uint8_t *cmd)
Send command function.
gsm3_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gsm3.h:174
gsm3_t::rts
digital_out_t rts
Definition: gsm3.h:139
gsm3_t::rst
digital_out_t rst
Definition: gsm3.h:137
gsm3_get_cts_pin
uint8_t gsm3_get_cts_pin(gsm3_t *ctx)
GSM 3 get cts pin function.
GSM3_ERROR_TIMEOUT
@ GSM3_ERROR_TIMEOUT
Definition: gsm3.h:188
gsm3_cfg_t::rst
pin_name_t rst
Definition: gsm3.h:165
gsm3_t
GSM 3 Click context object.
Definition: gsm3.h:135
gsm3_send_cmd_par_check
void gsm3_send_cmd_par_check(gsm3_t *ctx, uint8_t *at_cmd_buf)
Check the command parameters.
gsm3_t::cts
digital_in_t cts
Definition: gsm3.h:143
gsm3_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gsm3.h:175
gsm3_get_sta_pin
uint8_t gsm3_get_sta_pin(gsm3_t *ctx)
GSM 3 get sta pin function.
gsm3_set_sim_apn
void gsm3_set_sim_apn(gsm3_t *ctx, uint8_t *sim_apn)
Set sim card APN.
gsm3_cfg_t::baud_rate
uint32_t baud_rate
Definition: gsm3.h:172
gsm3_cfg_setup
void gsm3_cfg_setup(gsm3_cfg_t *cfg)
GSM 3 configuration object setup function.
gsm3_cfg_t::pwk
pin_name_t pwk
Definition: gsm3.h:166
GSM3_ERROR_CMD
@ GSM3_ERROR_CMD
Definition: gsm3.h:189
gsm3_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gsm3.h:162
GSM3_TX_DRV_BUFFER_SIZE
#define GSM3_TX_DRV_BUFFER_SIZE
Definition: gsm3.h:100
gsm3_cfg_t::uart_blocking
bool uart_blocking
Definition: gsm3.h:173
gsm3_t::pwk
digital_out_t pwk
Definition: gsm3.h:138
gsm3_cfg_t::cts
pin_name_t cts
Definition: gsm3.h:169
gsm3_send_cmd_with_par
void gsm3_send_cmd_with_par(gsm3_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
Send command function with parameter.
gsm3_cfg_t
GSM 3 Click configuration object.
Definition: gsm3.h:159
gsm3_set_rts_pin
void gsm3_set_rts_pin(gsm3_t *ctx, uint8_t state)
GSM 3 set rts pin function.
gsm3_t::uart
uart_t uart
Definition: gsm3.h:146
gsm3_send_sms_pdu
err_t gsm3_send_sms_pdu(gsm3_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
GSM 3 send SMS in PDU mode.
gsm3_send_cmd_check
void gsm3_send_cmd_check(gsm3_t *ctx, uint8_t *at_cmd_buf)
Check the sent command.
gsm3_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gsm3.h:161
gsm3_t::sta
digital_in_t sta
Definition: gsm3.h:142
gsm3_set_rst_pin
void gsm3_set_rst_pin(gsm3_t *ctx, uint8_t state)
GSM 3 set rst pin function.
gsm3_cfg_t::sta
pin_name_t sta
Definition: gsm3.h:168
gsm3_return_value_t
gsm3_return_value_t
GSM 3 Click return value data.
Definition: gsm3.h:185
GSM3_OK
@ GSM3_OK
Definition: gsm3.h:186
gsm3_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gsm3.h:176
gsm3_generic_read
err_t gsm3_generic_read(gsm3_t *ctx, uint8_t *data_out, uint16_t len)
GSM 3 data reading function.
gsm3_cfg_t::rts
pin_name_t rts
Definition: gsm3.h:167
GSM3_RX_DRV_BUFFER_SIZE
#define GSM3_RX_DRV_BUFFER_SIZE
GSM 3 driver buffer size.
Definition: gsm3.h:99
gsm3_generic_write
err_t gsm3_generic_write(gsm3_t *ctx, uint8_t *data_in, uint16_t len)
GSM 3 data writing function.