c4glte3e 2.1.0.0
Loading...
Searching...
No Matches
c4glte3e.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 C4GLTE3E_H
29#define C4GLTE3E_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
39#ifdef PREINIT_SUPPORTED
40#include "preinit.h"
41#endif
42
43#ifdef MikroCCoreVersion
44 #if MikroCCoreVersion >= 1
45 #include "delays.h"
46 #endif
47#endif
48
49#include "drv_digital_out.h"
50#include "drv_digital_in.h"
51#include "drv_uart.h"
52
73#define C4GLTE3E_CMD_AT "AT"
74#define C4GLTE3E_CMD_GET_MODEL_ID "AT+CGMM"
75#define C4GLTE3E_CMD_GET_SW_VERSION "AT+CGMR"
76#define C4GLTE3E_CMD_GET_SERIAL_NUM "AT+CGSN"
77#define C4GLTE3E_CMD_FACTORY_RESET "AT&F"
78#define C4GLTE3E_CMD_SET_MODULE_FUNCTIONALITY "AT+CFUN"
79#define C4GLTE3E_CMD_EPS_NETWORK_REGISTRATION "AT+CEREG"
80#define C4GLTE3E_CMD_SIGNAL_QUALITY_REPORT "AT+CSQ"
81#define C4GLTE3E_CMD_OPERATOR_SELECTION "AT+COPS"
82#define C4GLTE3E_CMD_SEND_SMS "AT+CMGS"
83#define C4GLTE3E_CMD_SELECT_SMS_FORMAT "AT+CMGF"
84#define C4GLTE3E_CMD_DEFINE_PDP_CONTEXT "AT+CGDCONT"
85#define C4GLTE3E_CMD_SHOW_PDP_ADDRESS "AT+CGPADDR"
86#define C4GLTE3E_CMD_ACTIVATE_PDP_CONTEXT "AT+CGACT"
87#define C4GLTE3E_CMD_CREATE_SOCKET "AT+USOCR"
88#define C4GLTE3E_CMD_CLOSE_SOCKET "AT+USOCL"
89#define C4GLTE3E_CMD_CONNECT_SOCKET "AT+USOCO"
90#define C4GLTE3E_CMD_WRITE_SOCKET_DATA "AT+USOWR"
91#define C4GLTE3E_CMD_READ_SOCKET_DATA "AT+USORD"
92#define C4GLTE3E_CMD_GPIO_CONFIG "AT+UGPIOC"
93
98#define C4GLTE3E_RSP_OK "OK"
99#define C4GLTE3E_RSP_ERROR "ERROR"
100
105#define C4GLTE3E_URC_CREATE_SOCKET "+USOCR: "
106#define C4GLTE3E_URC_RECEIVED_DATA "+UUSORD: "
107
112#define C4GLTE3E_POWER_STATE_OFF 0
113#define C4GLTE3E_POWER_STATE_ON 1
114#define C4GLTE3E_POWER_STATE_RESET 2
115
121#define C4GLTE3E_TX_DRV_BUFFER_SIZE 256
122#define C4GLTE3E_RX_DRV_BUFFER_SIZE 256
123
124 // c4glte3e_cmd
125
140#define C4GLTE3E_MAP_MIKROBUS( cfg, mikrobus ) \
141 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
142 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
143 cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
144 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
145 cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
146 cfg.ring = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
147 cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
148
149 // c4glte3e_map
150 // c4glte3e
151
156typedef struct
157{
158 // Output pins
159 digital_out_t pwr;
160 digital_out_t rst;
161 digital_out_t rts;
163 // Input pins
164 digital_in_t ring;
165 digital_in_t cts;
167 // Modules
168 uart_t uart;
170 // Buffers
171 uint8_t uart_rx_buffer[ C4GLTE3E_RX_DRV_BUFFER_SIZE ];
172 uint8_t uart_tx_buffer[ C4GLTE3E_TX_DRV_BUFFER_SIZE ];
173 uint8_t cmd_buffer[ C4GLTE3E_TX_DRV_BUFFER_SIZE ];
175} c4glte3e_t;
176
181typedef struct
182{
183 // Communication gpio pins
184 pin_name_t rx_pin;
185 pin_name_t tx_pin;
187 // Additional gpio pins
188 pin_name_t pwr;
189 pin_name_t rst;
190 pin_name_t rts;
191 pin_name_t ring;
192 pin_name_t cts;
194 // Static variable
195 uint32_t baud_rate;
197 uart_data_bits_t data_bit;
198 uart_parity_t parity_bit;
199 uart_stop_bits_t stop_bit;
202
216
233
248
261err_t c4glte3e_generic_write ( c4glte3e_t *ctx, uint8_t *data_in, uint16_t len );
262
275err_t c4glte3e_generic_read ( c4glte3e_t *ctx, uint8_t *data_out, uint16_t len );
276
286void c4glte3e_set_pwr_pin ( c4glte3e_t *ctx, uint8_t state );
287
297void c4glte3e_set_rst_pin ( c4glte3e_t *ctx, uint8_t state );
298
308void c4glte3e_set_rts_pin ( c4glte3e_t *ctx, uint8_t state );
309
319
329
341void c4glte3e_set_power_state ( c4glte3e_t *ctx, uint8_t state );
342
352void c4glte3e_cmd_run ( c4glte3e_t *ctx, uint8_t *cmd );
353
364void c4glte3e_cmd_set ( c4glte3e_t *ctx, uint8_t *cmd, uint8_t *value );
365
375void c4glte3e_cmd_get ( c4glte3e_t *ctx, uint8_t *cmd );
376
386void c4glte3e_cmd_help ( c4glte3e_t *ctx, uint8_t *cmd );
387
397void c4glte3e_set_sim_apn ( c4glte3e_t *ctx, uint8_t *sim_apn );
398
409void c4glte3e_send_sms_text ( c4glte3e_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
410
424err_t c4glte3e_send_sms_pdu ( c4glte3e_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
425
426#ifdef __cplusplus
427}
428#endif
429#endif // C4GLTE3E_H
430
431 // c4glte3e
432
433// ------------------------------------------------------------------------ END
c4glte3e_return_value_t
4G LTE 3 E Click return value data.
Definition c4glte3e.h:208
@ C4GLTE3E_ERROR_TIMEOUT
Definition c4glte3e.h:211
@ C4GLTE3E_ERROR
Definition c4glte3e.h:210
@ C4GLTE3E_ERROR_CMD
Definition c4glte3e.h:212
@ C4GLTE3E_ERROR_UNKNOWN
Definition c4glte3e.h:213
@ C4GLTE3E_OK
Definition c4glte3e.h:209
#define C4GLTE3E_TX_DRV_BUFFER_SIZE
4G LTE 3 E driver buffer size.
Definition c4glte3e.h:121
#define C4GLTE3E_RX_DRV_BUFFER_SIZE
Definition c4glte3e.h:122
void c4glte3e_cmd_run(c4glte3e_t *ctx, uint8_t *cmd)
4G LTE 3 E cmd run function.
uint8_t c4glte3e_get_cts_pin(c4glte3e_t *ctx)
4G LTE 3 E get CTS pin function.
err_t c4glte3e_send_sms_pdu(c4glte3e_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
4G LTE 3 E send SMS in PDU mode.
void c4glte3e_cmd_get(c4glte3e_t *ctx, uint8_t *cmd)
4G LTE 3 E cmd get function.
void c4glte3e_set_pwr_pin(c4glte3e_t *ctx, uint8_t state)
4G LTE 3 E set PWR pin function.
void c4glte3e_set_rst_pin(c4glte3e_t *ctx, uint8_t state)
4G LTE 3 E set RST pin function.
void c4glte3e_set_power_state(c4glte3e_t *ctx, uint8_t state)
4G LTE 3 E set power state function.
void c4glte3e_send_sms_text(c4glte3e_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
4G LTE 3 E send SMS in text mode.
void c4glte3e_cmd_set(c4glte3e_t *ctx, uint8_t *cmd, uint8_t *value)
4G LTE 3 E cmd set function.
void c4glte3e_cfg_setup(c4glte3e_cfg_t *cfg)
4G LTE 3 E configuration object setup function.
uint8_t c4glte3e_get_ring_pin(c4glte3e_t *ctx)
4G LTE 3 E get RING pin function.
err_t c4glte3e_init(c4glte3e_t *ctx, c4glte3e_cfg_t *cfg)
4G LTE 3 E initialization function.
err_t c4glte3e_generic_write(c4glte3e_t *ctx, uint8_t *data_in, uint16_t len)
4G LTE 3 E data writing function.
void c4glte3e_set_sim_apn(c4glte3e_t *ctx, uint8_t *sim_apn)
Set sim card APN.
void c4glte3e_cmd_help(c4glte3e_t *ctx, uint8_t *cmd)
4G LTE 3 E cmd help function.
void c4glte3e_set_rts_pin(c4glte3e_t *ctx, uint8_t state)
4G LTE 3 E set RTS pin function.
err_t c4glte3e_generic_read(c4glte3e_t *ctx, uint8_t *data_out, uint16_t len)
4G LTE 3 E data reading function.
4G LTE 3 E Click configuration object.
Definition c4glte3e.h:182
pin_name_t rts
Definition c4glte3e.h:190
uint32_t baud_rate
Definition c4glte3e.h:195
pin_name_t cts
Definition c4glte3e.h:192
pin_name_t ring
Definition c4glte3e.h:191
bool uart_blocking
Definition c4glte3e.h:196
uart_data_bits_t data_bit
Definition c4glte3e.h:197
pin_name_t tx_pin
Definition c4glte3e.h:185
pin_name_t pwr
Definition c4glte3e.h:188
pin_name_t rx_pin
Definition c4glte3e.h:184
uart_stop_bits_t stop_bit
Definition c4glte3e.h:199
uart_parity_t parity_bit
Definition c4glte3e.h:198
pin_name_t rst
Definition c4glte3e.h:189
4G LTE 3 E Click context object.
Definition c4glte3e.h:157
digital_out_t pwr
Definition c4glte3e.h:159
digital_out_t rts
Definition c4glte3e.h:161
uart_t uart
Definition c4glte3e.h:168
digital_in_t cts
Definition c4glte3e.h:165
digital_out_t rst
Definition c4glte3e.h:160
digital_in_t ring
Definition c4glte3e.h:164