c3gaa  2.0.0.0
c3gaa.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 C3GAA_H
29 #define C3GAA_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 C3GAA_MODULE_POWER_ON 1
60 #define C3GAA_MODULE_POWER_OFF 0
61 
66 #define C3GAA_CMD_AT "AT"
67 #define C3GAA_CMD_ATI "ATI"
68 #define C3GAA_CMD_CGMR "AT+CGMR"
69 #define C3GAA_CMD_CFUN "AT+CFUN"
70 #define C3GAA_CMD_CREG "AT+CREG"
71 #define C3GAA_CMD_CGREG "AT+CGREG"
72 #define C3GAA_CMD_CGDCONT "AT+CGDCONT"
73 #define C3GAA_CMD_CIMI "AT+CIMI"
74 #define C3GAA_CMD_CMEE "AT+CMEE"
75 #define C3GAA_CMD_CGATT "AT+CGATT"
76 #define C3GAA_CMD_CSQ "AT+CSQ"
77 #define C3GAA_CMD_COPS "AT+COPS"
78 #define C3GAA_CMD_CMGS "AT+CMGS"
79 #define C3GAA_CMD_CMGF "AT+CMGF"
80 
86 #define DRV_RX_BUFFER_SIZE 256
87 #define DRV_TX_BUFFER_SIZE 256
88  // c3gaa_set
90 
105 #define C3GAA_MAP_MIKROBUS( cfg, mikrobus ) \
106  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
107  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
108  cfg.sta = MIKROBUS( mikrobus, MIKROBUS_AN ); \
109  cfg.pwk = MIKROBUS( mikrobus, MIKROBUS_RST ); \
110  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
111  cfg.ring = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
112  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT )
113  // c3gaa_map // c3gaa
116 
121 typedef struct
122 {
123  // Output pins
124  digital_out_t pwk;
125  digital_out_t rts;
126 
127  // Input pins
128  digital_in_t sta;
129  digital_in_t ring;
130  digital_in_t cts;
131 
132  // Modules
133  uart_t uart;
135  // Buffers
136  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
137  char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
139 } c3gaa_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 sta;
153  pin_name_t pwk;
154  pin_name_t rts;
155  pin_name_t ring;
156  pin_name_t cts;
157 
158  // Static variable
159  uint32_t baud_rate;
160  bool uart_blocking;
161  uart_data_bits_t data_bit;
162  uart_parity_t parity_bit;
163  uart_stop_bits_t stop_bit;
165 } c3gaa_cfg_t;
166 
171 typedef enum
172 {
173  C3GAA_OK = 0,
174  C3GAA_ERROR = -1
175 
177 
193 void c3gaa_cfg_setup ( c3gaa_cfg_t *cfg );
194 
209 err_t c3gaa_init ( c3gaa_t *ctx, c3gaa_cfg_t *cfg );
210 
211 
220 void c3gaa_module_power ( c3gaa_t *ctx, uint8_t state );
221 
235 err_t c3gaa_generic_write ( c3gaa_t *ctx, char *data_buf, uint16_t len );
236 
250 err_t c3gaa_generic_read ( c3gaa_t *ctx, char *data_buf, uint16_t max_len );
251 
261 void c3gaa_set_rts_pin ( c3gaa_t *ctx, uint8_t state );
262 
272 void c3gaa_set_pwk_pin ( c3gaa_t *ctx, uint8_t state );
273 
283 uint8_t c3gaa_get_cts_pin ( c3gaa_t *ctx );
284 
294 uint8_t c3gaa_get_sta_pin ( c3gaa_t *ctx );
295 
305 uint8_t c3gaa_get_ring_pin ( c3gaa_t *ctx );
306 
316 void c3gaa_send_cmd ( c3gaa_t *ctx, char *cmd );
317 
328 void c3gaa_send_cmd_with_parameter ( c3gaa_t *ctx, char *at_cmd_buf, char *param_buf );
329 
339 void c3gaa_send_cmd_check ( c3gaa_t *ctx, char *at_cmd_buf );
340 
350 void c3gaa_send_cmd_parameter_check ( c3gaa_t *ctx, char *at_cmd_buf );
351 
361 void c3gaa_set_sim_apn ( c3gaa_t *ctx, char *sim_apn );
362 
373 void c3gaa_send_sms_text ( c3gaa_t *ctx, char *phone_number, char *sms_text );
374 
388 err_t c3gaa_send_sms_pdu ( c3gaa_t *ctx, char *service_center_number, char *phone_number, char *sms_text );
389 
390 #ifdef __cplusplus
391 }
392 #endif
393 #endif // C3GAA_H
394  // c3gaa
396 
397 // ------------------------------------------------------------------------ END
c3gaa_set_rts_pin
void c3gaa_set_rts_pin(c3gaa_t *ctx, uint8_t state)
Sets state of the RTS pin.
c3gaa_get_ring_pin
uint8_t c3gaa_get_ring_pin(c3gaa_t *ctx)
RING Pin Get function.
c3gaa_send_sms_pdu
err_t c3gaa_send_sms_pdu(c3gaa_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
3G-AA send SMS in PDU mode.
c3gaa_get_cts_pin
uint8_t c3gaa_get_cts_pin(c3gaa_t *ctx)
CTS Pin Get function.
c3gaa_cfg_t
3G-AA Click configuration object.
Definition: c3gaa.h:144
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
3G-AA driver buffer size.
Definition: c3gaa.h:85
c3gaa_set_pwk_pin
void c3gaa_set_pwk_pin(c3gaa_t *ctx, uint8_t state)
Sets state of the PWK pin.
c3gaa_generic_read
err_t c3gaa_generic_read(c3gaa_t *ctx, char *data_buf, uint16_t max_len)
3G-AA data reading function.
c3gaa_send_cmd_with_parameter
void c3gaa_send_cmd_with_parameter(c3gaa_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
C3GAA_ERROR
Definition: c3gaa.h:173
c3gaa_module_power
void c3gaa_module_power(c3gaa_t *ctx, uint8_t state)
Power ON/OFF the module.
c3gaa_send_cmd_check
void c3gaa_send_cmd_check(c3gaa_t *ctx, char *at_cmd_buf)
Check the sent command.
c3gaa_cfg_setup
void c3gaa_cfg_setup(c3gaa_cfg_t *cfg)
3G-AA configuration object setup function.
c3gaa_generic_write
err_t c3gaa_generic_write(c3gaa_t *ctx, char *data_buf, uint16_t len)
3G-AA data writing function.
c3gaa_set_sim_apn
void c3gaa_set_sim_apn(c3gaa_t *ctx, char *sim_apn)
Set sim card APN.
DRV_TX_BUFFER_SIZE
#define DRV_TX_BUFFER_SIZE
Definition: c3gaa.h:86
c3gaa_t
3G-AA Click context object.
Definition: c3gaa.h:120
c3gaa_send_sms_text
void c3gaa_send_sms_text(c3gaa_t *ctx, char *phone_number, char *sms_text)
3G-AA send SMS in text mode.
c3gaa_init
err_t c3gaa_init(c3gaa_t *ctx, c3gaa_cfg_t *cfg)
3G-AA initialization function.
c3gaa_send_cmd
void c3gaa_send_cmd(c3gaa_t *ctx, char *cmd)
Send command function.
c3gaa_send_cmd_parameter_check
void c3gaa_send_cmd_parameter_check(c3gaa_t *ctx, char *at_cmd_buf)
Check the command parameters.
c3gaa_return_value_t
c3gaa_return_value_t
3G-AA Click return value data.
Definition: c3gaa.h:170
C3GAA_OK
Definition: c3gaa.h:172
c3gaa_get_sta_pin
uint8_t c3gaa_get_sta_pin(c3gaa_t *ctx)
STA Pin Get function.