ltecat1eu 2.0.0.0
ltecat1eu.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 LTECAT1EU_H
29#define LTECAT1EU_H
30
31#ifdef __cplusplus
32extern "C"{
33#endif
34
35#include "drv_digital_out.h"
36#include "drv_digital_in.h"
37#include "drv_uart.h"
38
60#define LTECAT1EU_CMD_AT "AT"
61#define LTECAT1EU_CMD_ATI "ATI"
62#define LTECAT1EU_CMD_CGMR "AT+CGMR"
63
64#define LTECAT1EU_CMD_CFUN "AT+CFUN"
65#define LTECAT1EU_CMD_CREG "AT+CREG"
66#define LTECAT1EU_CMD_CEREG "AT+CEREG"
67#define LTECAT1EU_CMD_CGDCONT "AT+CGDCONT"
68#define LTECAT1EU_CMD_CIMI "AT+CIMI"
69#define LTECAT1EU_CMD_CGATT "AT+CGATT"
70#define LTECAT1EU_CMD_CSQ "AT+CSQ"
71#define LTECAT1EU_CMD_CESQ "AT+CESQ"
72#define LTECAT1EU_CMD_COPS "AT+COPS"
73
74
80#define DRV_RX_BUFFER_SIZE 500
81#define DRV_TX_BUFFER_SIZE 100
82 // ltecat1eu_set
84
99#define LTECAT1EU_MAP_MIKROBUS( cfg, mikrobus ) \
100 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
101 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
102 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
103 cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
104 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
105 cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT )
106 // ltecat1eu_map // ltecat1eu
109
114typedef struct
115{
116 // Output pins
117 digital_out_t rst;
118 digital_out_t cs;
119 digital_out_t rts;
120
121 // Input pins
122 digital_in_t cts;
123
124 // Modules
125 uart_t uart;
127 // Buffers
128 char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
129 char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
132
137typedef struct
138{
139 // Communication gpio pins
140 pin_name_t rx_pin;
141 pin_name_t tx_pin;
143 // Additional gpio pins
144 //pin_name_t an;
145 pin_name_t rst;
146 pin_name_t cts;
147 pin_name_t cs;
148 pin_name_t rts;
149
150 // Static variable
151 uint32_t baud_rate;
153 uart_data_bits_t data_bit;
154 uart_parity_t parity_bit;
155 uart_stop_bits_t stop_bit;
158
163typedef enum
164{
166 LTECAT1EU_ERROR = -1
167
169
186
202
214void ltecat1eu_generic_write ( ltecat1eu_t *ctx, char *data_buf, uint16_t len );
215
229err_t ltecat1eu_generic_read ( ltecat1eu_t *ctx, char *data_buf, uint16_t max_len );
230
231
240
249void ltecat1eu_set_rst ( ltecat1eu_t *ctx, uint8_t state );
250
259void ltecat1eu_set_rts ( ltecat1eu_t *ctx, uint8_t state );
260
270
280void ltecat1eu_send_cmd ( ltecat1eu_t *ctx, char *cmd );
281
292void ltecat1eu_send_cmd_with_parameter ( ltecat1eu_t *ctx, char *at_cmd_buf, char *param_buf );
293
303void ltecat1eu_send_cmd_check ( ltecat1eu_t *ctx, char *at_cmd_buf );
304
314void ltecat1eu_send_cmd_parameter_check ( ltecat1eu_t *ctx, char *at_cmd_buf );
315
325void ltecat1eu_set_sim_apn ( ltecat1eu_t *ctx, char *sim_apn );
326
337void ltecat1eu_send_text_message ( ltecat1eu_t *ctx, char *phone_number, char *message_context );
338
339#ifdef __cplusplus
340}
341#endif
342#endif // LTECAT1EU_H
343 // ltecat1eu
345
346// ------------------------------------------------------------------------ END
#define DRV_RX_BUFFER_SIZE
LTE Cat.1-EU driver buffer size.
Definition: ltecat1eu.h:80
#define DRV_TX_BUFFER_SIZE
Definition: ltecat1eu.h:81
void ltecat1eu_send_cmd_check(ltecat1eu_t *ctx, char *at_cmd_buf)
Check the sent command.
void ltecat1eu_send_cmd_parameter_check(ltecat1eu_t *ctx, char *at_cmd_buf)
Check the command parameters.
uint8_t ltecat1eu_get_cts(ltecat1eu_t *ctx)
CTS Pin Get function.
void ltecat1eu_set_sim_apn(ltecat1eu_t *ctx, char *sim_apn)
Set sim card APN.
void ltecat1eu_cfg_setup(ltecat1eu_cfg_t *cfg)
LTE Cat.1-EU configuration object setup function.
void ltecat1eu_set_rst(ltecat1eu_t *ctx, uint8_t state)
Sets state of the RST pin.
void ltecat1eu_power_on(ltecat1eu_t *ctx)
LTE Cat.1-EU module power on.
err_t ltecat1eu_generic_read(ltecat1eu_t *ctx, char *data_buf, uint16_t max_len)
LTE Cat.1-EU data reading function.
void ltecat1eu_set_rts(ltecat1eu_t *ctx, uint8_t state)
Sets state of the RTS pin.
err_t ltecat1eu_init(ltecat1eu_t *ctx, ltecat1eu_cfg_t *cfg)
LTE Cat.1-EU initialization function.
void ltecat1eu_generic_write(ltecat1eu_t *ctx, char *data_buf, uint16_t len)
LTE Cat.1-EU data writing function.
void ltecat1eu_send_text_message(ltecat1eu_t *ctx, char *phone_number, char *message_context)
LTE Cat.1-EU send text message.
void ltecat1eu_send_cmd(ltecat1eu_t *ctx, char *cmd)
Send command function.
void ltecat1eu_send_cmd_with_parameter(ltecat1eu_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
ltecat1eu_return_value_t
LTE Cat.1-EU Click return value data.
Definition: ltecat1eu.h:164
@ LTECAT1EU_OK
Definition: ltecat1eu.h:165
@ LTECAT1EU_ERROR
Definition: ltecat1eu.h:166
LTE Cat.1-EU Click configuration object.
Definition: ltecat1eu.h:138
pin_name_t rts
Definition: ltecat1eu.h:148
uint32_t baud_rate
Definition: ltecat1eu.h:151
pin_name_t cts
Definition: ltecat1eu.h:146
bool uart_blocking
Definition: ltecat1eu.h:152
uart_data_bits_t data_bit
Definition: ltecat1eu.h:153
pin_name_t tx_pin
Definition: ltecat1eu.h:141
pin_name_t rx_pin
Definition: ltecat1eu.h:140
uart_stop_bits_t stop_bit
Definition: ltecat1eu.h:155
uart_parity_t parity_bit
Definition: ltecat1eu.h:154
pin_name_t rst
Definition: ltecat1eu.h:145
pin_name_t cs
Definition: ltecat1eu.h:147
LTE Cat.1-EU Click context object.
Definition: ltecat1eu.h:115
digital_out_t cs
Definition: ltecat1eu.h:118
digital_out_t rts
Definition: ltecat1eu.h:119
uart_t uart
Definition: ltecat1eu.h:125
digital_in_t cts
Definition: ltecat1eu.h:122
digital_out_t rst
Definition: ltecat1eu.h:117