c4glte2data  2.1.0.0
c4glte2data.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 C4GLTE2DATA_H
29 #define C4GLTE2DATA_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_uart.h"
48 
69 #define C4GLTE2DATA_CMD_AT "AT"
70 #define C4GLTE2DATA_CMD_ATI "ATI"
71 #define C4GLTE2DATA_CMD_CGMR "AT+CGMR"
72 #define C4GLTE2DATA_CMD_CFUN "AT+CFUN"
73 #define C4GLTE2DATA_CMD_CREG "AT+CREG"
74 #define C4GLTE2DATA_CMD_CGREG "AT+CGREG"
75 #define C4GLTE2DATA_CMD_CGDCONT "AT+CGDCONT"
76 #define C4GLTE2DATA_CMD_CIMI "AT+CIMI"
77 #define C4GLTE2DATA_CMD_CMEE "AT+CMEE"
78 #define C4GLTE2DATA_CMD_CGATT "AT+CGATT"
79 #define C4GLTE2DATA_CMD_CSQ "AT+CSQ"
80 #define C4GLTE2DATA_CMD_COPS "AT+COPS"
81 #define C4GLTE2DATA_CMD_CMGS "AT+CMGS"
82 #define C4GLTE2DATA_CMD_CMGF "AT+CMGF"
83 #define C4GLTE2DATA_CMD_CGACT "AT+CGACT"
84 #define C4GLTE2DATA_CMD_USOCR "AT+USOCR"
85 #define C4GLTE2DATA_CMD_USOCO "AT+USOCO"
86 #define C4GLTE2DATA_CMD_USOWR "AT+USOWR"
87 #define C4GLTE2DATA_CMD_USOST "AT+USOST"
88 #define C4GLTE2DATA_CMD_USORD "AT+USORD"
89 #define C4GLTE2DATA_CMD_USORF "AT+USORF"
90 #define C4GLTE2DATA_CMD_USOCL "AT+USOCL"
91 #define C4GLTE2DATA_CMD_UGPS "AT+UGPS"
92 #define C4GLTE2DATA_CMD_UGGGA "AT+UGGGA"
93 
98 #define C4GLTE2DATA_RSP_OK "OK"
99 #define C4GLTE2DATA_RSP_ERROR "ERROR"
100 
105 #define C4GLTE2DATA_POWER_STATE_OFF 0
106 #define C4GLTE2DATA_POWER_STATE_ON 1
107 
113 #define DRV_BUFFER_SIZE 256
114  // c4glte2data_cmd
116 
131 #define C4GLTE2DATA_MAP_MIKROBUS( cfg, mikrobus ) \
132  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
133  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
134  cfg.sts = MIKROBUS( mikrobus, MIKROBUS_AN ); \
135  cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_RST ); \
136  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
137  cfg.ri = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
138  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
139  // c4glte2data_map // c4glte2data
142 
147 typedef struct
148 {
149  // Output pins
150  digital_out_t sts;
151  digital_out_t pwr;
152  digital_out_t rts;
154  // Input pins
155  digital_in_t ri;
156  digital_in_t cts;
158  // Modules
159  uart_t uart;
161  // Buffers
162  char uart_rx_buffer[ DRV_BUFFER_SIZE ];
163  char uart_tx_buffer[ DRV_BUFFER_SIZE ];
165 } c4glte2data_t;
166 
171 typedef struct
172 {
173  // Communication gpio pins
174  pin_name_t rx_pin;
175  pin_name_t tx_pin;
177  // Additional gpio pins
178  pin_name_t sts;
179  pin_name_t pwr;
180  pin_name_t rts;
181  pin_name_t ri;
182  pin_name_t cts;
184  // Static variable
185  uint32_t baud_rate;
187  uart_data_bits_t data_bit;
188  uart_parity_t parity_bit;
189  uart_stop_bits_t stop_bit;
192 
197 typedef enum
198 {
204 
206 
223 
238 
251 err_t c4glte2data_generic_write ( c4glte2data_t *ctx, char *data_in, uint16_t len );
252 
265 err_t c4glte2data_generic_read ( c4glte2data_t *ctx, char *data_out, uint16_t len );
266 
276 void c4glte2data_set_pwr_pin ( c4glte2data_t *ctx, uint8_t state );
277 
287 void c4glte2data_set_sts_pin ( c4glte2data_t *ctx, uint8_t state );
288 
298 void c4glte2data_set_rts_pin ( c4glte2data_t *ctx, uint8_t state );
299 
309 
319 
330 void c4glte2data_set_power_state ( c4glte2data_t *ctx, uint8_t state );
331 
341 void c4glte2data_send_cmd ( c4glte2data_t *ctx, char *cmd );
342 
353 void c4glte2data_send_cmd_with_parameter ( c4glte2data_t *ctx, char *at_cmd_buf, char *param_buf );
354 
364 void c4glte2data_send_cmd_check ( c4glte2data_t *ctx, char *at_cmd_buf );
365 
375 void c4glte2data_send_cmd_parameter_check ( c4glte2data_t *ctx, char *at_cmd_buf );
376 
386 void c4glte2data_set_sim_apn ( c4glte2data_t *ctx, char *sim_apn );
387 
398 void c4glte2data_send_sms_text ( c4glte2data_t *ctx, char *phone_number, char *sms_text );
399 
413 err_t c4glte2data_send_sms_pdu ( c4glte2data_t *ctx, char *service_center_number, char *phone_number, char *sms_text );
414 
415 #ifdef __cplusplus
416 }
417 #endif
418 #endif // C4GLTE2DATA_H
419  // c4glte2data
421 
422 // ------------------------------------------------------------------------ END
c4glte2data_send_sms_pdu
err_t c4glte2data_send_sms_pdu(c4glte2data_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
4G LTE 2 Data send SMS in PDU mode.
c4glte2data_send_cmd
void c4glte2data_send_cmd(c4glte2data_t *ctx, char *cmd)
Send command function.
c4glte2data_t::rts
digital_out_t rts
Definition: c4glte2data.h:152
c4glte2data_cfg_t::rts
pin_name_t rts
Definition: c4glte2data.h:180
c4glte2data_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: c4glte2data.h:187
c4glte2data_set_rts_pin
void c4glte2data_set_rts_pin(c4glte2data_t *ctx, uint8_t state)
4G LTE 2 Data set RTS pin function.
c4glte2data_send_cmd_with_parameter
void c4glte2data_send_cmd_with_parameter(c4glte2data_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
c4glte2data_set_sim_apn
void c4glte2data_set_sim_apn(c4glte2data_t *ctx, char *sim_apn)
Set sim card APN.
c4glte2data_set_pwr_pin
void c4glte2data_set_pwr_pin(c4glte2data_t *ctx, uint8_t state)
4G LTE 2 Data set PWR pin function.
c4glte2data_send_sms_text
void c4glte2data_send_sms_text(c4glte2data_t *ctx, char *phone_number, char *sms_text)
4G LTE 2 Data send SMS in text mode.
c4glte2data_send_cmd_parameter_check
void c4glte2data_send_cmd_parameter_check(c4glte2data_t *ctx, char *at_cmd_buf)
Check the command parameters.
C4GLTE2DATA_ERROR_CMD
@ C4GLTE2DATA_ERROR_CMD
Definition: c4glte2data.h:202
c4glte2data_send_cmd_check
void c4glte2data_send_cmd_check(c4glte2data_t *ctx, char *at_cmd_buf)
Check the sent command.
c4glte2data_cfg_t::baud_rate
uint32_t baud_rate
Definition: c4glte2data.h:185
DRV_BUFFER_SIZE
#define DRV_BUFFER_SIZE
4G LTE 2 Data driver buffer size.
Definition: c4glte2data.h:113
c4glte2data_cfg_t::sts
pin_name_t sts
Definition: c4glte2data.h:178
C4GLTE2DATA_ERROR_TIMEOUT
@ C4GLTE2DATA_ERROR_TIMEOUT
Definition: c4glte2data.h:201
c4glte2data_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: c4glte2data.h:189
C4GLTE2DATA_OK
@ C4GLTE2DATA_OK
Definition: c4glte2data.h:199
c4glte2data_cfg_t::uart_blocking
bool uart_blocking
Definition: c4glte2data.h:186
c4glte2data_cfg_t::tx_pin
pin_name_t tx_pin
Definition: c4glte2data.h:175
c4glte2data_t
4G LTE 2 Data Click context object.
Definition: c4glte2data.h:148
c4glte2data_t::pwr
digital_out_t pwr
Definition: c4glte2data.h:151
c4glte2data_return_value_t
c4glte2data_return_value_t
4G LTE 2 Data Click return value data.
Definition: c4glte2data.h:198
c4glte2data_set_sts_pin
void c4glte2data_set_sts_pin(c4glte2data_t *ctx, uint8_t state)
4G LTE 2 Data set STS pin function.
c4glte2data_cfg_t::rx_pin
pin_name_t rx_pin
Definition: c4glte2data.h:174
c4glte2data_get_ri_pin
uint8_t c4glte2data_get_ri_pin(c4glte2data_t *ctx)
4G LTE 2 Data get RI pin function.
c4glte2data_cfg_setup
void c4glte2data_cfg_setup(c4glte2data_cfg_t *cfg)
4G LTE 2 Data configuration object setup function.
c4glte2data_init
err_t c4glte2data_init(c4glte2data_t *ctx, c4glte2data_cfg_t *cfg)
4G LTE 2 Data initialization function.
c4glte2data_t::cts
digital_in_t cts
Definition: c4glte2data.h:156
c4glte2data_set_power_state
void c4glte2data_set_power_state(c4glte2data_t *ctx, uint8_t state)
4G LTE 2 Data set power state function.
c4glte2data_generic_read
err_t c4glte2data_generic_read(c4glte2data_t *ctx, char *data_out, uint16_t len)
4G LTE 2 Data data reading function.
c4glte2data_cfg_t
4G LTE 2 Data Click configuration object.
Definition: c4glte2data.h:172
C4GLTE2DATA_ERROR_UNKNOWN
@ C4GLTE2DATA_ERROR_UNKNOWN
Definition: c4glte2data.h:203
c4glte2data_generic_write
err_t c4glte2data_generic_write(c4glte2data_t *ctx, char *data_in, uint16_t len)
4G LTE 2 Data data writing function.
c4glte2data_cfg_t::ri
pin_name_t ri
Definition: c4glte2data.h:181
c4glte2data_get_cts_pin
uint8_t c4glte2data_get_cts_pin(c4glte2data_t *ctx)
4G LTE 2 Data get CTS pin function.
c4glte2data_cfg_t::pwr
pin_name_t pwr
Definition: c4glte2data.h:179
c4glte2data_t::ri
digital_in_t ri
Definition: c4glte2data.h:155
C4GLTE2DATA_ERROR
@ C4GLTE2DATA_ERROR
Definition: c4glte2data.h:200
c4glte2data_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: c4glte2data.h:188
c4glte2data_cfg_t::cts
pin_name_t cts
Definition: c4glte2data.h:182
c4glte2data_t::sts
digital_out_t sts
Definition: c4glte2data.h:150
c4glte2data_t::uart
uart_t uart
Definition: c4glte2data.h:159