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
32 extern "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 // TODO -- dodati makroe koji definisu komande/vrednosti koje se upisuju u registre
78 #define LTEIOT5_CMD_AT "AT"
79 #define LTEIOT5_CMD_ATI "ATI"
80 #define LTEIOT5_CMD_CGMR "AT+CGMR"
81 
82 #define LTEIOT5_CMD_CFUN "AT+CFUN"
83 #define LTEIOT5_CMD_CREG "AT+CREG"
84 #define LTEIOT5_CMD_CEREG "AT+CEREG"
85 #define LTEIOT5_CMD_CGDCONT "AT+CGDCONT"
86 #define LTEIOT5_CMD_CIMI "AT+CIMI"
87 #define LTEIOT5_CMD_CGATT "AT+CGATT"
88 #define LTEIOT5_CMD_CSQ "AT+CSQ"
89 #define LTEIOT5_CMD_CESQ "AT+CESQ"
90 #define LTEIOT5_CMD_COPS "AT+COPS"
91 #define LTEIOT5_CMD_URAT "AT+URAT"
92 #define LTEIOT5_CMD_UBANDMASK "AT+UBANDMASK"
93 #define LTEIOT5_CMD_URATCONF "AT+URATCONF"
94 #define LTEIOT5_CMD_UAUTHREQ "AT+UAUTHREQ"
95 #define LTEIOT5_CMD_UUICC "AT+UUICC"
96 #define LTEIOT5_CMD_UCGED "AT+UCGED"
97 #define LTEIOT5_CMD_UCELLINFO "AT+UCELLINFO"
98 #define LTEIOT5_CMD_UANTR "AT+UANTR"
99 
100 // "AT+CGMR"
101 
107 #define DRV_RX_BUFFER_SIZE 500
108 #define DRV_TX_BUFFER_SIZE 150
109  // lteiot5_set
111 
126 #define LTEIOT5_MAP_MIKROBUS( cfg, mikrobus ) \
127  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
128  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
129  cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
130  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
131  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
132  cfg.ri = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
133  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
134  // lteiot5_map // lteiot5
137 
142 typedef struct
143 {
144  // Output pins
145 
146  digital_out_t pwr;
147  digital_out_t rst;
148  digital_out_t rts;
150  // Input pins
151 
152  digital_in_t ri;
153  digital_in_t cts;
155  // Modules
156 
157  uart_t uart;
159  // Buffers
160 
161  char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
162  char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
164 } lteiot5_t;
165 
170 typedef struct
171 {
172  // Communication gpio pins
173 
174  pin_name_t rx_pin;
175  pin_name_t tx_pin;
177  // Additional gpio pins
178 
179  pin_name_t pwr;
180  pin_name_t rst;
181  pin_name_t rts;
182  pin_name_t ri;
183  pin_name_t cts;
185  // Static variable
186 
187  uint32_t baud_rate;
189  uart_data_bits_t data_bit;
190  uart_parity_t parity_bit;
191  uart_stop_bits_t stop_bit;
193 } lteiot5_cfg_t;
194 
211 
226 err_t lteiot5_init ( lteiot5_t *ctx, lteiot5_cfg_t *cfg );
227 
242 
256 err_t lteiot5_generic_write ( lteiot5_t *ctx, char *data_buf, uint16_t len );
257 
271 err_t lteiot5_generic_read ( lteiot5_t *ctx, char *data_buf, uint16_t max_len );
272 
281 
289 void lteiot5_reset ( lteiot5_t *ctx );
290 
299 void lteiot5_set_pwr ( lteiot5_t *ctx, uint8_t state );
300 
309 void lteiot5_set_rst ( lteiot5_t *ctx, uint8_t state );
310 
319 void lteiot5_set_rts ( lteiot5_t *ctx, uint8_t state );
320 
329 uint8_t lteiot5_get_ri ( lteiot5_t *ctx );
330 
339 uint8_t lteiot5_get_cts ( lteiot5_t *ctx );
340 
350 void lteiot5_send_cmd ( lteiot5_t *ctx, char *cmd );
351 
362 void lteiot5_send_cmd_with_parameter ( lteiot5_t *ctx, char *at_cmd_buf, char *param_buf );
363 
373 void lteiot5_send_cmd_check ( lteiot5_t *ctx, char *at_cmd_buf );
374 
384 void lteiot5_send_cmd_parameter_check ( lteiot5_t *ctx, char *at_cmd_buf );
385 
395 void lteiot5_set_sim_apn ( lteiot5_t *ctx, char *sim_apn );
396 
407 void lteiot5_send_text_message ( lteiot5_t *ctx, char *phone_number, char *message_context );
408 
409 #ifdef __cplusplus
410 }
411 #endif
412 #endif // LTEIOT5_H
413  // lteiot5
415 
416 // ------------------------------------------------------------------------ END
lteiot5_send_text_message
void lteiot5_send_text_message(lteiot5_t *ctx, char *phone_number, char *message_context)
LTE IoT 5 send text message.
lteiot5_generic_write
err_t lteiot5_generic_write(lteiot5_t *ctx, char *data_buf, uint16_t len)
LTE IoT 5 data writing function.
lteiot5_send_cmd
void lteiot5_send_cmd(lteiot5_t *ctx, char *cmd)
Send command function.
lteiot5_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: lteiot5.h:191
lteiot5_set_rst
void lteiot5_set_rst(lteiot5_t *ctx, uint8_t state)
Sets state of the RST pin.
lteiot5_cfg_t::baud_rate
uint32_t baud_rate
Definition: lteiot5.h:187
lteiot5_cfg_t::rx_pin
pin_name_t rx_pin
Definition: lteiot5.h:174
lteiot5_cfg_t::rst
pin_name_t rst
Definition: lteiot5.h:180
lteiot5_t::ri
digital_in_t ri
Definition: lteiot5.h:152
DRV_RX_BUFFER_SIZE
#define DRV_RX_BUFFER_SIZE
LTE IoT 5 driver buffer size.
Definition: lteiot5.h:107
lteiot5_cfg_t::ri
pin_name_t ri
Definition: lteiot5.h:182
lteiot5_init
err_t lteiot5_init(lteiot5_t *ctx, lteiot5_cfg_t *cfg)
LTE IoT 5 initialization function.
DRV_TX_BUFFER_SIZE
#define DRV_TX_BUFFER_SIZE
Definition: lteiot5.h:108
lteiot5_set_pwr
void lteiot5_set_pwr(lteiot5_t *ctx, uint8_t state)
Sets state of the PWR pin.
lteiot5_cfg_t::cts
pin_name_t cts
Definition: lteiot5.h:183
lteiot5_cfg_t
LTE IoT 5 Click configuration object.
Definition: lteiot5.h:171
lteiot5_default_cfg
err_t lteiot5_default_cfg(lteiot5_t *ctx)
LTE IoT 5 default configuration function.
lteiot5_cfg_t::pwr
pin_name_t pwr
Definition: lteiot5.h:179
lteiot5_t
LTE IoT 5 Click context object.
Definition: lteiot5.h:143
lteiot5_t::rst
digital_out_t rst
Definition: lteiot5.h:147
lteiot5_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: lteiot5.h:190
lteiot5_t::cts
digital_in_t cts
Definition: lteiot5.h:153
lteiot5_send_cmd_with_parameter
void lteiot5_send_cmd_with_parameter(lteiot5_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
lteiot5_get_cts
uint8_t lteiot5_get_cts(lteiot5_t *ctx)
CTS Pin Get function.
lteiot5_cfg_t::uart_blocking
bool uart_blocking
Definition: lteiot5.h:188
lteiot5_set_rts
void lteiot5_set_rts(lteiot5_t *ctx, uint8_t state)
Sets state of the RTS pin.
lteiot5_get_ri
uint8_t lteiot5_get_ri(lteiot5_t *ctx)
RI Pin Get function.
lteiot5_send_cmd_parameter_check
void lteiot5_send_cmd_parameter_check(lteiot5_t *ctx, char *at_cmd_buf)
Check the command parameters.
lteiot5_cfg_setup
void lteiot5_cfg_setup(lteiot5_cfg_t *cfg)
LTE IoT 5 configuration object setup function.
lteiot5_cfg_t::tx_pin
pin_name_t tx_pin
Definition: lteiot5.h:175
lteiot5_t::rts
digital_out_t rts
Definition: lteiot5.h:148
lteiot5_t::pwr
digital_out_t pwr
Definition: lteiot5.h:146
lteiot5_generic_read
err_t lteiot5_generic_read(lteiot5_t *ctx, char *data_buf, uint16_t max_len)
LTE IoT 5 data reading function.
lteiot5_t::uart
uart_t uart
Definition: lteiot5.h:157
lteiot5_reset
void lteiot5_reset(lteiot5_t *ctx)
LTE IoT 5 power on.
lteiot5_set_sim_apn
void lteiot5_set_sim_apn(lteiot5_t *ctx, char *sim_apn)
Set sim card APN.
lteiot5_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: lteiot5.h:189
lteiot5_cfg_t::rts
pin_name_t rts
Definition: lteiot5.h:181
lteiot5_power_on
void lteiot5_power_on(lteiot5_t *ctx)
LTE IoT 5 power on.
lteiot5_send_cmd_check
void lteiot5_send_cmd_check(lteiot5_t *ctx, char *at_cmd_buf)
Check the sent command.