c3gsara  2.0.0.0
c3gsara.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 C3GSARA_H
29 #define C3GSARA_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 C3GSARA_CMD_AT "AT"
60 #define C3GSARA_CMD_ATI "ATI"
61 #define C3GSARA_CMD_CFUN "AT+CFUN"
62 #define C3GSARA_CMD_CREG "AT+CREG"
63 #define C3GSARA_CMD_CGDCONT "AT+CGDCONT"
64 #define C3GSARA_CMD_CSQ "AT+CSQ"
65 #define C3GSARA_CMD_COPS "AT+COPS"
66 #define C3GSARA_CMD_CMGS "AT+CMGS"
67 #define C3GSARA_CMD_CMGF "AT+CMGF"
68 #define C3GSARA_CMD_CGACT "AT+CGACT"
69 #define C3GSARA_CMD_UPSDA "AT+UPSDA"
70 #define C3GSARA_CMD_USOCR "AT+USOCR"
71 #define C3GSARA_CMD_USOCO "AT+USOCO"
72 #define C3GSARA_CMD_USOWR "AT+USOWR"
73 #define C3GSARA_CMD_USORD "AT+USORD"
74 #define C3GSARA_CMD_USORF "AT+USORF"
75 #define C3GSARA_CMD_USOCL "AT+USOCL"
76 
81 #define C3GSARA_RSP_OK "OK"
82 #define C3GSARA_RSP_ERROR "ERROR"
83 
88 #define C3GSARA_POWER_STATE_OFF 0
89 #define C3GSARA_POWER_STATE_ON 1
90 
96 #define C3GSARA_RX_DRV_BUFFER_SIZE 256
97 #define C3GSARA_TX_DRV_BUFFER_SIZE 256
98  // c3gsara_set
100 
115 #define C3GSARA_MAP_MIKROBUS( cfg, mikrobus ) \
116  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
117  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
118  cfg.sta = MIKROBUS( mikrobus, MIKROBUS_AN ); \
119  cfg.pwk = MIKROBUS( mikrobus, MIKROBUS_RST ); \
120  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
121  cfg.ring = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
122  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT )
123  // c3gsara_map // c3gsara
126 
131 typedef struct
132 {
133  // Output pins
134  digital_out_t pwk;
135  digital_out_t rts;
137  // Input pins
138  digital_in_t sta;
139  digital_in_t ring;
140  digital_in_t cts;
142  // Modules
143  uart_t uart;
145  // Buffers
146  char uart_rx_buffer[ C3GSARA_RX_DRV_BUFFER_SIZE ];
147  char uart_tx_buffer[ C3GSARA_TX_DRV_BUFFER_SIZE ];
149 } c3gsara_t;
150 
155 typedef struct
156 {
157  // Communication gpio pins
158  pin_name_t rx_pin;
159  pin_name_t tx_pin;
161  // Additional gpio pins
162  pin_name_t sta;
163  pin_name_t pwk;
164  pin_name_t rts;
165  pin_name_t ring;
166  pin_name_t cts;
168  // Static variable
169  uint32_t baud_rate;
171  uart_data_bits_t data_bit;
172  uart_parity_t parity_bit;
173  uart_stop_bits_t stop_bit;
175 } c3gsara_cfg_t;
176 
181 typedef enum
182 {
188 
190 
207 
221 err_t c3gsara_init ( c3gsara_t *ctx, c3gsara_cfg_t *cfg );
222 
235 err_t c3gsara_generic_write ( c3gsara_t *ctx, uint8_t *data_in, uint16_t len );
236 
249 err_t c3gsara_generic_read ( c3gsara_t *ctx, uint8_t *data_out, uint16_t len );
250 
261 void c3gsara_set_power_state ( c3gsara_t *ctx, uint8_t state );
262 
272 void c3gsara_set_rts_pin ( c3gsara_t *ctx, uint8_t state );
273 
283 void c3gsara_set_pwk_pin ( c3gsara_t *ctx, uint8_t state );
284 
294 
304 
314 
324 void c3gsara_send_cmd ( c3gsara_t *ctx, uint8_t *cmd );
325 
336 void c3gsara_send_cmd_with_par ( c3gsara_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
337 
347 void c3gsara_send_cmd_check ( c3gsara_t *ctx, uint8_t *at_cmd_buf );
348 
358 void c3gsara_send_cmd_par_check ( c3gsara_t *ctx, uint8_t *at_cmd_buf );
359 
369 void c3gsara_set_sim_apn ( c3gsara_t *ctx, uint8_t *sim_apn );
370 
381 void c3gsara_send_sms_text ( c3gsara_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
382 
396 err_t c3gsara_send_sms_pdu ( c3gsara_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
397 
398 #ifdef __cplusplus
399 }
400 #endif
401 #endif // C3GSARA_H
402  // c3gsara
404 
405 // ------------------------------------------------------------------------ END
c3gsara_t::rts
digital_out_t rts
Definition: c3gsara.h:135
c3gsara_send_cmd_check
void c3gsara_send_cmd_check(c3gsara_t *ctx, uint8_t *at_cmd_buf)
Check the sent command.
C3GSARA_ERROR_TIMEOUT
@ C3GSARA_ERROR_TIMEOUT
Definition: c3gsara.h:185
c3gsara_set_power_state
void c3gsara_set_power_state(c3gsara_t *ctx, uint8_t state)
3G SARA set power state function.
c3gsara_t::cts
digital_in_t cts
Definition: c3gsara.h:140
c3gsara_get_sta_pin
uint8_t c3gsara_get_sta_pin(c3gsara_t *ctx)
3G SARA get sta pin function.
c3gsara_return_value_t
c3gsara_return_value_t
3G SARA Click return value data.
Definition: c3gsara.h:182
c3gsara_send_sms_pdu
err_t c3gsara_send_sms_pdu(c3gsara_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
3G SARA send SMS in PDU mode.
c3gsara_t::pwk
digital_out_t pwk
Definition: c3gsara.h:134
c3gsara_init
err_t c3gsara_init(c3gsara_t *ctx, c3gsara_cfg_t *cfg)
3G SARA initialization function.
c3gsara_set_sim_apn
void c3gsara_set_sim_apn(c3gsara_t *ctx, uint8_t *sim_apn)
Set sim card APN.
c3gsara_cfg_t::tx_pin
pin_name_t tx_pin
Definition: c3gsara.h:159
c3gsara_get_ring_pin
uint8_t c3gsara_get_ring_pin(c3gsara_t *ctx)
3G SARA get ring pin function.
c3gsara_send_cmd
void c3gsara_send_cmd(c3gsara_t *ctx, uint8_t *cmd)
Send command function.
c3gsara_send_cmd_par_check
void c3gsara_send_cmd_par_check(c3gsara_t *ctx, uint8_t *at_cmd_buf)
Check the command parameters.
C3GSARA_ERROR_CMD
@ C3GSARA_ERROR_CMD
Definition: c3gsara.h:186
C3GSARA_TX_DRV_BUFFER_SIZE
#define C3GSARA_TX_DRV_BUFFER_SIZE
Definition: c3gsara.h:97
c3gsara_cfg_t::cts
pin_name_t cts
Definition: c3gsara.h:166
c3gsara_cfg_t::uart_blocking
bool uart_blocking
Definition: c3gsara.h:170
c3gsara_cfg_t::sta
pin_name_t sta
Definition: c3gsara.h:162
c3gsara_cfg_t::pwk
pin_name_t pwk
Definition: c3gsara.h:163
c3gsara_send_cmd_with_par
void c3gsara_send_cmd_with_par(c3gsara_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
Send command function with parameter.
C3GSARA_RX_DRV_BUFFER_SIZE
#define C3GSARA_RX_DRV_BUFFER_SIZE
3G SARA driver buffer size.
Definition: c3gsara.h:96
c3gsara_send_sms_text
void c3gsara_send_sms_text(c3gsara_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
3G SARA send SMS in text mode.
c3gsara_cfg_setup
void c3gsara_cfg_setup(c3gsara_cfg_t *cfg)
3G SARA configuration object setup function.
c3gsara_set_rts_pin
void c3gsara_set_rts_pin(c3gsara_t *ctx, uint8_t state)
3G SARA set rts pin function.
C3GSARA_ERROR
@ C3GSARA_ERROR
Definition: c3gsara.h:184
c3gsara_generic_write
err_t c3gsara_generic_write(c3gsara_t *ctx, uint8_t *data_in, uint16_t len)
3G SARA data writing function.
C3GSARA_OK
@ C3GSARA_OK
Definition: c3gsara.h:183
c3gsara_cfg_t::ring
pin_name_t ring
Definition: c3gsara.h:165
c3gsara_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: c3gsara.h:173
c3gsara_t::sta
digital_in_t sta
Definition: c3gsara.h:138
c3gsara_t::ring
digital_in_t ring
Definition: c3gsara.h:139
c3gsara_t::uart
uart_t uart
Definition: c3gsara.h:143
c3gsara_cfg_t
3G SARA Click configuration object.
Definition: c3gsara.h:156
c3gsara_cfg_t::rx_pin
pin_name_t rx_pin
Definition: c3gsara.h:158
c3gsara_t
3G SARA Click context object.
Definition: c3gsara.h:132
C3GSARA_ERROR_UNKNOWN
@ C3GSARA_ERROR_UNKNOWN
Definition: c3gsara.h:187
c3gsara_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: c3gsara.h:172
c3gsara_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: c3gsara.h:171
c3gsara_get_cts_pin
uint8_t c3gsara_get_cts_pin(c3gsara_t *ctx)
3G SARA get cts pin function.
c3gsara_set_pwk_pin
void c3gsara_set_pwk_pin(c3gsara_t *ctx, uint8_t state)
3G SARA set pwk pin function.
c3gsara_cfg_t::baud_rate
uint32_t baud_rate
Definition: c3gsara.h:169
c3gsara_generic_read
err_t c3gsara_generic_read(c3gsara_t *ctx, uint8_t *data_out, uint16_t len)
3G SARA data reading function.
c3gsara_cfg_t::rts
pin_name_t rts
Definition: c3gsara.h:164