lteiot15 2.2.0
Loading...
Searching...
No Matches
lteiot15.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 LTEIOT15_H
29#define LTEIOT15_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 LTEIOT15_CMD_AT "AT"
74#define LTEIOT15_CMD_GET_MODEL_ID "AT+CGMM"
75#define LTEIOT15_CMD_GET_SW_VERSION "AT+CGMR"
76#define LTEIOT15_CMD_GET_SERIAL_NUM "AT+CGSN"
77#define LTEIOT15_CMD_FACTORY_RESET "AT&F"
78#define LTEIOT15_CMD_SET_MODULE_FUNCTIONALITY "AT+CFUN"
79#define LTEIOT15_CMD_EPS_NETWORK_REGISTRATION "AT+CEREG"
80#define LTEIOT15_CMD_SIGNAL_QUALITY_REPORT "AT+CSQ"
81#define LTEIOT15_CMD_OPERATOR_SELECTION "AT+COPS"
82#define LTEIOT15_CMD_SEND_SMS "AT+CMGS"
83#define LTEIOT15_CMD_SELECT_SMS_FORMAT "AT+CMGF"
84#define LTEIOT15_CMD_DEFINE_PDP_CONTEXT "AT+CGDCONT"
85#define LTEIOT15_CMD_SHOW_PDP_ADDRESS "AT+CGPADDR"
86#define LTEIOT15_CMD_ACTIVATE_PDP_CONTEXT "AT+CGACT"
87#define LTEIOT15_CMD_PSD_CONFIG "AT+UPSD"
88#define LTEIOT15_CMD_PSD_ACTION "AT+UPSDA"
89#define LTEIOT15_CMD_CREATE_SOCKET "AT+USOCR"
90#define LTEIOT15_CMD_CLOSE_SOCKET "AT+USOCL"
91#define LTEIOT15_CMD_CONNECT_SOCKET "AT+USOCO"
92#define LTEIOT15_CMD_WRITE_SOCKET_DATA "AT+USOWR"
93#define LTEIOT15_CMD_READ_SOCKET_DATA "AT+USORD"
94#define LTEIOT15_CMD_GPIO_CONFIG "AT+UGPIOC"
95
100#define LTEIOT15_RSP_OK "OK"
101#define LTEIOT15_RSP_ERROR "ERROR"
102
107#define LTEIOT15_URC_CREATE_SOCKET "+USOCR: "
108#define LTEIOT15_URC_RECEIVED_DATA "+UUSORD: "
109
114#define LTEIOT15_POWER_STATE_OFF 0
115#define LTEIOT15_POWER_STATE_ON 1
116#define LTEIOT15_POWER_STATE_RESET 2
117
123#define LTEIOT15_TX_DRV_BUFFER_SIZE 300
124#define LTEIOT15_RX_DRV_BUFFER_SIZE 300
125 // lteiot15_cmd
127
132
137
142#define LTEIOT15_MAP_MIKROBUS( cfg, mikrobus ) \
143 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
144 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
145 cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
146 cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
147 cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
148 cfg.ring = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
149 cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
150 // lteiot15_map // lteiot15
153
158typedef struct
159{
160 // Output pins
161 digital_out_t pwr;
162 digital_out_t rst;
163 digital_out_t rts;
164
165 // Input pins
166 digital_in_t ring;
167 digital_in_t cts;
168
169 // Modules
170 uart_t uart;
171
172 // Buffers
176
177} lteiot15_t;
178
183typedef struct
184{
185 // Communication gpio pins
186 pin_name_t rx_pin;
187 pin_name_t tx_pin;
188
189 // Additional gpio pins
190 pin_name_t pwr;
191 pin_name_t rst;
192 pin_name_t rts;
193 pin_name_t ring;
194 pin_name_t cts;
195
196 // Static variable
197 uint32_t baud_rate;
199 uart_data_bits_t data_bit;
200 uart_parity_t parity_bit;
201 uart_stop_bits_t stop_bit;
202
204
217
223
234
249
262err_t lteiot15_generic_write ( lteiot15_t *ctx, uint8_t *data_in, uint16_t len );
263
276err_t lteiot15_generic_read ( lteiot15_t *ctx, uint8_t *data_out, uint16_t len );
277
278
288void lteiot15_set_pwr_pin ( lteiot15_t *ctx, uint8_t state );
289
299void lteiot15_set_rst_pin ( lteiot15_t *ctx, uint8_t state );
300
310void lteiot15_set_rts_pin ( lteiot15_t *ctx, uint8_t state );
311
321
331
343void lteiot15_set_power_state ( lteiot15_t *ctx, uint8_t state );
344
354void lteiot15_cmd_run ( lteiot15_t *ctx, uint8_t *cmd );
355
366void lteiot15_cmd_set ( lteiot15_t *ctx, uint8_t *cmd, uint8_t *value );
367
377void lteiot15_cmd_get ( lteiot15_t *ctx, uint8_t *cmd );
378
388void lteiot15_cmd_help ( lteiot15_t *ctx, uint8_t *cmd );
389
399void lteiot15_set_sim_apn ( lteiot15_t *ctx, uint8_t *sim_apn );
400
411void lteiot15_send_sms_text ( lteiot15_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
412
426err_t lteiot15_send_sms_pdu ( lteiot15_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
427
428#ifdef __cplusplus
429}
430#endif
431#endif // LTEIOT15_H
432 // lteiot15
434
435// ------------------------------------------------------------------------ END
#define LTEIOT15_TX_DRV_BUFFER_SIZE
LTE IoT 15 driver buffer size.
Definition lteiot15.h:123
#define LTEIOT15_RX_DRV_BUFFER_SIZE
Definition lteiot15.h:124
void lteiot15_cmd_set(lteiot15_t *ctx, uint8_t *cmd, uint8_t *value)
LTE IoT 15 cmd set function.
uint8_t lteiot15_get_cts_pin(lteiot15_t *ctx)
LTE IoT 15 get CTS pin function.
err_t lteiot15_send_sms_pdu(lteiot15_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
LTE IoT 15 send SMS in PDU mode.
err_t lteiot15_generic_read(lteiot15_t *ctx, uint8_t *data_out, uint16_t len)
LTE IoT 15 data reading function.
uint8_t lteiot15_get_ring_pin(lteiot15_t *ctx)
LTE IoT 15 get RING pin function.
err_t lteiot15_generic_write(lteiot15_t *ctx, uint8_t *data_in, uint16_t len)
LTE IoT 15 data writing function.
void lteiot15_set_power_state(lteiot15_t *ctx, uint8_t state)
LTE IoT 15 set power state function.
void lteiot15_cmd_help(lteiot15_t *ctx, uint8_t *cmd)
LTE IoT 15 cmd help function.
void lteiot15_cfg_setup(lteiot15_cfg_t *cfg)
LTE IoT 15 configuration object setup function.
err_t lteiot15_init(lteiot15_t *ctx, lteiot15_cfg_t *cfg)
LTE IoT 15 initialization function.
void lteiot15_send_sms_text(lteiot15_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
LTE IoT 15 send SMS in text mode.
void lteiot15_set_pwr_pin(lteiot15_t *ctx, uint8_t state)
LTE IoT 15 set PWR pin function.
void lteiot15_cmd_get(lteiot15_t *ctx, uint8_t *cmd)
LTE IoT 15 cmd get function.
void lteiot15_cmd_run(lteiot15_t *ctx, uint8_t *cmd)
LTE IoT 15 cmd run function.
void lteiot15_set_rts_pin(lteiot15_t *ctx, uint8_t state)
LTE IoT 15 set RTS pin function.
void lteiot15_set_sim_apn(lteiot15_t *ctx, uint8_t *sim_apn)
Set sim card APN.
void lteiot15_set_rst_pin(lteiot15_t *ctx, uint8_t state)
LTE IoT 15 set RST pin function.
lteiot15_return_value_t
LTE IoT 15 Click return value data.
Definition lteiot15.h:210
@ LTEIOT15_ERROR_TIMEOUT
Definition lteiot15.h:213
@ LTEIOT15_OK
Definition lteiot15.h:211
@ LTEIOT15_ERROR
Definition lteiot15.h:212
@ LTEIOT15_ERROR_CMD
Definition lteiot15.h:214
LTE IoT 15 Click configuration object.
Definition lteiot15.h:184
pin_name_t rts
Definition lteiot15.h:192
uint32_t baud_rate
Definition lteiot15.h:197
pin_name_t cts
Definition lteiot15.h:194
pin_name_t ring
Definition lteiot15.h:193
bool uart_blocking
Definition lteiot15.h:198
uart_data_bits_t data_bit
Definition lteiot15.h:199
pin_name_t tx_pin
Definition lteiot15.h:187
pin_name_t pwr
Definition lteiot15.h:190
pin_name_t rx_pin
Definition lteiot15.h:186
uart_stop_bits_t stop_bit
Definition lteiot15.h:201
uart_parity_t parity_bit
Definition lteiot15.h:200
pin_name_t rst
Definition lteiot15.h:191
LTE IoT 15 Click context object.
Definition lteiot15.h:159
digital_out_t pwr
Definition lteiot15.h:161
uint8_t uart_tx_buffer[LTEIOT15_TX_DRV_BUFFER_SIZE]
Definition lteiot15.h:174
uint8_t uart_rx_buffer[LTEIOT15_RX_DRV_BUFFER_SIZE]
Definition lteiot15.h:173
uint8_t cmd_buffer[LTEIOT15_TX_DRV_BUFFER_SIZE]
Definition lteiot15.h:175
digital_out_t rts
Definition lteiot15.h:163
uart_t uart
Definition lteiot15.h:170
digital_in_t cts
Definition lteiot15.h:167
digital_out_t rst
Definition lteiot15.h:162
digital_in_t ring
Definition lteiot15.h:166