c3gea  2.0.0.0
c3gea.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 C3GEA_H
29 #define C3GEA_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 C3GEA_CMD_AT "AT"
60 #define C3GEA_CMD_ATI "ATI"
61 #define C3GEA_CMD_CFUN "AT+CFUN"
62 #define C3GEA_CMD_CREG "AT+CREG"
63 #define C3GEA_CMD_CGDCONT "AT+CGDCONT"
64 #define C3GEA_CMD_CSQ "AT+CSQ"
65 #define C3GEA_CMD_COPS "AT+COPS"
66 #define C3GEA_CMD_CMGS "AT+CMGS"
67 #define C3GEA_CMD_CMGF "AT+CMGF"
68 #define C3GEA_CMD_QIACT "AT+QIACT"
69 #define C3GEA_CMD_QIOPEN "AT+QIOPEN"
70 #define C3GEA_CMD_QICLOSE "AT+QICLOSE"
71 #define C3GEA_CMD_QISEND "AT+QISEND"
72 #define C3GEA_CMD_QIRD "AT+QIRD"
73 
78 #define C3GEA_RSP_OK "OK"
79 #define C3GEA_RSP_ERROR "ERROR"
80 
86 #define C3GEA_RX_DRV_BUFFER_SIZE 256
87 #define C3GEA_TX_DRV_BUFFER_SIZE 256
88  // c3gea_set
90 
105 #define C3GEA_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  // c3gea_map // c3gea
116 
121 typedef struct
122 {
123  // Output pins
124  digital_out_t pwk;
125  digital_out_t rts;
127  // Input pins
128  digital_in_t sta;
129  digital_in_t ring;
130  digital_in_t cts;
132  // Modules
133  uart_t uart;
135  // Buffers
136  char uart_rx_buffer[ C3GEA_RX_DRV_BUFFER_SIZE ];
137  char uart_tx_buffer[ C3GEA_TX_DRV_BUFFER_SIZE ];
139 } c3gea_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;
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 } c3gea_cfg_t;
166 
171 typedef enum
172 {
173  C3GEA_OK = 0,
178 
180 
197 
211 err_t c3gea_init ( c3gea_t *ctx, c3gea_cfg_t *cfg );
212 
225 err_t c3gea_generic_write ( c3gea_t *ctx, uint8_t *data_in, uint16_t len );
226 
239 err_t c3gea_generic_read ( c3gea_t *ctx, uint8_t *data_out, uint16_t len );
240 
250 void c3gea_set_rts_pin ( c3gea_t *ctx, uint8_t state );
251 
261 void c3gea_set_pwk_pin ( c3gea_t *ctx, uint8_t state );
262 
271 uint8_t c3gea_get_cts_pin ( c3gea_t *ctx );
272 
281 uint8_t c3gea_get_sta_pin ( c3gea_t *ctx );
282 
291 uint8_t c3gea_get_ring_pin ( c3gea_t *ctx );
292 
302 void c3gea_send_cmd ( c3gea_t *ctx, uint8_t *cmd );
303 
314 void c3gea_send_cmd_with_par ( c3gea_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
315 
325 void c3gea_send_cmd_check ( c3gea_t *ctx, uint8_t *at_cmd_buf );
326 
336 void c3gea_send_cmd_par_check ( c3gea_t *ctx, uint8_t *at_cmd_buf );
337 
347 void c3gea_set_sim_apn ( c3gea_t *ctx, uint8_t *sim_apn );
348 
359 void c3gea_send_sms_text ( c3gea_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
360 
374 err_t c3gea_send_sms_pdu ( c3gea_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
375 
376 #ifdef __cplusplus
377 }
378 #endif
379 #endif // C3GEA_H
380  // c3gea
382 
383 // ------------------------------------------------------------------------ END
c3gea_send_sms_text
void c3gea_send_sms_text(c3gea_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
3G-EA send SMS in text mode.
c3gea_cfg_t
3G-EA Click configuration object.
Definition: c3gea.h:146
c3gea_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: c3gea.h:162
C3GEA_ERROR
@ C3GEA_ERROR
Definition: c3gea.h:174
c3gea_send_cmd
void c3gea_send_cmd(c3gea_t *ctx, uint8_t *cmd)
Send command function.
C3GEA_ERROR_UNKNOWN
@ C3GEA_ERROR_UNKNOWN
Definition: c3gea.h:177
c3gea_cfg_t::pwk
pin_name_t pwk
Definition: c3gea.h:153
c3gea_return_value_t
c3gea_return_value_t
3G-EA Click return value data.
Definition: c3gea.h:172
c3gea_t::cts
digital_in_t cts
Definition: c3gea.h:130
c3gea_get_ring_pin
uint8_t c3gea_get_ring_pin(c3gea_t *ctx)
3G-EA get ring pin function.
c3gea_cfg_t::rx_pin
pin_name_t rx_pin
Definition: c3gea.h:148
C3GEA_TX_DRV_BUFFER_SIZE
#define C3GEA_TX_DRV_BUFFER_SIZE
Definition: c3gea.h:87
c3gea_generic_read
err_t c3gea_generic_read(c3gea_t *ctx, uint8_t *data_out, uint16_t len)
3G-EA data reading function.
c3gea_cfg_t::ring
pin_name_t ring
Definition: c3gea.h:155
c3gea_set_sim_apn
void c3gea_set_sim_apn(c3gea_t *ctx, uint8_t *sim_apn)
Set sim card APN.
c3gea_send_cmd_par_check
void c3gea_send_cmd_par_check(c3gea_t *ctx, uint8_t *at_cmd_buf)
Check the command parameters.
c3gea_t::pwk
digital_out_t pwk
Definition: c3gea.h:124
c3gea_send_cmd_with_par
void c3gea_send_cmd_with_par(c3gea_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
Send command function with parameter.
c3gea_set_rts_pin
void c3gea_set_rts_pin(c3gea_t *ctx, uint8_t state)
3G-EA set rts pin function.
c3gea_cfg_t::baud_rate
uint32_t baud_rate
Definition: c3gea.h:159
C3GEA_ERROR_CMD
@ C3GEA_ERROR_CMD
Definition: c3gea.h:176
c3gea_cfg_t::cts
pin_name_t cts
Definition: c3gea.h:156
c3gea_set_pwk_pin
void c3gea_set_pwk_pin(c3gea_t *ctx, uint8_t state)
3G-EA set pwk pin function.
c3gea_cfg_t::uart_blocking
bool uart_blocking
Definition: c3gea.h:160
c3gea_t::uart
uart_t uart
Definition: c3gea.h:133
c3gea_init
err_t c3gea_init(c3gea_t *ctx, c3gea_cfg_t *cfg)
3G-EA initialization function.
C3GEA_OK
@ C3GEA_OK
Definition: c3gea.h:173
c3gea_send_sms_pdu
err_t c3gea_send_sms_pdu(c3gea_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
3G-EA send SMS in PDU mode.
c3gea_t::sta
digital_in_t sta
Definition: c3gea.h:128
C3GEA_ERROR_TIMEOUT
@ C3GEA_ERROR_TIMEOUT
Definition: c3gea.h:175
c3gea_cfg_t::tx_pin
pin_name_t tx_pin
Definition: c3gea.h:149
c3gea_cfg_t::rts
pin_name_t rts
Definition: c3gea.h:154
c3gea_t
3G-EA Click context object.
Definition: c3gea.h:122
c3gea_generic_write
err_t c3gea_generic_write(c3gea_t *ctx, uint8_t *data_in, uint16_t len)
3G-EA data writing function.
c3gea_cfg_t::sta
pin_name_t sta
Definition: c3gea.h:152
c3gea_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: c3gea.h:163
c3gea_get_sta_pin
uint8_t c3gea_get_sta_pin(c3gea_t *ctx)
3G-EA get sta pin function.
c3gea_t::ring
digital_in_t ring
Definition: c3gea.h:129
c3gea_get_cts_pin
uint8_t c3gea_get_cts_pin(c3gea_t *ctx)
3G-EA get cts pin function.
c3gea_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: c3gea.h:161
c3gea_cfg_setup
void c3gea_cfg_setup(c3gea_cfg_t *cfg)
3G-EA configuration object setup function.
c3gea_t::rts
digital_out_t rts
Definition: c3gea.h:125
C3GEA_RX_DRV_BUFFER_SIZE
#define C3GEA_RX_DRV_BUFFER_SIZE
3G-EA driver buffer size.
Definition: c3gea.h:86
c3gea_send_cmd_check
void c3gea_send_cmd_check(c3gea_t *ctx, uint8_t *at_cmd_buf)
Check the sent command.