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 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_uart.h"
38 
59 #define GSM_CMD_AT "AT"
60 #define GSM_CMD_ATI "ATI"
61 #define GSM_CMD_CFUN "AT+CFUN"
62 #define GSM_CMD_CREG "AT+CREG"
63 #define GSM_CMD_CGDCONT "AT+CGDCONT"
64 #define GSM_CMD_CSQ "AT+CSQ"
65 #define GSM_CMD_COPS "AT+COPS"
66 #define GSM_CMD_CMGS "AT+CMGS"
67 #define GSM_CMD_CMGF "AT+CMGF"
68 #define GSM_CMD_SGACT "AT#SGACT"
69 #define GSM_CMD_SD "AT#SD"
70 #define GSM_CMD_SH "AT#SH"
71 #define GSM_CMD_SSEND "AT#SSEND"
72 #define GSM_CMD_SRECV "AT#SRECV"
73 
78 #define GSM_RSP_OK "OK"
79 #define GSM_RSP_ERROR "ERROR"
80 
86 #define GSM_RX_DRV_BUFFER_SIZE 256
87 #define GSM_TX_DRV_BUFFER_SIZE 256
88  // gsm_set
90 
105 #define GSM_MAP_MIKROBUS( cfg, mikrobus ) \
106  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
107  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
108  cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
109  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
110  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
111  cfg.gp2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
112  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT )
113  // gsm_map // gsm
116 
121 typedef struct
122 {
123  // Output pins
124  digital_out_t rst;
125  digital_out_t rts;
127  // Input pins
128  digital_in_t pwr;
129  digital_in_t gp2;
130  digital_in_t cts;
132  // Modules
133  uart_t uart;
135  // Buffers
136  uint8_t uart_rx_buffer[ GSM_RX_DRV_BUFFER_SIZE ];
137  uint8_t uart_tx_buffer[ GSM_TX_DRV_BUFFER_SIZE ];
139 } gsm_t;
140 
145 typedef struct
146 {
147  // Communication gpio pins
148  pin_name_t rx_pin;
149  pin_name_t tx_pin;
151  // Additional gpio pins
152  pin_name_t pwr;
153  pin_name_t rst;
154  pin_name_t rts;
155  pin_name_t gp2;
156  pin_name_t cts;
158  // Static variable
159  uint32_t baud_rate;
161  uart_data_bits_t data_bit;
162  uart_parity_t parity_bit;
163  uart_stop_bits_t stop_bit;
165 } gsm_cfg_t;
166 
171 typedef enum
172 {
173  GSM_OK = 0,
174  GSM_ERROR = -1,
177  GSM_ERROR_UNKNOWN = -4
178 
180 
196 void gsm_cfg_setup ( gsm_cfg_t *cfg );
197 
211 err_t gsm_init ( gsm_t *ctx, gsm_cfg_t *cfg );
212 
225 err_t gsm_generic_write ( gsm_t *ctx, uint8_t *data_in, uint16_t len );
226 
239 err_t gsm_generic_read ( gsm_t *ctx, uint8_t *data_out, uint16_t len );
240 
250 void gsm_set_rts_pin ( gsm_t *ctx, uint8_t state );
251 
261 void gsm_set_rst_pin ( gsm_t *ctx, uint8_t state );
262 
271 uint8_t gsm_get_cts_pin ( gsm_t *ctx );
272 
281 uint8_t gsm_get_pwr_pin ( gsm_t *ctx );
282 
291 uint8_t gsm_get_gp2_pin ( gsm_t *ctx );
292 
302 void gsm_send_cmd ( gsm_t *ctx, uint8_t *cmd );
303 
314 void gsm_send_cmd_with_par ( gsm_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
315 
325 void gsm_send_cmd_check ( gsm_t *ctx, uint8_t *at_cmd_buf );
326 
336 void gsm_send_cmd_par_check ( gsm_t *ctx, uint8_t *at_cmd_buf );
337 
347 void gsm_set_sim_apn ( gsm_t *ctx, uint8_t *sim_apn );
348 
359 void gsm_send_sms_text ( gsm_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
360 
374 err_t gsm_send_sms_pdu ( gsm_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
375 
376 #ifdef __cplusplus
377 }
378 #endif
379 #endif // GSM_H
380  // gsm
382 
383 // ------------------------------------------------------------------------ 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:128
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:154
gsm_cfg_t::pwr
pin_name_t pwr
Definition: gsm.h:152
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:149
gsm_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: gsm.h:162
gsm_cfg_t::rst
pin_name_t rst
Definition: gsm.h:153
gsm_cfg_t::gp2
pin_name_t gp2
Definition: gsm.h:155
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:175
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:174
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:125
gsm_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: gsm.h:163
gsm_cfg_t::rx_pin
pin_name_t rx_pin
Definition: gsm.h:148
gsm_cfg_t::uart_blocking
bool uart_blocking
Definition: gsm.h:160
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:130
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:161
gsm_cfg_t
GSM Click configuration object.
Definition: gsm.h:146
gsm_t::uart
uart_t uart
Definition: gsm.h:133
gsm_t::rst
digital_out_t rst
Definition: gsm.h:124
GSM_TX_DRV_BUFFER_SIZE
#define GSM_TX_DRV_BUFFER_SIZE
Definition: gsm.h:87
gsm_t
GSM Click context object.
Definition: gsm.h:122
gsm_cfg_t::cts
pin_name_t cts
Definition: gsm.h:156
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:176
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:129
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:177
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:172
GSM_RX_DRV_BUFFER_SIZE
#define GSM_RX_DRV_BUFFER_SIZE
GSM driver buffer size.
Definition: gsm.h:86
gsm_cfg_t::baud_rate
uint32_t baud_rate
Definition: gsm.h:159
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:173
gsm_get_cts_pin
uint8_t gsm_get_cts_pin(gsm_t *ctx)
GSM get cts pin function.