lteiot5 2.2.1
Loading...
Searching...
No Matches
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
27
28#ifndef LTEIOT5_H
29#define LTEIOT5_H
30
31#ifdef __cplusplus
32extern "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
58
63
68
73#define LTEIOT5_CMD_AT "AT"
74#define LTEIOT5_CMD_GET_MODEL_ID "AT+CGMM"
75#define LTEIOT5_CMD_GET_SW_VERSION "AT+CGMR"
76#define LTEIOT5_CMD_GET_SERIAL_NUM "AT+CGSN"
77#define LTEIOT5_CMD_FACTORY_RESET "AT&F"
78#define LTEIOT5_CMD_SET_MODULE_FUNCTIONALITY "AT+CFUN"
79#define LTEIOT5_CMD_EPS_NETWORK_REGISTRATION "AT+CEREG"
80#define LTEIOT5_CMD_SIGNAL_QUALITY_REPORT "AT+CSQ"
81#define LTEIOT5_CMD_OPERATOR_SELECTION "AT+COPS"
82#define LTEIOT5_CMD_SEND_SMS "AT+CMGS"
83#define LTEIOT5_CMD_SELECT_SMS_FORMAT "AT+CMGF"
84#define LTEIOT5_CMD_DEFINE_PDP_CONTEXT "AT+CGDCONT"
85#define LTEIOT5_CMD_SHOW_PDP_ADDRESS "AT+CGPADDR"
86#define LTEIOT5_CMD_ACTIVATE_PDP_CONTEXT "AT+CGACT"
87#define LTEIOT5_CMD_PSD_CONFIG "AT+UPSD"
88#define LTEIOT5_CMD_PSD_ACTION "AT+UPSDA"
89#define LTEIOT5_CMD_CREATE_SOCKET "AT+USOCR"
90#define LTEIOT5_CMD_CLOSE_SOCKET "AT+USOCL"
91#define LTEIOT5_CMD_CONNECT_SOCKET "AT+USOCO"
92#define LTEIOT5_CMD_WRITE_SOCKET_DATA "AT+USOWR"
93#define LTEIOT5_CMD_READ_SOCKET_DATA "AT+USORD"
94#define LTEIOT5_CMD_GNSS_POWER_MANAGEMENT "AT+UGPS"
95#define LTEIOT5_CMD_GET_GNSS_FIX_DATA "AT+UGGGA"
96
101#define LTEIOT5_RSP_OK "OK"
102#define LTEIOT5_RSP_ERROR "ERROR"
103
108#define LTEIOT5_URC_CREATE_SOCKET "+USOCR: "
109#define LTEIOT5_URC_RECEIVED_DATA "+UUSORD: "
110
115#define LTEIOT5_POWER_STATE_OFF 0
116#define LTEIOT5_POWER_STATE_ON 1
117#define LTEIOT5_POWER_STATE_RESET 2
118
123#define LTEIOT5_RSP_START "$"
124#define LTEIOT5_RSP_DELIMITER ","
125#define LTEIOT5_RSP_END "\r\n"
126#define LTEIOT5_RSP_GGA "GGA"
127
132#define LTEIOT5_GGA_ELEMENT_SIZE 15
133#define LTEIOT5_GGA_TIME 1
134#define LTEIOT5_GGA_LATITUDE 2
135#define LTEIOT5_GGA_LATITUDE_SIDE 3
136#define LTEIOT5_GGA_LONGITUDE 4
137#define LTEIOT5_GGA_LONGITUDE_SIDE 5
138#define LTEIOT5_GGA_QUALITY_INDICATOR 6
139#define LTEIOT5_GGA_NUMBER_OF_SATELLITES 7
140#define LTEIOT5_GGA_H_DILUTION_OF_POS 8
141#define LTEIOT5_GGA_ALTITUDE 9
142#define LTEIOT5_GGA_ALTITUDE_UNIT 10
143#define LTEIOT5_GGA_GEOIDAL_SEPARATION 11
144#define LTEIOT5_GGA_GEOIDAL_SEPARATION_UNIT 12
145#define LTEIOT5_GGA_TIME_SINCE_LAST_DGPS 13
146#define LTEIOT5_GGA_DGPS_REFERENCE_STATION_ID 14
147
153#define LTEIOT5_TX_DRV_BUFFER_SIZE 300
154#define LTEIOT5_RX_DRV_BUFFER_SIZE 300
155 // lteiot5_cmd
157
162
167
172#define LTEIOT5_MAP_MIKROBUS( cfg, mikrobus ) \
173 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
174 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
175 cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
176 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
177 cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
178 cfg.ring = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
179 cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
180 // lteiot5_map // lteiot5
183
188typedef struct
189{
190 // Output pins
191 digital_out_t pwr;
192 digital_out_t rst;
193 digital_out_t rts;
194
195 // Input pins
196 digital_in_t ring;
197 digital_in_t cts;
198
199 // Modules
200 uart_t uart;
201
202 // Buffers
206
207} lteiot5_t;
208
213typedef struct
214{
215 // Communication gpio pins
216 pin_name_t rx_pin;
217 pin_name_t tx_pin;
218
219 // Additional gpio pins
220 pin_name_t pwr;
221 pin_name_t rst;
222 pin_name_t rts;
223 pin_name_t ring;
224 pin_name_t cts;
225
226 // Static variable
227 uint32_t baud_rate;
229 uart_data_bits_t data_bit;
230 uart_parity_t parity_bit;
231 uart_stop_bits_t stop_bit;
232
234
247
253
264
279
292err_t lteiot5_generic_write ( lteiot5_t *ctx, uint8_t *data_in, uint16_t len );
293
306err_t lteiot5_generic_read ( lteiot5_t *ctx, uint8_t *data_out, uint16_t len );
307
317void lteiot5_set_pwr_pin ( lteiot5_t *ctx, uint8_t state );
318
328void lteiot5_set_rst_pin ( lteiot5_t *ctx, uint8_t state );
329
339void lteiot5_set_rts_pin ( lteiot5_t *ctx, uint8_t state );
340
350
360
372void lteiot5_set_power_state ( lteiot5_t *ctx, uint8_t state );
373
383void lteiot5_cmd_run ( lteiot5_t *ctx, uint8_t *cmd );
384
395void lteiot5_cmd_set ( lteiot5_t *ctx, uint8_t *cmd, uint8_t *value );
396
406void lteiot5_cmd_get ( lteiot5_t *ctx, uint8_t *cmd );
407
417void lteiot5_cmd_help ( lteiot5_t *ctx, uint8_t *cmd );
418
428void lteiot5_set_sim_apn ( lteiot5_t *ctx, uint8_t *sim_apn );
429
440void lteiot5_send_sms_text ( lteiot5_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
441
455err_t lteiot5_send_sms_pdu ( lteiot5_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
456
468err_t lteiot5_parse_gga ( uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data );
469
470#ifdef __cplusplus
471}
472#endif
473#endif // LTEIOT5_H
474 // lteiot5
476
477// ------------------------------------------------------------------------ END
#define LTEIOT5_TX_DRV_BUFFER_SIZE
LTE IoT 5 driver buffer size.
Definition lteiot5.h:153
#define LTEIOT5_RX_DRV_BUFFER_SIZE
Definition lteiot5.h:154
void lteiot5_cmd_get(lteiot5_t *ctx, uint8_t *cmd)
LTE IoT 5 cmd get function.
err_t lteiot5_init(lteiot5_t *ctx, lteiot5_cfg_t *cfg)
LTE IoT 5 initialization function.
err_t lteiot5_send_sms_pdu(lteiot5_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
LTE IoT 5 send SMS in PDU mode.
uint8_t lteiot5_get_ring_pin(lteiot5_t *ctx)
LTE IoT 5 get RING pin function.
err_t lteiot5_parse_gga(uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
LTE IoT 5 parse GGA function.
void lteiot5_set_rts_pin(lteiot5_t *ctx, uint8_t state)
LTE IoT 5 set RTS pin function.
void lteiot5_set_rst_pin(lteiot5_t *ctx, uint8_t state)
LTE IoT 5 set RST pin function.
void lteiot5_cmd_run(lteiot5_t *ctx, uint8_t *cmd)
LTE IoT 5 cmd run function.
void lteiot5_cfg_setup(lteiot5_cfg_t *cfg)
LTE IoT 5 configuration object setup function.
void lteiot5_cmd_set(lteiot5_t *ctx, uint8_t *cmd, uint8_t *value)
LTE IoT 5 cmd set function.
err_t lteiot5_generic_write(lteiot5_t *ctx, uint8_t *data_in, uint16_t len)
LTE IoT 5 data writing function.
void lteiot5_set_sim_apn(lteiot5_t *ctx, uint8_t *sim_apn)
Set sim card APN.
void lteiot5_cmd_help(lteiot5_t *ctx, uint8_t *cmd)
LTE IoT 5 cmd help function.
void lteiot5_set_power_state(lteiot5_t *ctx, uint8_t state)
LTE IoT 5 set power state function.
uint8_t lteiot5_get_cts_pin(lteiot5_t *ctx)
LTE IoT 5 get CTS pin function.
void lteiot5_send_sms_text(lteiot5_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
LTE IoT 5 send SMS in text mode.
void lteiot5_set_pwr_pin(lteiot5_t *ctx, uint8_t state)
LTE IoT 5 set PWR pin function.
err_t lteiot5_generic_read(lteiot5_t *ctx, uint8_t *data_out, uint16_t len)
LTE IoT 5 data reading function.
lteiot5_return_value_t
LTE IoT 5 Click return value data.
Definition lteiot5.h:240
@ LTEIOT5_ERROR_TIMEOUT
Definition lteiot5.h:243
@ LTEIOT5_OK
Definition lteiot5.h:241
@ LTEIOT5_ERROR
Definition lteiot5.h:242
@ LTEIOT5_ERROR_CMD
Definition lteiot5.h:244
LTE IoT 5 Click configuration object.
Definition lteiot5.h:214
pin_name_t rts
Definition lteiot5.h:222
uint32_t baud_rate
Definition lteiot5.h:227
pin_name_t cts
Definition lteiot5.h:224
pin_name_t ring
Definition lteiot5.h:223
bool uart_blocking
Definition lteiot5.h:228
uart_data_bits_t data_bit
Definition lteiot5.h:229
pin_name_t tx_pin
Definition lteiot5.h:217
pin_name_t pwr
Definition lteiot5.h:220
pin_name_t rx_pin
Definition lteiot5.h:216
uart_stop_bits_t stop_bit
Definition lteiot5.h:231
uart_parity_t parity_bit
Definition lteiot5.h:230
pin_name_t rst
Definition lteiot5.h:221
LTE IoT 5 Click context object.
Definition lteiot5.h:189
uint8_t uart_rx_buffer[LTEIOT5_RX_DRV_BUFFER_SIZE]
Definition lteiot5.h:203
digital_out_t pwr
Definition lteiot5.h:191
digital_out_t rts
Definition lteiot5.h:193
uart_t uart
Definition lteiot5.h:200
digital_in_t cts
Definition lteiot5.h:197
uint8_t cmd_buffer[LTEIOT5_TX_DRV_BUFFER_SIZE]
Definition lteiot5.h:205
digital_out_t rst
Definition lteiot5.h:192
uint8_t uart_tx_buffer[LTEIOT5_TX_DRV_BUFFER_SIZE]
Definition lteiot5.h:204
digital_in_t ring
Definition lteiot5.h:196