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
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 
70 #define LTECAT1EU_CMD_AT "AT"
71 #define LTECAT1EU_CMD_ATI "ATI"
72 #define LTECAT1EU_CMD_CGMR "AT+CGMR"
73 
74 #define LTECAT1EU_CMD_CFUN "AT+CFUN"
75 #define LTECAT1EU_CMD_CREG "AT+CREG"
76 #define LTECAT1EU_CMD_CEREG "AT+CEREG"
77 #define LTECAT1EU_CMD_CGDCONT "AT+CGDCONT"
78 #define LTECAT1EU_CMD_CIMI "AT+CIMI"
79 #define LTECAT1EU_CMD_CGATT "AT+CGATT"
80 #define LTECAT1EU_CMD_CSQ "AT+CSQ"
81 #define LTECAT1EU_CMD_CESQ "AT+CESQ"
82 #define LTECAT1EU_CMD_COPS "AT+COPS"
83 
84 
90 #define DRV_RX_BUFFER_SIZE 500
91 #define DRV_TX_BUFFER_SIZE 100
92  // ltecat1eu_set
94 
109 #define LTECAT1EU_MAP_MIKROBUS( cfg, mikrobus ) \
110  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
111  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
112  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
113  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
114  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
115  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT )
116  // ltecat1eu_map // ltecat1eu
119 
124 typedef struct
125 {
126  // Output pins
127  digital_out_t rst;
128  digital_out_t cs;
129  digital_out_t rts;
130 
131  // Input pins
132  digital_in_t cts;
133 
134  // Modules
135  uart_t uart;
137  // Buffers
138  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
139  char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
141 } ltecat1eu_t;
142 
147 typedef struct
148 {
149  // Communication gpio pins
150  pin_name_t rx_pin;
151  pin_name_t tx_pin;
153  // Additional gpio pins
154  //pin_name_t an;
155  pin_name_t rst;
156  pin_name_t cts;
157  pin_name_t cs;
158  pin_name_t rts;
159 
160  // Static variable
161  uint32_t baud_rate;
163  uart_data_bits_t data_bit;
164  uart_parity_t parity_bit;
165  uart_stop_bits_t stop_bit;
168 
173 typedef enum
174 {
176  LTECAT1EU_ERROR = -1
177 
179 
196 
212 
224 void ltecat1eu_generic_write ( ltecat1eu_t *ctx, char *data_buf, uint16_t len );
225 
239 err_t ltecat1eu_generic_read ( ltecat1eu_t *ctx, char *data_buf, uint16_t max_len );
240 
241 
250 
259 void ltecat1eu_set_rst ( ltecat1eu_t *ctx, uint8_t state );
260 
269 void ltecat1eu_set_rts ( ltecat1eu_t *ctx, uint8_t state );
270 
280 
290 void ltecat1eu_send_cmd ( ltecat1eu_t *ctx, char *cmd );
291 
302 void ltecat1eu_send_cmd_with_parameter ( ltecat1eu_t *ctx, char *at_cmd_buf, char *param_buf );
303 
313 void ltecat1eu_send_cmd_check ( ltecat1eu_t *ctx, char *at_cmd_buf );
314 
324 void ltecat1eu_send_cmd_parameter_check ( ltecat1eu_t *ctx, char *at_cmd_buf );
325 
335 void ltecat1eu_set_sim_apn ( ltecat1eu_t *ctx, char *sim_apn );
336 
347 void ltecat1eu_send_text_message ( ltecat1eu_t *ctx, char *phone_number, char *message_context );
348 
349 #ifdef __cplusplus
350 }
351 #endif
352 #endif // LTECAT1EU_H
353  // ltecat1eu
355 
356 // ------------------------------------------------------------------------ END
ltecat1eu_t::uart
uart_t uart
Definition: ltecat1eu.h:135
ltecat1eu_get_cts
uint8_t ltecat1eu_get_cts(ltecat1eu_t *ctx)
CTS Pin Get function.
ltecat1eu_t
LTE Cat.1-EU Click context object.
Definition: ltecat1eu.h:125
ltecat1eu_power_on
void ltecat1eu_power_on(ltecat1eu_t *ctx)
LTE Cat.1-EU module power on.
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
LTE Cat.1-EU driver buffer size.
Definition: ltecat1eu.h:90
ltecat1eu_generic_write
void ltecat1eu_generic_write(ltecat1eu_t *ctx, char *data_buf, uint16_t len)
LTE Cat.1-EU data writing function.
ltecat1eu_cfg_t::rx_pin
pin_name_t rx_pin
Definition: ltecat1eu.h:150
ltecat1eu_cfg_t::cs
pin_name_t cs
Definition: ltecat1eu.h:157
ltecat1eu_set_rst
void ltecat1eu_set_rst(ltecat1eu_t *ctx, uint8_t state)
Sets state of the RST pin.
ltecat1eu_cfg_setup
void ltecat1eu_cfg_setup(ltecat1eu_cfg_t *cfg)
LTE Cat.1-EU configuration object setup function.
ltecat1eu_t::rst
digital_out_t rst
Definition: ltecat1eu.h:127
ltecat1eu_send_cmd_check
void ltecat1eu_send_cmd_check(ltecat1eu_t *ctx, char *at_cmd_buf)
Check the sent command.
ltecat1eu_send_cmd_with_parameter
void ltecat1eu_send_cmd_with_parameter(ltecat1eu_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
ltecat1eu_send_text_message
void ltecat1eu_send_text_message(ltecat1eu_t *ctx, char *phone_number, char *message_context)
LTE Cat.1-EU send text message.
ltecat1eu_init
err_t ltecat1eu_init(ltecat1eu_t *ctx, ltecat1eu_cfg_t *cfg)
LTE Cat.1-EU initialization function.
ltecat1eu_generic_read
err_t ltecat1eu_generic_read(ltecat1eu_t *ctx, char *data_buf, uint16_t max_len)
LTE Cat.1-EU data reading function.
ltecat1eu_cfg_t::uart_blocking
bool uart_blocking
Definition: ltecat1eu.h:162
ltecat1eu_return_value_t
ltecat1eu_return_value_t
LTE Cat.1-EU Click return value data.
Definition: ltecat1eu.h:174
ltecat1eu_cfg_t
LTE Cat.1-EU Click configuration object.
Definition: ltecat1eu.h:148
ltecat1eu_cfg_t::rts
pin_name_t rts
Definition: ltecat1eu.h:158
LTECAT1EU_OK
@ LTECAT1EU_OK
Definition: ltecat1eu.h:175
LTECAT1EU_ERROR
@ LTECAT1EU_ERROR
Definition: ltecat1eu.h:176
ltecat1eu_cfg_t::tx_pin
pin_name_t tx_pin
Definition: ltecat1eu.h:151
ltecat1eu_set_rts
void ltecat1eu_set_rts(ltecat1eu_t *ctx, uint8_t state)
Sets state of the RTS pin.
ltecat1eu_cfg_t::rst
pin_name_t rst
Definition: ltecat1eu.h:155
ltecat1eu_t::cs
digital_out_t cs
Definition: ltecat1eu.h:128
ltecat1eu_send_cmd
void ltecat1eu_send_cmd(ltecat1eu_t *ctx, char *cmd)
Send command function.
ltecat1eu_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: ltecat1eu.h:165
ltecat1eu_cfg_t::baud_rate
uint32_t baud_rate
Definition: ltecat1eu.h:161
ltecat1eu_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: ltecat1eu.h:163
ltecat1eu_t::rts
digital_out_t rts
Definition: ltecat1eu.h:129
ltecat1eu_send_cmd_parameter_check
void ltecat1eu_send_cmd_parameter_check(ltecat1eu_t *ctx, char *at_cmd_buf)
Check the command parameters.
DRV_TX_BUFFER_SIZE
#define DRV_TX_BUFFER_SIZE
Definition: ltecat1eu.h:91
ltecat1eu_t::cts
digital_in_t cts
Definition: ltecat1eu.h:132
ltecat1eu_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: ltecat1eu.h:164
ltecat1eu_set_sim_apn
void ltecat1eu_set_sim_apn(ltecat1eu_t *ctx, char *sim_apn)
Set sim card APN.
ltecat1eu_cfg_t::cts
pin_name_t cts
Definition: ltecat1eu.h:156