gsm  2.0.0.0
gsm.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 GSM_H
29 #define GSM_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 GSM_CMD_AT "AT"
74 #define GSM_CMD_ATI "ATI"
75 #define GSM_CMD_CFUN "AT+CFUN"
76 #define GSM_CMD_CREG "AT+CREG"
77 #define GSM_CMD_CGDCONT "AT+CGDCONT"
78 #define GSM_CMD_CSQ "AT+CSQ"
79 #define GSM_CMD_COPS "AT+COPS"
80 #define GSM_CMD_CMGS "AT+CMGS"
81 #define GSM_CMD_CMGF "AT+CMGF"
82 #define GSM_CMD_SGACT "AT#SGACT"
83 #define GSM_CMD_SD "AT#SD"
84 #define GSM_CMD_SH "AT#SH"
85 #define GSM_CMD_SSEND "AT#SSEND"
86 #define GSM_CMD_SRECV "AT#SRECV"
87 
92 #define GSM_RSP_OK "OK"
93 #define GSM_RSP_ERROR "ERROR"
94 
100 #define GSM_RX_DRV_BUFFER_SIZE 256
101 #define GSM_TX_DRV_BUFFER_SIZE 256
102  // gsm_set
104 
119 #define GSM_MAP_MIKROBUS( cfg, mikrobus ) \
120  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
121  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
122  cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
123  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
124  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
125  cfg.gp2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
126  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT )
127  // gsm_map // gsm
130 
135 typedef struct
136 {
137  // Output pins
138  digital_out_t rst;
139  digital_out_t rts;
141  // Input pins
142  digital_in_t pwr;
143  digital_in_t gp2;
144  digital_in_t cts;
146  // Modules
147  uart_t uart;
149  // Buffers
150  uint8_t uart_rx_buffer[ GSM_RX_DRV_BUFFER_SIZE ];
151  uint8_t uart_tx_buffer[ GSM_TX_DRV_BUFFER_SIZE ];
153 } gsm_t;
154 
159 typedef struct
160 {
161  // Communication gpio pins
162  pin_name_t rx_pin;
163  pin_name_t tx_pin;
165  // Additional gpio pins
166  pin_name_t pwr;
167  pin_name_t rst;
168  pin_name_t rts;
169  pin_name_t gp2;
170  pin_name_t cts;
172  // Static variable
173  uint32_t baud_rate;
175  uart_data_bits_t data_bit;
176  uart_parity_t parity_bit;
177  uart_stop_bits_t stop_bit;
179 } gsm_cfg_t;
180 
185 typedef enum
186 {
187  GSM_OK = 0,
188  GSM_ERROR = -1,
191  GSM_ERROR_UNKNOWN = -4
192 
194 
210 void gsm_cfg_setup ( gsm_cfg_t *cfg );
211 
225 err_t gsm_init ( gsm_t *ctx, gsm_cfg_t *cfg );
226 
239 err_t gsm_generic_write ( gsm_t *ctx, uint8_t *data_in, uint16_t len );
240 
253 err_t gsm_generic_read ( gsm_t *ctx, uint8_t *data_out, uint16_t len );
254 
264 void gsm_set_rts_pin ( gsm_t *ctx, uint8_t state );
265 
275 void gsm_set_rst_pin ( gsm_t *ctx, uint8_t state );
276 
285 uint8_t gsm_get_cts_pin ( gsm_t *ctx );
286 
295 uint8_t gsm_get_pwr_pin ( gsm_t *ctx );
296 
305 uint8_t gsm_get_gp2_pin ( gsm_t *ctx );
306 
316 void gsm_send_cmd ( gsm_t *ctx, uint8_t *cmd );
317 
328 void gsm_send_cmd_with_par ( gsm_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
329 
339 void gsm_send_cmd_check ( gsm_t *ctx, uint8_t *at_cmd_buf );
340 
350 void gsm_send_cmd_par_check ( gsm_t *ctx, uint8_t *at_cmd_buf );
351 
361 void gsm_set_sim_apn ( gsm_t *ctx, uint8_t *sim_apn );
362 
373 void gsm_send_sms_text ( gsm_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
374 
388 err_t gsm_send_sms_pdu ( gsm_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
389 
390 #ifdef __cplusplus
391 }
392 #endif
393 #endif // GSM_H
394  // gsm
396 
397 // ------------------------------------------------------------------------ END
gsm_set_rts_pin
void gsm_set_rts_pin(gsm_t *ctx, uint8_t state)
GSM set rts pin function.
gsm_t::pwr
digital_in_t pwr
Definition: gsm.h:142
gsm_send_sms_pdu
err_t gsm_send_sms_pdu(gsm_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
GSM send SMS in PDU mode.
gsm_cfg_t::rts
pin_name_t rts
Definition: gsm.h:168
gsm_cfg_t::pwr
pin_name_t pwr
Definition: gsm.h:166
gsm_set_sim_apn
void gsm_set_sim_apn(gsm_t *ctx, uint8_t *sim_apn)
Set sim card APN.
gsm_set_rst_pin
void gsm_set_rst_pin(gsm_t *ctx, uint8_t state)
GSM set rst pin function.
gsm_cfg_t::tx_pin
pin_name_t tx_pin
Definition: gsm.h:163
gsm_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gsm.h:176
gsm_cfg_t::rst
pin_name_t rst
Definition: gsm.h:167
gsm_cfg_t::gp2
pin_name_t gp2
Definition: gsm.h:169
gsm_get_pwr_pin
uint8_t gsm_get_pwr_pin(gsm_t *ctx)
GSM get pwr pin function.
GSM_ERROR_TIMEOUT
@ GSM_ERROR_TIMEOUT
Definition: gsm.h:189
gsm_send_cmd_par_check
void gsm_send_cmd_par_check(gsm_t *ctx, uint8_t *at_cmd_buf)
Check the command parameters.
GSM_ERROR
@ GSM_ERROR
Definition: gsm.h:188
gsm_generic_read
err_t gsm_generic_read(gsm_t *ctx, uint8_t *data_out, uint16_t len)
GSM data reading function.
gsm_t::rts
digital_out_t rts
Definition: gsm.h:139
gsm_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gsm.h:177
gsm_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gsm.h:162
gsm_cfg_t::uart_blocking
bool uart_blocking
Definition: gsm.h:174
gsm_generic_write
err_t gsm_generic_write(gsm_t *ctx, uint8_t *data_in, uint16_t len)
GSM data writing function.
gsm_t::cts
digital_in_t cts
Definition: gsm.h:144
gsm_init
err_t gsm_init(gsm_t *ctx, gsm_cfg_t *cfg)
GSM initialization function.
gsm_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: gsm.h:175
gsm_cfg_t
GSM Click configuration object.
Definition: gsm.h:160
gsm_t::uart
uart_t uart
Definition: gsm.h:147
gsm_t::rst
digital_out_t rst
Definition: gsm.h:138
GSM_TX_DRV_BUFFER_SIZE
#define GSM_TX_DRV_BUFFER_SIZE
Definition: gsm.h:101
gsm_t
GSM Click context object.
Definition: gsm.h:136
gsm_cfg_t::cts
pin_name_t cts
Definition: gsm.h:170
gsm_get_gp2_pin
uint8_t gsm_get_gp2_pin(gsm_t *ctx)
GSM get gp2 pin function.
GSM_ERROR_CMD
@ GSM_ERROR_CMD
Definition: gsm.h:190
gsm_send_cmd
void gsm_send_cmd(gsm_t *ctx, uint8_t *cmd)
Send command function.
gsm_send_cmd_with_par
void gsm_send_cmd_with_par(gsm_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
Send command function with parameter.
gsm_t::gp2
digital_in_t gp2
Definition: gsm.h:143
gsm_cfg_setup
void gsm_cfg_setup(gsm_cfg_t *cfg)
GSM configuration object setup function.
GSM_ERROR_UNKNOWN
@ GSM_ERROR_UNKNOWN
Definition: gsm.h:191
gsm_send_cmd_check
void gsm_send_cmd_check(gsm_t *ctx, uint8_t *at_cmd_buf)
Check the sent command.
gsm_return_value_t
gsm_return_value_t
GSM Click return value data.
Definition: gsm.h:186
GSM_RX_DRV_BUFFER_SIZE
#define GSM_RX_DRV_BUFFER_SIZE
GSM driver buffer size.
Definition: gsm.h:100
gsm_cfg_t::baud_rate
uint32_t baud_rate
Definition: gsm.h:173
gsm_send_sms_text
void gsm_send_sms_text(gsm_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
GSM send SMS in text mode.
GSM_OK
@ GSM_OK
Definition: gsm.h:187
gsm_get_cts_pin
uint8_t gsm_get_cts_pin(gsm_t *ctx)
GSM get cts pin function.