lteiot12  2.1.0.0
lteiot12.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 LTEIOT12_H
29 #define LTEIOT12_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_uart.h"
52 
73 #define LTEIOT12_CMD_AT "AT"
74 #define LTEIOT12_CMD_GET_MODEL_ID "AT+CGMM"
75 #define LTEIOT12_CMD_GET_SW_VERSION "AT+CGMR"
76 #define LTEIOT12_CMD_GET_SERIAL_NUM "AT+CGSN"
77 #define LTEIOT12_CMD_FACTORY_RESET "AT&F"
78 #define LTEIOT12_CMD_SET_UE_FUNCTIONALITY "AT+CFUN"
79 #define LTEIOT12_CMD_NETWORK_REGISTRATION "AT+CREG"
80 #define LTEIOT12_CMD_SIGNAL_QUALITY_REPORT "AT+CSQ"
81 #define LTEIOT12_CMD_OPERATOR_SELECTION "AT+COPS"
82 #define LTEIOT12_CMD_SEND_SMS "AT+CMGS"
83 #define LTEIOT12_CMD_SELECT_SMS_FORMAT "AT+CMGF"
84 #define LTEIOT12_CMD_DEFINE_PDP_CONTEXT "AT+CGDCONT"
85 #define LTEIOT12_CMD_SHOW_PDP_ADDRESS "AT+CGPADDR"
86 #define LTEIOT12_CMD_PSM_SETTING "AT+CPSMS"
87 #define LTEIOT12_CMD_ACTIVATE_PDP_CONTEXT "AT+QIACT"
88 #define LTEIOT12_CMD_OPEN_SOCKET "AT+QIOPEN"
89 #define LTEIOT12_CMD_CLOSE_SOCKET "AT+QICLOSE"
90 #define LTEIOT12_CMD_SEND_DATA "AT+QISEND"
91 #define LTEIOT12_CMD_RECEIVE_DATA "AT+QIRD"
92 #define LTEIOT12_CMD_EXTENDED_CONFIG "AT+QCFG"
93 #define LTEIOT12_CMD_TURN_ON_GNSS "AT+QGPS"
94 #define LTEIOT12_CMD_ACQUIRE_NMEA_SENTENCES "AT+QGPSGNMEA"
95 
100 #define LTEIOT12_RSP_OK "OK"
101 #define LTEIOT12_RSP_ERROR "ERROR"
102 
107 #define LTEIOT12_URC_RECEIVED_DATA "+QIURC:"
108 #define LTEIOT12_URC_OPEN_SOCKET "+QIOPEN:"
109 
114 #define LTEIOT12_RSP_START "$"
115 #define LTEIOT12_RSP_DELIMITER ","
116 #define LTEIOT12_RSP_END "\r\n"
117 #define LTEIOT12_RSP_GGA "GGA"
118 
123 #define LTEIOT12_POWER_STATE_OFF 0
124 #define LTEIOT12_POWER_STATE_ON 1
125 
130 #define LTEIOT12_GGA_ELEMENT_SIZE 15
131 #define LTEIOT12_GGA_TIME 1
132 #define LTEIOT12_GGA_LATITUDE 2
133 #define LTEIOT12_GGA_LATITUDE_SIDE 3
134 #define LTEIOT12_GGA_LONGITUDE 4
135 #define LTEIOT12_GGA_LONGITUDE_SIDE 5
136 #define LTEIOT12_GGA_QUALITY_INDICATOR 6
137 #define LTEIOT12_GGA_NUMBER_OF_SATELLITES 7
138 #define LTEIOT12_GGA_H_DILUTION_OF_POS 8
139 #define LTEIOT12_GGA_ALTITUDE 9
140 #define LTEIOT12_GGA_ALTITUDE_UNIT 10
141 #define LTEIOT12_GGA_GEOIDAL_SEPARATION 11
142 #define LTEIOT12_GGA_GEOIDAL_SEPARATION_UNIT 12
143 #define LTEIOT12_GGA_TIME_SINCE_LAST_DGPS 13
144 #define LTEIOT12_GGA_DGPS_REFERENCE_STATION_ID 14
145 
151 #define LTEIOT12_TX_DRV_BUFFER_SIZE 256
152 #define LTEIOT12_RX_DRV_BUFFER_SIZE 256
153  // lteiot12_cmd
155 
170 #define LTEIOT12_MAP_MIKROBUS( cfg, mikrobus ) \
171  cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
172  cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
173  cfg.sta = MIKROBUS( mikrobus, MIKROBUS_AN ); \
174  cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_RST ); \
175  cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
176  cfg.ring = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
177  cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
178  // lteiot12_map // lteiot12
181 
186 typedef struct
187 {
188  // Output pins
189  digital_out_t pwr;
190  digital_out_t rts;
192  // Input pins
193  digital_in_t sta;
194  digital_in_t ring;
195  digital_in_t cts;
197  // Modules
198  uart_t uart;
200  // Buffers
201  uint8_t uart_rx_buffer[ LTEIOT12_RX_DRV_BUFFER_SIZE ];
202  uint8_t uart_tx_buffer[ LTEIOT12_TX_DRV_BUFFER_SIZE ];
203  uint8_t cmd_buffer[ LTEIOT12_TX_DRV_BUFFER_SIZE ];
205 } lteiot12_t;
206 
211 typedef struct
212 {
213  // Communication gpio pins
214  pin_name_t rx_pin;
215  pin_name_t tx_pin;
217  // Additional gpio pins
218  pin_name_t sta;
219  pin_name_t pwr;
220  pin_name_t rts;
221  pin_name_t ring;
222  pin_name_t cts;
224  // Static variable
225  uint32_t baud_rate;
227  uart_data_bits_t data_bit;
228  uart_parity_t parity_bit;
229  uart_stop_bits_t stop_bit;
232 
237 typedef enum
238 {
244 
246 
263 
278 
291 err_t lteiot12_generic_write ( lteiot12_t *ctx, uint8_t *data_in, uint16_t len );
292 
305 err_t lteiot12_generic_read ( lteiot12_t *ctx, uint8_t *data_out, uint16_t len );
306 
316 void lteiot12_set_pwr_pin ( lteiot12_t *ctx, uint8_t state );
317 
327 void lteiot12_set_rts_pin ( lteiot12_t *ctx, uint8_t state );
328 
338 
348 
358 
369 void lteiot12_set_power_state ( lteiot12_t *ctx, uint8_t state );
370 
380 void lteiot12_cmd_run ( lteiot12_t *ctx, uint8_t *cmd );
381 
392 void lteiot12_cmd_set ( lteiot12_t *ctx, uint8_t *cmd, uint8_t *value );
393 
403 void lteiot12_cmd_get ( lteiot12_t *ctx, uint8_t *cmd );
404 
414 void lteiot12_cmd_help ( lteiot12_t *ctx, uint8_t *cmd );
415 
425 void lteiot12_set_sim_apn ( lteiot12_t *ctx, uint8_t *sim_apn );
426 
437 void lteiot12_send_sms_text ( lteiot12_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
438 
452 err_t lteiot12_send_sms_pdu ( lteiot12_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
453 
465 err_t lteiot12_parse_gga ( uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data );
466 
467 #ifdef __cplusplus
468 }
469 #endif
470 #endif // LTEIOT12_H
471  // lteiot12
473 
474 // ------------------------------------------------------------------------ END
lteiot12_cmd_set
void lteiot12_cmd_set(lteiot12_t *ctx, uint8_t *cmd, uint8_t *value)
LTE IoT 12 cmd set function.
lteiot12_get_sta_pin
uint8_t lteiot12_get_sta_pin(lteiot12_t *ctx)
LTE IoT 12 get STA pin function.
lteiot12_cfg_setup
void lteiot12_cfg_setup(lteiot12_cfg_t *cfg)
LTE IoT 12 configuration object setup function.
lteiot12_cfg_t::sta
pin_name_t sta
Definition: lteiot12.h:218
lteiot12_t::sta
digital_in_t sta
Definition: lteiot12.h:193
lteiot12_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: lteiot12.h:228
lteiot12_generic_write
err_t lteiot12_generic_write(lteiot12_t *ctx, uint8_t *data_in, uint16_t len)
LTE IoT 12 data writing function.
LTEIOT12_ERROR_UNKNOWN
@ LTEIOT12_ERROR_UNKNOWN
Definition: lteiot12.h:243
lteiot12_cfg_t::baud_rate
uint32_t baud_rate
Definition: lteiot12.h:225
lteiot12_t::pwr
digital_out_t pwr
Definition: lteiot12.h:189
lteiot12_cmd_help
void lteiot12_cmd_help(lteiot12_t *ctx, uint8_t *cmd)
LTE IoT 12 cmd help function.
LTEIOT12_ERROR_TIMEOUT
@ LTEIOT12_ERROR_TIMEOUT
Definition: lteiot12.h:241
LTEIOT12_RX_DRV_BUFFER_SIZE
#define LTEIOT12_RX_DRV_BUFFER_SIZE
Definition: lteiot12.h:152
lteiot12_t::ring
digital_in_t ring
Definition: lteiot12.h:194
lteiot12_set_pwr_pin
void lteiot12_set_pwr_pin(lteiot12_t *ctx, uint8_t state)
LTE IoT 12 set PWR pin function.
lteiot12_cfg_t::rx_pin
pin_name_t rx_pin
Definition: lteiot12.h:214
lteiot12_parse_gga
err_t lteiot12_parse_gga(uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
LTE IoT 12 parse GGA function.
LTEIOT12_ERROR_CMD
@ LTEIOT12_ERROR_CMD
Definition: lteiot12.h:242
lteiot12_cfg_t::rts
pin_name_t rts
Definition: lteiot12.h:220
lteiot12_cfg_t::cts
pin_name_t cts
Definition: lteiot12.h:222
lteiot12_t::cts
digital_in_t cts
Definition: lteiot12.h:195
lteiot12_t
LTE IoT 12 Click context object.
Definition: lteiot12.h:187
lteiot12_generic_read
err_t lteiot12_generic_read(lteiot12_t *ctx, uint8_t *data_out, uint16_t len)
LTE IoT 12 data reading function.
lteiot12_cfg_t::ring
pin_name_t ring
Definition: lteiot12.h:221
lteiot12_get_ring_pin
uint8_t lteiot12_get_ring_pin(lteiot12_t *ctx)
LTE IoT 12 get RING pin function.
lteiot12_set_sim_apn
void lteiot12_set_sim_apn(lteiot12_t *ctx, uint8_t *sim_apn)
LTE IoT 12 set SIM card APN function.
lteiot12_cmd_run
void lteiot12_cmd_run(lteiot12_t *ctx, uint8_t *cmd)
LTE IoT 12 cmd run function.
lteiot12_return_value_t
lteiot12_return_value_t
LTE IoT 12 Click return value data.
Definition: lteiot12.h:238
lteiot12_cfg_t::tx_pin
pin_name_t tx_pin
Definition: lteiot12.h:215
LTEIOT12_ERROR
@ LTEIOT12_ERROR
Definition: lteiot12.h:240
lteiot12_cfg_t::uart_blocking
bool uart_blocking
Definition: lteiot12.h:226
lteiot12_send_sms_pdu
err_t lteiot12_send_sms_pdu(lteiot12_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
LTE IoT 12 send SMS in PDU mode function.
lteiot12_cfg_t::pwr
pin_name_t pwr
Definition: lteiot12.h:219
LTEIOT12_TX_DRV_BUFFER_SIZE
#define LTEIOT12_TX_DRV_BUFFER_SIZE
LTE IoT 12 driver buffer size.
Definition: lteiot12.h:151
lteiot12_set_power_state
void lteiot12_set_power_state(lteiot12_t *ctx, uint8_t state)
LTE IoT 12 set power state function.
lteiot12_t::uart
uart_t uart
Definition: lteiot12.h:198
lteiot12_cfg_t
LTE IoT 12 Click configuration object.
Definition: lteiot12.h:212
lteiot12_set_rts_pin
void lteiot12_set_rts_pin(lteiot12_t *ctx, uint8_t state)
LTE IoT 12 set RTS pin function.
lteiot12_t::rts
digital_out_t rts
Definition: lteiot12.h:190
lteiot12_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: lteiot12.h:229
LTEIOT12_OK
@ LTEIOT12_OK
Definition: lteiot12.h:239
lteiot12_send_sms_text
void lteiot12_send_sms_text(lteiot12_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
LTE IoT 12 send SMS in text mode function.
lteiot12_init
err_t lteiot12_init(lteiot12_t *ctx, lteiot12_cfg_t *cfg)
LTE IoT 12 initialization function.
lteiot12_cmd_get
void lteiot12_cmd_get(lteiot12_t *ctx, uint8_t *cmd)
LTE IoT 12 cmd get function.
lteiot12_get_cts_pin
uint8_t lteiot12_get_cts_pin(lteiot12_t *ctx)
LTE IoT 12 get CTS pin function.
lteiot12_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: lteiot12.h:227