lteiot10 2.2.1
Loading...
Searching...
No Matches
lteiot10.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 LTEIOT10_H
29#define LTEIOT10_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 LTEIOT10_CMD_AT "AT"
74#define LTEIOT10_CMD_GET_MODEL_ID "AT+CGMM"
75#define LTEIOT10_CMD_GET_SW_VERSION "AT+CGMR"
76#define LTEIOT10_CMD_GET_SERIAL_NUM "AT+CGSN"
77#define LTEIOT10_CMD_FACTORY_RESET "AT&F"
78#define LTEIOT10_CMD_HARD_RESET "AT^RESET"
79#define LTEIOT10_CMD_DISABLE_ECHO "ATE0"
80#define LTEIOT10_CMD_ENABLE_ECHO "ATE1"
81#define LTEIOT10_CMD_SET_PHONE_FUNCTIONALITY "AT+CFUN"
82#define LTEIOT10_CMD_NETWORK_REGISTRATION "AT+CEREG"
83#define LTEIOT10_CMD_SIGNAL_QUALITY_REPORT "AT+CSQ"
84#define LTEIOT10_CMD_OPERATOR_SELECTION "AT+COPS"
85#define LTEIOT10_CMD_SEND_SMS "AT+CMGS"
86#define LTEIOT10_CMD_SELECT_SMS_FORMAT "AT+CMGF"
87#define LTEIOT10_CMD_DEFINE_PDP_CONTEXT "AT+CGDCONT"
88#define LTEIOT10_CMD_ACTIVATE_PDP_CONTEXT "AT+CGACT"
89#define LTEIOT10_CMD_SHOW_PDP_ADDRESS "AT+CGPADDR"
90#define LTEIOT10_CMD_OPEN_TCP_UDP_CONNECTION "AT+SQNSD"
91#define LTEIOT10_CMD_SEND_DATA_VIA_CONNECTION "AT+SQNSSEND"
92#define LTEIOT10_CMD_RECEIVE_DATA_VIA_CONNECTION "AT+SQNSRECV"
93#define LTEIOT10_CMD_CLOSE_TCP_UDP_CONNECTION "AT+SQNSH"
94
99#define LTEIOT10_RSP_OK "OK"
100#define LTEIOT10_RSP_ERROR "ERROR"
101
106#define LTEIOT10_URC_READY "+SYSSTART"
107#define LTEIOT10_URC_RECEIVED_DATA "+SQNSRING:"
108#define LTEIOT10_URC_CONNECTION_OPEN "+SQNSD:"
109#define LTEIOT10_URC_CONNECTION_CLOSED "+SQNSH:"
110
116#define LTEIOT10_TX_DRV_BUFFER_SIZE 256
117#define LTEIOT10_RX_DRV_BUFFER_SIZE 256
118 // lteiot10_cmd
120
125
130
135#define LTEIOT10_MAP_MIKROBUS( cfg, mikrobus ) \
136 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
137 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
138 cfg.wkp = MIKROBUS( mikrobus, MIKROBUS_AN ); \
139 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
140 cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
141 cfg.ring = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
142 cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
143 // lteiot10_map // lteiot10
146
151typedef struct
152{
153 // Output pins
154 digital_out_t wkp;
155 digital_out_t rst;
156 digital_out_t rts;
157
158 // Input pins
159 digital_in_t ring;
160 digital_in_t cts;
161
162 // Modules
163 uart_t uart;
164
165 // Buffers
169
170} lteiot10_t;
171
176typedef struct
177{
178 // Communication gpio pins
179 pin_name_t rx_pin;
180 pin_name_t tx_pin;
181
182 // Additional gpio pins
183 pin_name_t wkp;
184 pin_name_t rst;
185 pin_name_t rts;
186 pin_name_t ring;
187 pin_name_t cts;
188
189 // Static variable
190 uint32_t baud_rate;
192 uart_data_bits_t data_bit;
193 uart_parity_t parity_bit;
194 uart_stop_bits_t stop_bit;
195
197
210
216
227
242
255err_t lteiot10_generic_write ( lteiot10_t *ctx, uint8_t *data_in, uint16_t len );
256
269err_t lteiot10_generic_read ( lteiot10_t *ctx, uint8_t *data_out, uint16_t len );
270
280void lteiot10_set_wkp_pin ( lteiot10_t *ctx, uint8_t state );
281
291void lteiot10_set_rst_pin ( lteiot10_t *ctx, uint8_t state );
292
302void lteiot10_set_rts_pin ( lteiot10_t *ctx, uint8_t state );
303
313
323
333
343void lteiot10_cmd_run ( lteiot10_t *ctx, uint8_t *cmd );
344
355void lteiot10_cmd_set ( lteiot10_t *ctx, uint8_t *cmd, uint8_t *value );
356
366void lteiot10_cmd_get ( lteiot10_t *ctx, uint8_t *cmd );
367
377void lteiot10_cmd_help ( lteiot10_t *ctx, uint8_t *cmd );
378
388void lteiot10_set_sim_apn ( lteiot10_t *ctx, uint8_t *sim_apn );
389
400void lteiot10_send_sms_text ( lteiot10_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
401
415err_t lteiot10_send_sms_pdu ( lteiot10_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
416
417#ifdef __cplusplus
418}
419#endif
420#endif // LTEIOT10_H
421 // lteiot10
423
424// ------------------------------------------------------------------------ END
#define LTEIOT10_RX_DRV_BUFFER_SIZE
Definition lteiot10.h:117
#define LTEIOT10_TX_DRV_BUFFER_SIZE
LTE IoT 10 driver buffer size.
Definition lteiot10.h:116
void lteiot10_set_wkp_pin(lteiot10_t *ctx, uint8_t state)
LTE IoT 10 set WKP pin function.
err_t lteiot10_send_sms_pdu(lteiot10_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
LTE IoT 10 send SMS in PDU mode.
void lteiot10_set_sim_apn(lteiot10_t *ctx, uint8_t *sim_apn)
Set sim card APN.
uint8_t lteiot10_get_cts_pin(lteiot10_t *ctx)
LTE IoT 10 get CTS pin function.
void lteiot10_set_rst_pin(lteiot10_t *ctx, uint8_t state)
LTE IoT 10 set RST pin function.
void lteiot10_cmd_run(lteiot10_t *ctx, uint8_t *cmd)
LTE IoT 10 cmd run function.
void lteiot10_set_rts_pin(lteiot10_t *ctx, uint8_t state)
LTE IoT 10 set RTS pin function.
void lteiot10_cmd_set(lteiot10_t *ctx, uint8_t *cmd, uint8_t *value)
LTE IoT 10 cmd set function.
err_t lteiot10_generic_read(lteiot10_t *ctx, uint8_t *data_out, uint16_t len)
LTE IoT 10 data reading function.
void lteiot10_send_sms_text(lteiot10_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
LTE IoT 10 send SMS in text mode.
void lteiot10_cmd_get(lteiot10_t *ctx, uint8_t *cmd)
LTE IoT 10 cmd get function.
void lteiot10_cfg_setup(lteiot10_cfg_t *cfg)
LTE IoT 10 configuration object setup function.
uint8_t lteiot10_get_ring_pin(lteiot10_t *ctx)
LTE IoT 10 get RING pin function.
err_t lteiot10_init(lteiot10_t *ctx, lteiot10_cfg_t *cfg)
LTE IoT 10 initialization function.
err_t lteiot10_generic_write(lteiot10_t *ctx, uint8_t *data_in, uint16_t len)
LTE IoT 10 data writing function.
void lteiot10_reset_device(lteiot10_t *ctx)
LTE IoT 10 reset device function.
void lteiot10_cmd_help(lteiot10_t *ctx, uint8_t *cmd)
LTE IoT 10 cmd help function.
lteiot10_return_value_t
LTE IoT 10 Click return value data.
Definition lteiot10.h:203
@ LTEIOT10_ERROR_TIMEOUT
Definition lteiot10.h:206
@ LTEIOT10_OK
Definition lteiot10.h:204
@ LTEIOT10_ERROR_CMD
Definition lteiot10.h:207
@ LTEIOT10_ERROR
Definition lteiot10.h:205
LTE IoT 10 Click configuration object.
Definition lteiot10.h:177
pin_name_t rts
Definition lteiot10.h:185
uint32_t baud_rate
Definition lteiot10.h:190
pin_name_t wkp
Definition lteiot10.h:183
pin_name_t cts
Definition lteiot10.h:187
pin_name_t ring
Definition lteiot10.h:186
bool uart_blocking
Definition lteiot10.h:191
uart_data_bits_t data_bit
Definition lteiot10.h:192
pin_name_t tx_pin
Definition lteiot10.h:180
pin_name_t rx_pin
Definition lteiot10.h:179
uart_stop_bits_t stop_bit
Definition lteiot10.h:194
uart_parity_t parity_bit
Definition lteiot10.h:193
pin_name_t rst
Definition lteiot10.h:184
LTE IoT 10 Click context object.
Definition lteiot10.h:152
uint8_t cmd_buffer[LTEIOT10_TX_DRV_BUFFER_SIZE]
Definition lteiot10.h:168
digital_out_t rts
Definition lteiot10.h:156
uart_t uart
Definition lteiot10.h:163
uint8_t uart_tx_buffer[LTEIOT10_TX_DRV_BUFFER_SIZE]
Definition lteiot10.h:167
digital_in_t cts
Definition lteiot10.h:160
digital_out_t wkp
Definition lteiot10.h:154
digital_out_t rst
Definition lteiot10.h:155
digital_in_t ring
Definition lteiot10.h:159
uint8_t uart_rx_buffer[LTEIOT10_RX_DRV_BUFFER_SIZE]
Definition lteiot10.h:166