lteiot7  2.1.0.0
lteiot7.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 LTEIOT7_H
29 #define LTEIOT7_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 #define LTEIOT7_CMD_AT "AT"
60 #define LTEIOT7_CMD_ATI "ATI"
61 #define LTEIOT7_CMD_CGMR "AT+CGMR"
62 #define LTEIOT7_CMD_CFUN "AT+CFUN"
63 #define LTEIOT7_CMD_CREG "AT+CREG"
64 #define LTEIOT7_CMD_CGREG "AT+CGREG"
65 #define LTEIOT7_CMD_CGDCONT "AT+CGDCONT"
66 #define LTEIOT7_CMD_CIMI "AT+CIMI"
67 #define LTEIOT7_CMD_CMEE "AT+CMEE"
68 #define LTEIOT7_CMD_CGATT "AT+CGATT"
69 #define LTEIOT7_CMD_CSQ "AT+CSQ"
70 #define LTEIOT7_CMD_COPS "AT+COPS"
71 #define LTEIOT7_CMD_CMGS "AT+CMGS"
72 #define LTEIOT7_CMD_CMGF "AT+CMGF"
73 #define LTEIOT7_CMD_CGACT "AT+CGACT"
74 #define LTEIOT7_CMD_USOCR "AT+USOCR"
75 #define LTEIOT7_CMD_USOCO "AT+USOCO"
76 #define LTEIOT7_CMD_USOWR "AT+USOWR"
77 #define LTEIOT7_CMD_USORD "AT+USORD"
78 #define LTEIOT7_CMD_USORF "AT+USORF"
79 #define LTEIOT7_CMD_USOCL "AT+USOCL"
80 #define LTEIOT7_CMD_UGPS "AT+UGPS"
81 #define LTEIOT7_CMD_UGGGA "AT+UGGGA"
82 
87 #define LTEIOT7_RSP_OK "OK"
88 #define LTEIOT7_RSP_ERROR "ERROR"
89 
94 #define LTEIOT7_POWER_STATE_SWITCH 0
95 #define LTEIOT7_POWER_STATE_ON 1
96 #define LTEIOT7_POWER_STATE_REBOOT 2
97 
102 #define LTEIOT7_RSP_START "$"
103 #define LTEIOT7_RSP_DELIMITER ","
104 #define LTEIOT7_RSP_GPGGA "$GPGGA"
105 
110 #define LTEIOT7_GPGGA_ELEMENT_SIZE 15
111 #define LTEIOT7_GPGGA_TIME 1
112 #define LTEIOT7_GPGGA_LATITUDE 2
113 #define LTEIOT7_GPGGA_LATITUDE_SIDE 3
114 #define LTEIOT7_GPGGA_LONGITUDE 4
115 #define LTEIOT7_GPGGA_LONGITUDE_SIDE 5
116 #define LTEIOT7_GPGGA_QUALITY_INDICATOR 6
117 #define LTEIOT7_GPGGA_NUMBER_OF_SATELLITES 7
118 #define LTEIOT7_GPGGA_H_DILUTION_OF_POS 8
119 #define LTEIOT7_GPGGA_ALTITUDE 9
120 #define LTEIOT7_GPGGA_ALTITUDE_UNIT 10
121 #define LTEIOT7_GPGGA_GEOIDAL_SEPARATION 11
122 #define LTEIOT7_GPGGA_GEOIDAL_SEPARATION_UNIT 12
123 #define LTEIOT7_GPGGA_TIME_SINCE_LAST_DGPS 13
124 #define LTEIOT7_GPGGA_DGPS_REFERENCE_STATION_ID 14
125 
131 #define DRV_BUFFER_SIZE 256
132  // lteiot7_cmd
134 
149 #define LTEIOT7_MAP_MIKROBUS( cfg, mikrobus ) \
150  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
151  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
152  cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
153  cfg.ein = MIKROBUS( mikrobus, MIKROBUS_RST ); \
154  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
155  cfg.ri = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
156  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
157  // lteiot7_map // lteiot7
160 
165 typedef struct
166 {
167  // Output pins
168  digital_out_t pwr;
169  digital_out_t ein;
170  digital_out_t rts;
172  // Input pins
173  digital_in_t ri;
174  digital_in_t cts;
176  // Modules
177  uart_t uart;
179  // Buffers
180  char uart_rx_buffer[ DRV_BUFFER_SIZE ];
181  char uart_tx_buffer[ DRV_BUFFER_SIZE ];
183 } lteiot7_t;
184 
189 typedef struct
190 {
191  // Communication gpio pins
192  pin_name_t rx_pin;
193  pin_name_t tx_pin;
195  // Additional gpio pins
196  pin_name_t pwr;
197  pin_name_t ein;
198  pin_name_t rts;
199  pin_name_t ri;
200  pin_name_t cts;
202  // Static variable
203  uint32_t baud_rate;
205  uart_data_bits_t data_bit;
206  uart_parity_t parity_bit;
207  uart_stop_bits_t stop_bit;
209 } lteiot7_cfg_t;
210 
215 typedef enum
216 {
222 
224 
241 
255 err_t lteiot7_init ( lteiot7_t *ctx, lteiot7_cfg_t *cfg );
256 
269 err_t lteiot7_generic_write ( lteiot7_t *ctx, char *data_in, uint16_t len );
270 
283 err_t lteiot7_generic_read ( lteiot7_t *ctx, char *data_out, uint16_t len );
284 
294 void lteiot7_set_pwr_pin ( lteiot7_t *ctx, uint8_t state );
295 
305 void lteiot7_set_ein_pin ( lteiot7_t *ctx, uint8_t state );
306 
316 void lteiot7_set_rts_pin ( lteiot7_t *ctx, uint8_t state );
317 
326 uint8_t lteiot7_get_ri_pin ( lteiot7_t *ctx );
327 
337 
349 void lteiot7_set_power_state ( lteiot7_t *ctx, uint8_t state );
350 
360 void lteiot7_send_cmd ( lteiot7_t *ctx, char *cmd );
361 
372 void lteiot7_send_cmd_with_parameter ( lteiot7_t *ctx, char *at_cmd_buf, char *param_buf );
373 
383 void lteiot7_send_cmd_check ( lteiot7_t *ctx, char *at_cmd_buf );
384 
394 void lteiot7_send_cmd_parameter_check ( lteiot7_t *ctx, char *at_cmd_buf );
395 
405 void lteiot7_set_sim_apn ( lteiot7_t *ctx, char *sim_apn );
406 
417 void lteiot7_send_sms_text ( lteiot7_t *ctx, char *phone_number, char *sms_text );
418 
432 err_t lteiot7_send_sms_pdu ( lteiot7_t *ctx, char *service_center_number, char *phone_number, char *sms_text );
433 
445 err_t lteiot7_parse_gpgga ( char *rsp_buf, uint8_t gpgga_element, char *element_data );
446 
447 #ifdef __cplusplus
448 }
449 #endif
450 #endif // LTEIOT7_H
451  // lteiot7
453 
454 // ------------------------------------------------------------------------ END
lteiot7_cfg_t::pwr
pin_name_t pwr
Definition: lteiot7.h:196
lteiot7_cfg_t::uart_blocking
bool uart_blocking
Definition: lteiot7.h:204
lteiot7_cfg_t::ein
pin_name_t ein
Definition: lteiot7.h:197
lteiot7_get_ri_pin
uint8_t lteiot7_get_ri_pin(lteiot7_t *ctx)
LTE IoT 7 get RI pin function.
LTEIOT7_ERROR
@ LTEIOT7_ERROR
Definition: lteiot7.h:218
lteiot7_get_cts_pin
uint8_t lteiot7_get_cts_pin(lteiot7_t *ctx)
LTE IoT 7 get CTS pin function.
lteiot7_cfg_setup
void lteiot7_cfg_setup(lteiot7_cfg_t *cfg)
LTE IoT 7 configuration object setup function.
LTEIOT7_ERROR_CMD
@ LTEIOT7_ERROR_CMD
Definition: lteiot7.h:220
lteiot7_parse_gpgga
err_t lteiot7_parse_gpgga(char *rsp_buf, uint8_t gpgga_element, char *element_data)
LTE IoT 7 parse GPGGA function.
lteiot7_t::ri
digital_in_t ri
Definition: lteiot7.h:173
lteiot7_set_rts_pin
void lteiot7_set_rts_pin(lteiot7_t *ctx, uint8_t state)
LTE IoT 7 set RTS pin function.
lteiot7_set_pwr_pin
void lteiot7_set_pwr_pin(lteiot7_t *ctx, uint8_t state)
LTE IoT 7 set PWR pin function.
LTEIOT7_ERROR_UNKNOWN
@ LTEIOT7_ERROR_UNKNOWN
Definition: lteiot7.h:221
lteiot7_cfg_t::tx_pin
pin_name_t tx_pin
Definition: lteiot7.h:193
lteiot7_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: lteiot7.h:205
LTEIOT7_ERROR_TIMEOUT
@ LTEIOT7_ERROR_TIMEOUT
Definition: lteiot7.h:219
lteiot7_send_cmd_parameter_check
void lteiot7_send_cmd_parameter_check(lteiot7_t *ctx, char *at_cmd_buf)
Check the command parameters.
lteiot7_set_sim_apn
void lteiot7_set_sim_apn(lteiot7_t *ctx, char *sim_apn)
Set sim card APN.
lteiot7_t
LTE IoT 7 Click context object.
Definition: lteiot7.h:166
lteiot7_t::cts
digital_in_t cts
Definition: lteiot7.h:174
lteiot7_cfg_t
LTE IoT 7 Click configuration object.
Definition: lteiot7.h:190
lteiot7_generic_write
err_t lteiot7_generic_write(lteiot7_t *ctx, char *data_in, uint16_t len)
LTE IoT 7 data writing function.
lteiot7_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: lteiot7.h:207
lteiot7_cfg_t::rts
pin_name_t rts
Definition: lteiot7.h:198
lteiot7_send_cmd
void lteiot7_send_cmd(lteiot7_t *ctx, char *cmd)
Send command function.
lteiot7_return_value_t
lteiot7_return_value_t
LTE IoT 7 Click return value data.
Definition: lteiot7.h:216
DRV_BUFFER_SIZE
#define DRV_BUFFER_SIZE
LTE IoT 7 driver buffer size.
Definition: lteiot7.h:131
lteiot7_send_sms_text
void lteiot7_send_sms_text(lteiot7_t *ctx, char *phone_number, char *sms_text)
LTE IoT 7 send SMS in text mode.
lteiot7_t::ein
digital_out_t ein
Definition: lteiot7.h:169
LTEIOT7_OK
@ LTEIOT7_OK
Definition: lteiot7.h:217
lteiot7_t::rts
digital_out_t rts
Definition: lteiot7.h:170
lteiot7_send_sms_pdu
err_t lteiot7_send_sms_pdu(lteiot7_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
LTE IoT 7 send SMS in PDU mode.
lteiot7_set_ein_pin
void lteiot7_set_ein_pin(lteiot7_t *ctx, uint8_t state)
LTE IoT 7 set EIN pin function.
lteiot7_send_cmd_check
void lteiot7_send_cmd_check(lteiot7_t *ctx, char *at_cmd_buf)
Check the sent command.
lteiot7_send_cmd_with_parameter
void lteiot7_send_cmd_with_parameter(lteiot7_t *ctx, char *at_cmd_buf, char *param_buf)
Send command function with parameter.
lteiot7_cfg_t::ri
pin_name_t ri
Definition: lteiot7.h:199
lteiot7_cfg_t::baud_rate
uint32_t baud_rate
Definition: lteiot7.h:203
lteiot7_generic_read
err_t lteiot7_generic_read(lteiot7_t *ctx, char *data_out, uint16_t len)
LTE IoT 7 data reading function.
lteiot7_t::uart
uart_t uart
Definition: lteiot7.h:177
lteiot7_cfg_t::cts
pin_name_t cts
Definition: lteiot7.h:200
lteiot7_set_power_state
void lteiot7_set_power_state(lteiot7_t *ctx, uint8_t state)
LTE IoT 7 set power state function.
lteiot7_cfg_t::rx_pin
pin_name_t rx_pin
Definition: lteiot7.h:192
lteiot7_init
err_t lteiot7_init(lteiot7_t *ctx, lteiot7_cfg_t *cfg)
LTE IoT 7 initialization function.
lteiot7_t::pwr
digital_out_t pwr
Definition: lteiot7.h:168
lteiot7_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: lteiot7.h:206