lteiot3  2.1.0.0
lteiot3.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 uint8_tge, 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 LTEIOT3_H
29 #define LTEIOT3_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 LTEIOT3_CMD_AT "AT"
60 #define LTEIOT3_CMD_ATI "ATI"
61 #define LTEIOT3_CMD_CFUN "AT+CFUN"
62 #define LTEIOT3_CMD_CREG "AT+CREG"
63 #define LTEIOT3_CMD_CGDCONT "AT+CGDCONT"
64 #define LTEIOT3_CMD_CESQ "AT+CESQ"
65 #define LTEIOT3_CMD_COPS "AT+COPS"
66 #define LTEIOT3_CMD_CMGS "AT+CMGS"
67 #define LTEIOT3_CMD_CMGF "AT+CMGF"
68 #define LTEIOT3_CMD_CGPADDR "AT+CGPADDR"
69 #define LTEIOT3_CMD_SICA "AT^SICA"
70 #define LTEIOT3_CMD_SISS "AT^SISS"
71 #define LTEIOT3_CMD_SISO "AT^SISO"
72 #define LTEIOT3_CMD_SISW "AT^SISW"
73 #define LTEIOT3_CMD_SISR "AT^SISR"
74 #define LTEIOT3_CMD_SISC "AT^SISC"
75 #define LTEIOT3_CMD_SGPSC "AT^SGPSC"
76 
81 #define LTEIOT3_RSP_OK "OK"
82 #define LTEIOT3_RSP_ERROR "ERROR"
83 #define LTEIOT3_RSP_SYSSTART "^SYSSTART"
84 
89 #define LTEIOT3_POWER_STATE_SWITCH 0
90 #define LTEIOT3_POWER_STATE_ON 1
91 #define LTEIOT3_POWER_STATE_REBOOT 2
92 
97 #define LTEIOT3_RSP_START "$"
98 #define LTEIOT3_RSP_DELIMITER ","
99 #define LTEIOT3_RSP_END "\r\n"
100 #define LTEIOT3_RSP_GGA "GGA"
101 
106 #define LTEIOT3_GGA_ELEMENT_SIZE 15
107 #define LTEIOT3_GGA_TIME 1
108 #define LTEIOT3_GGA_LATITUDE 2
109 #define LTEIOT3_GGA_LATITUDE_SIDE 3
110 #define LTEIOT3_GGA_LONGITUDE 4
111 #define LTEIOT3_GGA_LONGITUDE_SIDE 5
112 #define LTEIOT3_GGA_QUALITY_INDICATOR 6
113 #define LTEIOT3_GGA_NUMBER_OF_SATELLITES 7
114 #define LTEIOT3_GGA_H_DILUTION_OF_POS 8
115 #define LTEIOT3_GGA_ALTITUDE 9
116 #define LTEIOT3_GGA_ALTITUDE_UNIT 10
117 #define LTEIOT3_GGA_GEOIDAL_SEPARATION 11
118 #define LTEIOT3_GGA_GEOIDAL_SEPARATION_UNIT 12
119 #define LTEIOT3_GGA_TIME_SINCE_LAST_DGPS 13
120 #define LTEIOT3_GGA_DGPS_REFERENCE_STATION_ID 14
121 
127 #define LTEIOT3_RX_DRV_BUFFER_SIZE 256
128 #define LTEIOT3_TX_DRV_BUFFER_SIZE 256
129  // lteiot3_cmd
131 
146 #define LTEIOT3_MAP_MIKROBUS( cfg, mikrobus ) \
147  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
148  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
149  cfg.smi = MIKROBUS( mikrobus, MIKROBUS_AN ); \
150  cfg.on = MIKROBUS( mikrobus, MIKROBUS_RST ); \
151  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
152  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
153  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_INT );
154  // lteiot3_map // lteiot3
157 
162 typedef struct
163 {
164  // Output pins
165  digital_out_t on;
166  digital_out_t cs;
167  digital_out_t rts;
169  // Input pins
170  digital_in_t smi;
171  digital_in_t cts;
173  // Modules
174  uart_t uart;
176  // Buffers
177  uint8_t uart_rx_buffer[ LTEIOT3_RX_DRV_BUFFER_SIZE ];
178  uint8_t uart_tx_buffer[ LTEIOT3_TX_DRV_BUFFER_SIZE ];
180 } lteiot3_t;
181 
186 typedef struct
187 {
188  // Communication gpio pins
189  pin_name_t rx_pin;
190  pin_name_t tx_pin;
192  // Additional gpio pins
193  pin_name_t on;
194  pin_name_t cs;
195  pin_name_t cts;
196  pin_name_t smi;
197  pin_name_t rts;
199  // Static variable
200  uint32_t baud_rate;
202  uart_data_bits_t data_bit;
203  uart_parity_t parity_bit;
204  uart_stop_bits_t stop_bit;
206 } lteiot3_cfg_t;
207 
212 typedef enum
213 {
219 
221 
238 
252 err_t lteiot3_init ( lteiot3_t *ctx, lteiot3_cfg_t *cfg );
253 
266 err_t lteiot3_generic_write ( lteiot3_t *ctx, uint8_t *data_in, uint16_t len );
267 
280 err_t lteiot3_generic_read ( lteiot3_t *ctx, uint8_t *data_out, uint16_t len );
281 
291 void lteiot3_set_on_pin ( lteiot3_t *ctx, uint8_t state );
292 
302 void lteiot3_set_rts_pin ( lteiot3_t *ctx, uint8_t state );
303 
313 void lteiot3_set_cs_pin ( lteiot3_t *ctx, uint8_t state );
314 
324 
334 
344 void lteiot3_send_cmd ( lteiot3_t *ctx, uint8_t *cmd );
345 
356 void lteiot3_send_cmd_with_parameter ( lteiot3_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
357 
367 void lteiot3_send_cmd_check ( lteiot3_t *ctx, uint8_t *at_cmd_buf );
368 
378 void lteiot3_send_cmd_parameter_check ( lteiot3_t *ctx, uint8_t *at_cmd_buf );
379 
389 void lteiot3_set_sim_apn ( lteiot3_t *ctx, uint8_t *sim_apn );
390 
401 void lteiot3_send_sms_text ( lteiot3_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
402 
416 err_t lteiot3_send_sms_pdu ( lteiot3_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
417 
429 err_t lteiot3_parse_gga ( uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data );
430 
431 #ifdef __cplusplus
432 }
433 #endif
434 #endif // LTEIOT3_H
435  // lteiot3
437 
438 // ------------------------------------------------------------------------ END
lteiot3_parse_gga
err_t lteiot3_parse_gga(uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
LTE IoT 3 parse GGA function.
lteiot3_get_cts_pin
uint8_t lteiot3_get_cts_pin(lteiot3_t *ctx)
LTE IoT 3 get cts pin function.
lteiot3_set_on_pin
void lteiot3_set_on_pin(lteiot3_t *ctx, uint8_t state)
LTE IoT 3 set on pin function.
lteiot3_send_cmd_with_parameter
void lteiot3_send_cmd_with_parameter(lteiot3_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
Send command function with parameter.
lteiot3_cfg_t::smi
pin_name_t smi
Definition: lteiot3.h:196
lteiot3_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: lteiot3.h:202
LTEIOT3_TX_DRV_BUFFER_SIZE
#define LTEIOT3_TX_DRV_BUFFER_SIZE
Definition: lteiot3.h:128
lteiot3_t::smi
digital_in_t smi
Definition: lteiot3.h:170
lteiot3_t::cts
digital_in_t cts
Definition: lteiot3.h:171
lteiot3_send_cmd
void lteiot3_send_cmd(lteiot3_t *ctx, uint8_t *cmd)
Send command function.
lteiot3_generic_read
err_t lteiot3_generic_read(lteiot3_t *ctx, uint8_t *data_out, uint16_t len)
LTE IoT 3 data reading function.
lteiot3_send_cmd_check
void lteiot3_send_cmd_check(lteiot3_t *ctx, uint8_t *at_cmd_buf)
Check the sent command.
lteiot3_send_sms_text
void lteiot3_send_sms_text(lteiot3_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
LTE IoT 3 send SMS in text mode.
lteiot3_t
LTE IoT 3 Click context object.
Definition: lteiot3.h:163
lteiot3_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: lteiot3.h:204
lteiot3_cfg_t::cs
pin_name_t cs
Definition: lteiot3.h:194
lteiot3_t::on
digital_out_t on
Definition: lteiot3.h:165
lteiot3_return_value_t
lteiot3_return_value_t
LTE IoT 3 Click return value data.
Definition: lteiot3.h:213
lteiot3_set_cs_pin
void lteiot3_set_cs_pin(lteiot3_t *ctx, uint8_t state)
LTE IoT 3 set cs pin function.
lteiot3_set_rts_pin
void lteiot3_set_rts_pin(lteiot3_t *ctx, uint8_t state)
LTE IoT 3 set rts pin function.
lteiot3_cfg_t::tx_pin
pin_name_t tx_pin
Definition: lteiot3.h:190
lteiot3_cfg_t
LTE IoT 3 Click configuration object.
Definition: lteiot3.h:187
LTEIOT3_ERROR_TIMEOUT
@ LTEIOT3_ERROR_TIMEOUT
Definition: lteiot3.h:216
lteiot3_generic_write
err_t lteiot3_generic_write(lteiot3_t *ctx, uint8_t *data_in, uint16_t len)
LTE IoT 3 data writing function.
lteiot3_t::uart
uart_t uart
Definition: lteiot3.h:174
LTEIOT3_ERROR_CMD
@ LTEIOT3_ERROR_CMD
Definition: lteiot3.h:217
lteiot3_cfg_t::rts
pin_name_t rts
Definition: lteiot3.h:197
LTEIOT3_ERROR_UNKNOWN
@ LTEIOT3_ERROR_UNKNOWN
Definition: lteiot3.h:218
lteiot3_cfg_t::on
pin_name_t on
Definition: lteiot3.h:193
lteiot3_cfg_t::cts
pin_name_t cts
Definition: lteiot3.h:195
lteiot3_get_smi_pin
uint8_t lteiot3_get_smi_pin(lteiot3_t *ctx)
LTE IoT 3 get smi pin function.
lteiot3_t::cs
digital_out_t cs
Definition: lteiot3.h:166
lteiot3_cfg_t::rx_pin
pin_name_t rx_pin
Definition: lteiot3.h:189
lteiot3_set_sim_apn
void lteiot3_set_sim_apn(lteiot3_t *ctx, uint8_t *sim_apn)
Set sim card APN.
lteiot3_cfg_setup
void lteiot3_cfg_setup(lteiot3_cfg_t *cfg)
LTE IoT 3 configuration object setup function.
lteiot3_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: lteiot3.h:203
lteiot3_send_cmd_parameter_check
void lteiot3_send_cmd_parameter_check(lteiot3_t *ctx, uint8_t *at_cmd_buf)
Check the command parameters.
lteiot3_t::rts
digital_out_t rts
Definition: lteiot3.h:167
lteiot3_send_sms_pdu
err_t lteiot3_send_sms_pdu(lteiot3_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
LTE IoT 3 send SMS in PDU mode.
LTEIOT3_OK
@ LTEIOT3_OK
Definition: lteiot3.h:214
LTEIOT3_RX_DRV_BUFFER_SIZE
#define LTEIOT3_RX_DRV_BUFFER_SIZE
LTE IoT 3 driver buffer size.
Definition: lteiot3.h:127
lteiot3_cfg_t::baud_rate
uint32_t baud_rate
Definition: lteiot3.h:200
lteiot3_cfg_t::uart_blocking
bool uart_blocking
Definition: lteiot3.h:201
lteiot3_init
err_t lteiot3_init(lteiot3_t *ctx, lteiot3_cfg_t *cfg)
LTE IoT 3 initialization function.
LTEIOT3_ERROR
@ LTEIOT3_ERROR
Definition: lteiot3.h:215