lteiot5 2.0.0.0
lteiot5.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 LTEIOT5_H
29#define LTEIOT5_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
59// TODO -- dodati makroe koji definisu adrese registara
60 // lteiot5_reg
62
77#define LTEIOT5_CMD_AT "AT"
78#define LTEIOT5_CMD_ATI "ATI"
79#define LTEIOT5_CMD_CGMR "AT+CGMR"
80
81#define LTEIOT5_CMD_CFUN "AT+CFUN"
82#define LTEIOT5_CMD_CREG "AT+CREG"
83#define LTEIOT5_CMD_CEREG "AT+CEREG"
84#define LTEIOT5_CMD_CGDCONT "AT+CGDCONT"
85#define LTEIOT5_CMD_CIMI "AT+CIMI"
86#define LTEIOT5_CMD_CGATT "AT+CGATT"
87#define LTEIOT5_CMD_CSQ "AT+CSQ"
88#define LTEIOT5_CMD_CESQ "AT+CESQ"
89#define LTEIOT5_CMD_COPS "AT+COPS"
90#define LTEIOT5_CMD_URAT "AT+URAT"
91#define LTEIOT5_CMD_UBANDMASK "AT+UBANDMASK"
92#define LTEIOT5_CMD_URATCONF "AT+URATCONF"
93#define LTEIOT5_CMD_UAUTHREQ "AT+UAUTHREQ"
94#define LTEIOT5_CMD_UUICC "AT+UUICC"
95#define LTEIOT5_CMD_UCGED "AT+UCGED"
96#define LTEIOT5_CMD_UCELLINFO "AT+UCELLINFO"
97#define LTEIOT5_CMD_UANTR "AT+UANTR"
98
99// "AT+CGMR"
100
106#define DRV_RX_BUFFER_SIZE 500
107#define DRV_TX_BUFFER_SIZE 150
108 // lteiot5_set
110
125#define LTEIOT5_MAP_MIKROBUS( cfg, mikrobus ) \
126 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
127 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
128 cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
129 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
130 cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
131 cfg.ri = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
132 cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
133 // lteiot5_map // lteiot5
136
141typedef struct
142{
143 // Output pins
144
145 digital_out_t pwr;
146 digital_out_t rst;
147 digital_out_t rts;
149 // Input pins
150
151 digital_in_t ri;
152 digital_in_t cts;
154 // Modules
155
156 uart_t uart;
158 // Buffers
159
160 char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
161 char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
163} lteiot5_t;
164
169typedef struct
170{
171 // Communication gpio pins
172
173 pin_name_t rx_pin;
174 pin_name_t tx_pin;
176 // Additional gpio pins
177
178 pin_name_t pwr;
179 pin_name_t rst;
180 pin_name_t rts;
181 pin_name_t ri;
182 pin_name_t cts;
184 // Static variable
185
186 uint32_t baud_rate;
188 uart_data_bits_t data_bit;
189 uart_parity_t parity_bit;
190 uart_stop_bits_t stop_bit;
193
210
226
241
255err_t lteiot5_generic_write ( lteiot5_t *ctx, char *data_buf, uint16_t len );
256
270err_t lteiot5_generic_read ( lteiot5_t *ctx, char *data_buf, uint16_t max_len );
271
280
289
298void lteiot5_set_pwr ( lteiot5_t *ctx, uint8_t state );
299
308void lteiot5_set_rst ( lteiot5_t *ctx, uint8_t state );
309
318void lteiot5_set_rts ( lteiot5_t *ctx, uint8_t state );
319
328uint8_t lteiot5_get_ri ( lteiot5_t *ctx );
329
338uint8_t lteiot5_get_cts ( lteiot5_t *ctx );
339
349void lteiot5_send_cmd ( lteiot5_t *ctx, char *cmd );
350
361void lteiot5_send_cmd_with_parameter ( lteiot5_t *ctx, char *at_cmd_buf, char *param_buf );
362
372void lteiot5_send_cmd_check ( lteiot5_t *ctx, char *at_cmd_buf );
373
383void lteiot5_send_cmd_parameter_check ( lteiot5_t *ctx, char *at_cmd_buf );
384
394void lteiot5_set_sim_apn ( lteiot5_t *ctx, char *sim_apn );
395
406void lteiot5_send_text_message ( lteiot5_t *ctx, char *phone_number, char *message_context );
407
408#ifdef __cplusplus
409}
410#endif
411#endif // LTEIOT5_H
412 // lteiot5
414
415// ------------------------------------------------------------------------ END
#define DRV_RX_BUFFER_SIZE
LTE IoT 5 driver buffer size.
Definition: lteiot5.h:106
#define DRV_TX_BUFFER_SIZE
Definition: lteiot5.h:107
err_t lteiot5_init(lteiot5_t *ctx, lteiot5_cfg_t *cfg)
LTE IoT 5 initialization function.
uint8_t lteiot5_get_ri(lteiot5_t *ctx)
RI Pin Get function.
err_t lteiot5_generic_read(lteiot5_t *ctx, char *data_buf, uint16_t max_len)
LTE IoT 5 data reading function.
void lteiot5_send_text_message(lteiot5_t *ctx, char *phone_number, char *message_context)
LTE IoT 5 send text message.
err_t lteiot5_generic_write(lteiot5_t *ctx, char *data_buf, uint16_t len)
LTE IoT 5 data writing function.
void lteiot5_send_cmd_check(lteiot5_t *ctx, char *at_cmd_buf)
Check the sent command.
void lteiot5_reset(lteiot5_t *ctx)
LTE IoT 5 power on.
void lteiot5_set_sim_apn(lteiot5_t *ctx, char *sim_apn)
Set sim card APN.
void lteiot5_send_cmd_with_parameter(lteiot5_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
void lteiot5_cfg_setup(lteiot5_cfg_t *cfg)
LTE IoT 5 configuration object setup function.
void lteiot5_send_cmd_parameter_check(lteiot5_t *ctx, char *at_cmd_buf)
Check the command parameters.
uint8_t lteiot5_get_cts(lteiot5_t *ctx)
CTS Pin Get function.
void lteiot5_power_on(lteiot5_t *ctx)
LTE IoT 5 power on.
err_t lteiot5_default_cfg(lteiot5_t *ctx)
LTE IoT 5 default configuration function.
void lteiot5_send_cmd(lteiot5_t *ctx, char *cmd)
Send command function.
void lteiot5_set_rts(lteiot5_t *ctx, uint8_t state)
Sets state of the RTS pin.
void lteiot5_set_pwr(lteiot5_t *ctx, uint8_t state)
Sets state of the PWR pin.
void lteiot5_set_rst(lteiot5_t *ctx, uint8_t state)
Sets state of the RST pin.
LTE IoT 5 Click configuration object.
Definition: lteiot5.h:170
pin_name_t rts
Definition: lteiot5.h:180
uint32_t baud_rate
Definition: lteiot5.h:186
pin_name_t cts
Definition: lteiot5.h:182
bool uart_blocking
Definition: lteiot5.h:187
pin_name_t ri
Definition: lteiot5.h:181
uart_data_bits_t data_bit
Definition: lteiot5.h:188
pin_name_t tx_pin
Definition: lteiot5.h:174
pin_name_t pwr
Definition: lteiot5.h:178
pin_name_t rx_pin
Definition: lteiot5.h:173
uart_stop_bits_t stop_bit
Definition: lteiot5.h:190
uart_parity_t parity_bit
Definition: lteiot5.h:189
pin_name_t rst
Definition: lteiot5.h:179
LTE IoT 5 Click context object.
Definition: lteiot5.h:142
digital_out_t pwr
Definition: lteiot5.h:145
digital_out_t rts
Definition: lteiot5.h:147
digital_in_t ri
Definition: lteiot5.h:151
uart_t uart
Definition: lteiot5.h:156
digital_in_t cts
Definition: lteiot5.h:152
digital_out_t rst
Definition: lteiot5.h:146