ltecat13ex 2.2.0
Loading...
Searching...
No Matches
ltecat13ex.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 LTECAT13EX_H
29#define LTECAT13EX_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_i2c_master.h"
52#include "drv_uart.h"
53
59
64
69
74#define LTECAT13EX_MAX9860_REG_INTR_STATS 0x00
75#define LTECAT13EX_MAX9860_REG_MIC_NG_AGC 0x01
76#define LTECAT13EX_MAX9860_REG_INTR_EN 0x02
77#define LTECAT13EX_MAX9860_REG_SYS_CLK 0x03
78#define LTECAT13EX_MAX9860_REG_STEREO_CLK_MSB 0x04
79#define LTECAT13EX_MAX9860_REG_STEREO_CLK_LSB 0x05
80#define LTECAT13EX_MAX9860_REG_AUDIO_INTERFACE_1 0x06
81#define LTECAT13EX_MAX9860_REG_AUDIO_INTERFACE_2 0x07
82#define LTECAT13EX_MAX9860_REG_VOICE_FILTER 0x08
83#define LTECAT13EX_MAX9860_REG_DAC_ATTENUATION 0x09
84#define LTECAT13EX_MAX9860_REG_ADC_OUTPUT_LEVELS 0x0A
85#define LTECAT13EX_MAX9860_REG_DAC_GAIN 0x0B
86#define LTECAT13EX_MAX9860_REG_MIC_GAIN 0x0C
87#define LTECAT13EX_MAX9860_REG_MIC_AGC 0x0E
88#define LTECAT13EX_MAX9860_REG_NOISE_GATE 0x0F
89#define LTECAT13EX_MAX9860_REG_SYS_SHUTDOWN 0x10
90
95#define LTECAT13EX_CMD_AT "AT"
96#define LTECAT13EX_CMD_ATI "ATI"
97#define LTECAT13EX_CMD_CFUN "AT+CFUN"
98#define LTECAT13EX_CMD_CREG "AT+CREG"
99#define LTECAT13EX_CMD_CGDCONT "AT+CGDCONT"
100#define LTECAT13EX_CMD_CSQ "AT+CSQ"
101#define LTECAT13EX_CMD_COPS "AT+COPS"
102#define LTECAT13EX_CMD_CMGS "AT+CMGS"
103#define LTECAT13EX_CMD_CMGF "AT+CMGF"
104#define LTECAT13EX_CMD_CGPADDR "AT+CGPADDR"
105#define LTECAT13EX_CMD_QIACT "AT+QIACT"
106#define LTECAT13EX_CMD_CHUP "AT+CHUP"
107#define LTECAT13EX_CMD_QIRD "AT+QIRD"
108#define LTECAT13EX_CMD_QIGETERROR "AT+QIGETERROR"
109#define LTECAT13EX_CMD_QICSGP "AT+QICSGP"
110#define LTECAT13EX_CMD_QIOPEN "AT+QIOPEN"
111#define LTECAT13EX_CMD_QISEND "AT+QISEND"
112#define LTECAT13EX_CMD_QICLOSE "AT+QICLOSE"
113#define LTECAT13EX_CMD_CLCC "AT+CLCC"
114#define LTECAT13EX_CMD_QGPSGNMEA "AT+QGPSGNMEA"
115#define LTECAT13EX_CMD_CSCS "AT+CSCS"
116#define LTECAT13EX_CMD_QGPS "AT+QGPS"
117#define LTECAT13EX_CMD_ATD "ATD"
118
123#define LTECAT13EX_PSCLK_24MHZ 0x20
124#define LTECAT13EX_LRCLK_8MHZ_MSB 0x10
125#define LTECAT13EX_LRCLK_8MHZ_LSB 0x62
126#define LTECAT13EX_DBCI_FALLING_EDGE 0x20
127#define LTECAT13EX_HIZ_ENABLE 0x08
128#define LTECAT13EX_TDM_ENABLE 0x04
129#define LTECAT13EX_ABCI_FALLING_EDGE 0x20
130#define LTECAT13EX_ADLY_ENABLE 0x10
131#define LTECAT13EX_STEREO_ENABLE 0x08
132#define LTECAT13EX_AVFLT_DISABLE 0x00
133#define LTECAT13EX_DVFLT_DISABLE 0x00
134#define LTECAT13EX_DVA_GAIN_0 0x06
135#define LTECAT13EX_ADC_GAIN_3 0x00
136#define LTECAT13EX_DAC_GAIN_0 0x00
137#define LTECAT13EX_DVST_GAIN_0 0x01
138#define LTECAT13EX_MIC_GAIN_0 0x20
139#define LTECAT13EX_PGAM_GAIN_0 0x14
140#define LTECAT13EX_AGCSRC_ENABLE 0x80
141#define LTECAT13EX_ANTH_DISABLE 0x00
142#define LTECAT13EX_AGCTH_MINUS_3 0x00
143#define LTECAT13EX_POWER_ON 0x80
144#define LTECAT13EX_DAC_ENABLE 0x08
145#define LTECAT13EX_ADCL_ADCR_ENABLE 0x03
146
151#define LTECAT13EX_PIN_STATE_HIGH 0x01
152#define LTECAT13EX_PIN_STATE_LOW 0x00
153
158#define LTECAT13EX_RSP_START "$"
159#define LTECAT13EX_RSP_DELIMITER ","
160#define LTECAT13EX_RSP_GPGGA "$GPGGA"
161
166#define LTECAT13EX_GPGGA_ELEMENT_SIZE 15
167#define LTECAT13EX_GPGGA_TIME 1
168#define LTECAT13EX_GPGGA_LATITUDE 2
169#define LTECAT13EX_GPGGA_LATITUDE_SIDE 3
170#define LTECAT13EX_GPGGA_LONGITUDE 4
171#define LTECAT13EX_GPGGA_LONGITUDE_SIDE 5
172#define LTECAT13EX_GPGGA_QUALITY_INDICATOR 6
173#define LTECAT13EX_GPGGA_NUMBER_OF_SATELLITES 7
174#define LTECAT13EX_GPGGA_H_DILUTION_OF_POS 8
175#define LTECAT13EX_GPGGA_ALTITUDE 9
176#define LTECAT13EX_GPGGA_ALTITUDE_UNIT 10
177#define LTECAT13EX_GPGGA_GEOIDAL_SEPARATION 11
178#define LTECAT13EX_GPGGA_GEOIDAL_SEPARATION_UNIT 12
179#define LTECAT13EX_GPGGA_TIME_SINCE_LAST_DGPS 13
180#define LTECAT13EX_GPGGA_DGPS_REFERENCE_STATION_ID 14
181
186#define LTECAT13EX_RSP_OK "OK"
187#define LTECAT13EX_RSP_ERROR "ERROR"
188#define LTECAT13EX_RSP_RDY "RDY"
189#define LTECAT13EX_RSP_SEND_OK "SEND OK"
190
195#define LTECAT13EX_PIN_STATE_HIGH 0x01
196#define LTECAT13EX_PIN_STATE_LOW 0x00
197
203#define LTECAT13EX_TX_DRV_BUFFER_SIZE 200
204#define LTECAT13EX_RX_DRV_BUFFER_SIZE 300
205
211#define LTECAT13EX_ADDRESS 0x10
212 // ltecat13ex_cmd
214
219
224
229#define LTECAT13EX_MAP_MIKROBUS( cfg, mikrobus ) \
230 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
231 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
232 cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
233 cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
234 cfg.pwr = MIKROBUS( mikrobus, MIKROBUS_AN ); \
235 cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
236 cfg.ri = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
237 cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
238 // ltecat13ex_map // ltecat13ex
241
246typedef struct
247{
248 // Output pins
249 digital_out_t pwr;
250 digital_out_t rts;
251
252 // Input pins
253 digital_in_t ri;
254 digital_in_t cts;
255
256 // Modules]
257 i2c_master_t i2c;
258 uart_t uart;
259
260 // I2C slave address
262
263 // Buffers
266
268
273typedef struct
274{
275 // Communication gpio pins
276 pin_name_t rx_pin;
277 pin_name_t tx_pin;
278 pin_name_t scl;
279 pin_name_t sda;
280
281 // Additional gpio pins
282 pin_name_t pwr;
283 pin_name_t rts;
284 pin_name_t ri;
285 pin_name_t cts;
286
287 // Static variable
288 uint32_t baud_rate;
290 uart_data_bits_t data_bit;
291 uart_parity_t parity_bit;
292 uart_stop_bits_t stop_bit;
293 uint32_t i2c_speed;
294 uint8_t i2c_address;
295
297
311
317
328
343
356err_t ltecat13ex_generic_write ( ltecat13ex_t *ctx, uint8_t *data_in, uint16_t len );
357
370err_t ltecat13ex_generic_read ( ltecat13ex_t *ctx, uint8_t *data_out, uint16_t len );
371
372
383
393void ltecat13ex_set_pwr_pin ( ltecat13ex_t *ctx, uint8_t pin_state );
394
404void ltecat13ex_set_rts_pin ( ltecat13ex_t *ctx, uint8_t pin_state );
405
415
425
438err_t ltecat13ex_write_register ( ltecat13ex_t *ctx, uint8_t reg, uint8_t data_in );
439
452err_t ltecat13ex_read_register ( ltecat13ex_t *ctx, uint8_t reg, uint8_t *data_out );
453
466
476void ltecat13ex_send_cmd ( ltecat13ex_t *ctx, uint8_t *cmd );
477
488void ltecat13ex_send_cmd_with_params ( ltecat13ex_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
489
499void ltecat13ex_send_cmd_check ( ltecat13ex_t *ctx, uint8_t *at_cmd_buf );
500
510void ltecat13ex_send_cmd_param_check ( ltecat13ex_t *ctx, uint8_t *at_cmd_buf );
511
521void ltecat13ex_set_sim_apn ( ltecat13ex_t *ctx, uint8_t *sim_apn );
522
533void ltecat13ex_send_sms_text ( ltecat13ex_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
534
548err_t ltecat13ex_send_sms_pdu ( ltecat13ex_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
549
561err_t ltecat13ex_parse_gpgga ( char *rsp_buf, uint8_t gpgga_element, char *element_data );
562
563#ifdef __cplusplus
564}
565#endif
566#endif // LTECAT13EX_H
567 // ltecat13ex
569
570// ------------------------------------------------------------------------ END
#define LTECAT13EX_RX_DRV_BUFFER_SIZE
Definition ltecat13ex.h:204
#define LTECAT13EX_TX_DRV_BUFFER_SIZE
LTE Cat.1 3 EX driver buffer size.
Definition ltecat13ex.h:203
void ltecat13ex_send_cmd_param_check(ltecat13ex_t *ctx, uint8_t *at_cmd_buf)
LTE Cat.1 3 EX check the command parameters.
err_t ltecat13ex_write_register(ltecat13ex_t *ctx, uint8_t reg, uint8_t data_in)
LTE Cat.1 3 EX MAX9860 writing function.
err_t ltecat13ex_send_sms_pdu(ltecat13ex_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
LTE Cat.1 3 EX send SMS in PDU mode.
err_t ltecat13ex_parse_gpgga(char *rsp_buf, uint8_t gpgga_element, char *element_data)
LTE Cat.1 parse GPGGA function.
uint8_t ltecat13ex_get_ri_pin(ltecat13ex_t *ctx)
LTE Cat.1 3 EX get RI pin function.
void ltecat13ex_send_sms_text(ltecat13ex_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
LTE Cat.1 3 EX send SMS in text mode.
void ltecat13ex_send_cmd_check(ltecat13ex_t *ctx, uint8_t *at_cmd_buf)
LTE Cat.1 3 EX check the sent command.
void ltecat13ex_send_cmd(ltecat13ex_t *ctx, uint8_t *cmd)
LTE Cat.1 3 EX send command function.
uint8_t ltecat13ex_get_cts_pin(ltecat13ex_t *ctx)
LTE Cat.1 3 EX get cts pin function.
void ltecat13ex_set_pwr_pin(ltecat13ex_t *ctx, uint8_t pin_state)
LTE Cat.1 3 EX set PWR pin function.
err_t ltecat13ex_max9860_cfg(ltecat13ex_t *ctx)
LTE Cat.1 3 EX MAX9860 configuration function.
void ltecat13ex_send_cmd_with_params(ltecat13ex_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
LTE Cat.1 3 EX send command function with parameter.
void ltecat13ex_set_rts_pin(ltecat13ex_t *ctx, uint8_t pin_state)
LTE Cat.1 3 EX set RST pin function.
err_t ltecat13ex_generic_read(ltecat13ex_t *ctx, uint8_t *data_out, uint16_t len)
LTE Cat.1 3 EX data reading function.
void ltecat13ex_set_sim_apn(ltecat13ex_t *ctx, uint8_t *sim_apn)
LTE Cat.1 3 EX set sim card APN.
err_t ltecat13ex_read_register(ltecat13ex_t *ctx, uint8_t reg, uint8_t *data_out)
LTE Cat.1 3 EX MAX9860 reading function.
err_t ltecat13ex_generic_write(ltecat13ex_t *ctx, uint8_t *data_in, uint16_t len)
LTE Cat.1 3 EX data writing function.
void ltecat13ex_cfg_setup(ltecat13ex_cfg_t *cfg)
LTE Cat.1 3 EX configuration object setup function.
void ltecat13ex_start_up(ltecat13ex_t *ctx)
LTE Cat.1 3 EX start up function.
err_t ltecat13ex_init(ltecat13ex_t *ctx, ltecat13ex_cfg_t *cfg)
LTE Cat.1 3 EX initialization function.
ltecat13ex_return_value_t
LTE Cat.1 3 EX Click return value data.
Definition ltecat13ex.h:303
@ LTECAT13EX_ERROR_UNKNOWN
Definition ltecat13ex.h:308
@ LTECAT13EX_ERROR_TIMEOUT
Definition ltecat13ex.h:306
@ LTECAT13EX_ERROR
Definition ltecat13ex.h:305
@ LTECAT13EX_OK
Definition ltecat13ex.h:304
@ LTECAT13EX_ERROR_CMD
Definition ltecat13ex.h:307
LTE Cat.1 3 EX Click configuration object.
Definition ltecat13ex.h:274
pin_name_t rts
Definition ltecat13ex.h:283
uint32_t baud_rate
Definition ltecat13ex.h:288
pin_name_t cts
Definition ltecat13ex.h:285
uint32_t i2c_speed
Definition ltecat13ex.h:293
bool uart_blocking
Definition ltecat13ex.h:289
pin_name_t ri
Definition ltecat13ex.h:284
uart_data_bits_t data_bit
Definition ltecat13ex.h:290
pin_name_t tx_pin
Definition ltecat13ex.h:277
pin_name_t pwr
Definition ltecat13ex.h:282
pin_name_t rx_pin
Definition ltecat13ex.h:276
uart_stop_bits_t stop_bit
Definition ltecat13ex.h:292
pin_name_t scl
Definition ltecat13ex.h:278
uart_parity_t parity_bit
Definition ltecat13ex.h:291
pin_name_t sda
Definition ltecat13ex.h:279
uint8_t i2c_address
Definition ltecat13ex.h:294
LTE Cat.1 3 EX Click context object.
Definition ltecat13ex.h:247
digital_out_t pwr
Definition ltecat13ex.h:249
digital_out_t rts
Definition ltecat13ex.h:250
digital_in_t ri
Definition ltecat13ex.h:253
uart_t uart
Definition ltecat13ex.h:258
uint8_t uart_rx_buffer[LTECAT13EX_RX_DRV_BUFFER_SIZE]
Definition ltecat13ex.h:264
i2c_master_t i2c
Definition ltecat13ex.h:257
digital_in_t cts
Definition ltecat13ex.h:254
uint8_t slave_address
Definition ltecat13ex.h:261
uint8_t uart_tx_buffer[LTECAT13EX_TX_DRV_BUFFER_SIZE]
Definition ltecat13ex.h:265