ltecat13aux  2.1.0.0
ltecat13aux.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 LTECAT13AUX_H
29 #define LTECAT13AUX_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_i2c_master.h"
52 #include "drv_uart.h"
53 
74 #define LTECAT13AUX_MAX9860_REG_INTR_STATS 0x00
75 #define LTECAT13AUX_MAX9860_REG_MIC_NG_AGC 0x01
76 #define LTECAT13AUX_MAX9860_REG_INTR_EN 0x02
77 #define LTECAT13AUX_MAX9860_REG_SYS_CLK 0x03
78 #define LTECAT13AUX_MAX9860_REG_STEREO_CLK_MSB 0x04
79 #define LTECAT13AUX_MAX9860_REG_STEREO_CLK_LSB 0x05
80 #define LTECAT13AUX_MAX9860_REG_AUDIO_INTERFACE_1 0x06
81 #define LTECAT13AUX_MAX9860_REG_AUDIO_INTERFACE_2 0x07
82 #define LTECAT13AUX_MAX9860_REG_VOICE_FILTER 0x08
83 #define LTECAT13AUX_MAX9860_REG_DAC_ATTENUATION 0x09
84 #define LTECAT13AUX_MAX9860_REG_ADC_OUTPUT_LEVELS 0x0A
85 #define LTECAT13AUX_MAX9860_REG_DAC_GAIN 0x0B
86 #define LTECAT13AUX_MAX9860_REG_MIC_GAIN 0x0C
87 #define LTECAT13AUX_MAX9860_REG_MIC_AGC 0x0E
88 #define LTECAT13AUX_MAX9860_REG_NOISE_GATE 0x0F
89 #define LTECAT13AUX_MAX9860_REG_SYS_SHUTDOWN 0x10
90 
95 #define LTECAT13AUX_CMD_AT "AT"
96 #define LTECAT13AUX_CMD_ATI "ATI"
97 #define LTECAT13AUX_CMD_CFUN "AT+CFUN"
98 #define LTECAT13AUX_CMD_CREG "AT+CREG"
99 #define LTECAT13AUX_CMD_CGDCONT "AT+CGDCONT"
100 #define LTECAT13AUX_CMD_CSQ "AT+CSQ"
101 #define LTECAT13AUX_CMD_COPS "AT+COPS"
102 #define LTECAT13AUX_CMD_CMGS "AT+CMGS"
103 #define LTECAT13AUX_CMD_CMGF "AT+CMGF"
104 #define LTECAT13AUX_CMD_CGPADDR "AT+CGPADDR"
105 #define LTECAT13AUX_CMD_QIACT "AT+QIACT"
106 #define LTECAT13AUX_CMD_CHUP "AT+CHUP"
107 #define LTECAT13AUX_CMD_QIRD "AT+QIRD"
108 #define LTECAT13AUX_CMD_QIGETERROR "AT+QIGETERROR"
109 #define LTECAT13AUX_CMD_QICSGP "AT+QICSGP"
110 #define LTECAT13AUX_CMD_QIOPEN "AT+QIOPEN"
111 #define LTECAT13AUX_CMD_QISEND "AT+QISEND"
112 #define LTECAT13AUX_CMD_QICLOSE "AT+QICLOSE"
113 #define LTECAT13AUX_CMD_CLCC "AT+CLCC"
114 #define LTECAT13AUX_CMD_QGPSGNMEA "AT+QGPSGNMEA"
115 #define LTECAT13AUX_CMD_CSCS "AT+CSCS"
116 #define LTECAT13AUX_CMD_QGPS "AT+QGPS"
117 #define LTECAT13AUX_CMD_ATD "ATD"
118 
123 #define LTECAT13AUX_PSCLK_24MHZ 0x20
124 #define LTECAT13AUX_LRCLK_8MHZ_MSB 0x10
125 #define LTECAT13AUX_LRCLK_8MHZ_LSB 0x62
126 #define LTECAT13AUX_DBCI_FALLING_EDGE 0x20
127 #define LTECAT13AUX_HIZ_ENABLE 0x08
128 #define LTECAT13AUX_TDM_ENABLE 0x04
129 #define LTECAT13AUX_ABCI_FALLING_EDGE 0x20
130 #define LTECAT13AUX_ADLY_ENABLE 0x10
131 #define LTECAT13AUX_STEREO_ENABLE 0x08
132 #define LTECAT13AUX_AVFLT_DISABLE 0x00
133 #define LTECAT13AUX_DVFLT_DISABLE 0x00
134 #define LTECAT13AUX_DVA_GAIN_0 0x06
135 #define LTECAT13AUX_ADC_GAIN_3 0x00
136 #define LTECAT13AUX_DAC_GAIN_0 0x00
137 #define LTECAT13AUX_DVST_GAIN_0 0x01
138 #define LTECAT13AUX_MIC_GAIN_0 0x20
139 #define LTECAT13AUX_PGAM_GAIN_0 0x14
140 #define LTECAT13AUX_AGCSRC_ENABLE 0x80
141 #define LTECAT13AUX_ANTH_DISABLE 0x00
142 #define LTECAT13AUX_AGCTH_MINUS_3 0x00
143 #define LTECAT13AUX_POWER_ON 0x80
144 #define LTECAT13AUX_DAC_ENABLE 0x08
145 #define LTECAT13AUX_ADCL_ADCR_ENABLE 0x03
146 
151 #define LTECAT13AUX_PIN_STATE_HIGH 0x01
152 #define LTECAT13AUX_PIN_STATE_LOW 0x00
153 
158 #define LTECAT13AUX_RSP_START "$"
159 #define LTECAT13AUX_RSP_DELIMITER ","
160 #define LTECAT13AUX_RSP_GPGGA "$GPGGA"
161 
166 #define LTECAT13AUX_GPGGA_ELEMENT_SIZE 15
167 #define LTECAT13AUX_GPGGA_TIME 1
168 #define LTECAT13AUX_GPGGA_LATITUDE 2
169 #define LTECAT13AUX_GPGGA_LATITUDE_SIDE 3
170 #define LTECAT13AUX_GPGGA_LONGITUDE 4
171 #define LTECAT13AUX_GPGGA_LONGITUDE_SIDE 5
172 #define LTECAT13AUX_GPGGA_QUALITY_INDICATOR 6
173 #define LTECAT13AUX_GPGGA_NUMBER_OF_SATELLITES 7
174 #define LTECAT13AUX_GPGGA_H_DILUTION_OF_POS 8
175 #define LTECAT13AUX_GPGGA_ALTITUDE 9
176 #define LTECAT13AUX_GPGGA_ALTITUDE_UNIT 10
177 #define LTECAT13AUX_GPGGA_GEOIDAL_SEPARATION 11
178 #define LTECAT13AUX_GPGGA_GEOIDAL_SEPARATION_UNIT 12
179 #define LTECAT13AUX_GPGGA_TIME_SINCE_LAST_DGPS 13
180 #define LTECAT13AUX_GPGGA_DGPS_REFERENCE_STATION_ID 14
181 
186 #define LTECAT13AUX_RSP_OK "OK"
187 #define LTECAT13AUX_RSP_ERROR "ERROR"
188 #define LTECAT13AUX_RSP_RDY "RDY"
189 #define LTECAT13AUX_RSP_SEND_OK "SEND OK"
190 
195 #define LTECAT13AUX_PIN_STATE_HIGH 0x01
196 #define LTECAT13AUX_PIN_STATE_LOW 0x00
197 
203 #define LTECAT13AUX_TX_DRV_BUFFER_SIZE 200
204 #define LTECAT13AUX_RX_DRV_BUFFER_SIZE 300
205 
211 #define LTECAT13AUX_ADDRESS 0x10
212  // ltecat13aux_cmd
214 
229 #define LTECAT13AUX_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  // ltecat13aux_map // ltecat13aux
241 
246 typedef struct
247 {
248  // Output pins
249  digital_out_t pwr;
250  digital_out_t rts;
252  // Input pins
253  digital_in_t ri;
254  digital_in_t cts;
256  // Modules]
257  i2c_master_t i2c;
258  uart_t uart;
260  // I2C slave address
261  uint8_t slave_address;
263  // Buffers
264  uint8_t uart_rx_buffer[ LTECAT13AUX_RX_DRV_BUFFER_SIZE ];
265  uint8_t uart_tx_buffer[ LTECAT13AUX_TX_DRV_BUFFER_SIZE ];
267 } ltecat13aux_t;
268 
273 typedef 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;
281  // Additional gpio pins
282  pin_name_t pwr;
283  pin_name_t rts;
284  pin_name_t ri;
285  pin_name_t cts;
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;
297 
302 typedef enum
303 {
309 
311 
328 
343 
356 err_t ltecat13aux_generic_write ( ltecat13aux_t *ctx, uint8_t *data_in, uint16_t len );
357 
370 err_t ltecat13aux_generic_read ( ltecat13aux_t *ctx, uint8_t *data_out, uint16_t len );
371 
372 
383 
393 void ltecat13aux_set_pwr_pin ( ltecat13aux_t *ctx, uint8_t pin_state );
394 
404 void ltecat13aux_set_rts_pin ( ltecat13aux_t *ctx, uint8_t pin_state );
405 
415 
425 
438 err_t ltecat13aux_write_register ( ltecat13aux_t *ctx, uint8_t reg, uint8_t data_in );
439 
452 err_t ltecat13aux_read_register ( ltecat13aux_t *ctx, uint8_t reg, uint8_t *data_out );
453 
466 
476 void ltecat13aux_send_cmd ( ltecat13aux_t *ctx, uint8_t *cmd );
477 
488 void ltecat13aux_send_cmd_with_params ( ltecat13aux_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
489 
499 void ltecat13aux_send_cmd_check ( ltecat13aux_t *ctx, uint8_t *at_cmd_buf );
500 
510 void ltecat13aux_send_cmd_param_check ( ltecat13aux_t *ctx, uint8_t *at_cmd_buf );
511 
521 void ltecat13aux_set_sim_apn ( ltecat13aux_t *ctx, uint8_t *sim_apn );
522 
533 void ltecat13aux_send_sms_text ( ltecat13aux_t *ctx, uint8_t *phone_number, uint8_t *sms_text );
534 
548 err_t ltecat13aux_send_sms_pdu ( ltecat13aux_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text );
549 
561 err_t ltecat13aux_parse_gpgga ( char *rsp_buf, uint8_t gpgga_element, char *element_data );
562 
563 #ifdef __cplusplus
564 }
565 #endif
566 #endif // LTECAT13AUX_H
567  // ltecat13aux
569 
570 // ------------------------------------------------------------------------ END
ltecat13aux_send_sms_pdu
err_t ltecat13aux_send_sms_pdu(ltecat13aux_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
LTE Cat.1 3 AUX send SMS in PDU mode.
ltecat13aux_t::i2c
i2c_master_t i2c
Definition: ltecat13aux.h:257
ltecat13aux_cfg_t::sda
pin_name_t sda
Definition: ltecat13aux.h:279
ltecat13aux_cfg_t::ri
pin_name_t ri
Definition: ltecat13aux.h:284
ltecat13aux_send_sms_text
void ltecat13aux_send_sms_text(ltecat13aux_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
LTE Cat.1 3 AUX send SMS in text mode.
ltecat13aux_t::cts
digital_in_t cts
Definition: ltecat13aux.h:254
ltecat13aux_t
LTE Cat.1 3 AUX Click context object.
Definition: ltecat13aux.h:247
ltecat13aux_t::uart
uart_t uart
Definition: ltecat13aux.h:258
ltecat13aux_cfg_t::stop_bit
uart_stop_bits_t stop_bit
Definition: ltecat13aux.h:292
ltecat13aux_t::ri
digital_in_t ri
Definition: ltecat13aux.h:253
ltecat13aux_read_register
err_t ltecat13aux_read_register(ltecat13aux_t *ctx, uint8_t reg, uint8_t *data_out)
LTE Cat.1 3 AUX MAX9860 reading function.
ltecat13aux_send_cmd
void ltecat13aux_send_cmd(ltecat13aux_t *ctx, uint8_t *cmd)
LTE Cat.1 3 AUX send command function.
ltecat13aux_cfg_t::uart_blocking
bool uart_blocking
Definition: ltecat13aux.h:289
ltecat13aux_set_rts_pin
void ltecat13aux_set_rts_pin(ltecat13aux_t *ctx, uint8_t pin_state)
LTE Cat.1 3 AUX set RST pin function.
ltecat13aux_write_register
err_t ltecat13aux_write_register(ltecat13aux_t *ctx, uint8_t reg, uint8_t data_in)
LTE Cat.1 3 AUX MAX9860 writing function.
ltecat13aux_return_value_t
ltecat13aux_return_value_t
LTE Cat.1 3 AUX Click return value data.
Definition: ltecat13aux.h:303
ltecat13aux_send_cmd_param_check
void ltecat13aux_send_cmd_param_check(ltecat13aux_t *ctx, uint8_t *at_cmd_buf)
LTE Cat.1 3 AUX check the command parameters.
ltecat13aux_cfg_t::cts
pin_name_t cts
Definition: ltecat13aux.h:285
LTECAT13AUX_ERROR_UNKNOWN
@ LTECAT13AUX_ERROR_UNKNOWN
Definition: ltecat13aux.h:308
LTECAT13AUX_ERROR_TIMEOUT
@ LTECAT13AUX_ERROR_TIMEOUT
Definition: ltecat13aux.h:306
ltecat13aux_generic_write
err_t ltecat13aux_generic_write(ltecat13aux_t *ctx, uint8_t *data_in, uint16_t len)
LTE Cat.1 3 AUX data writing function.
ltecat13aux_cfg_t::scl
pin_name_t scl
Definition: ltecat13aux.h:278
ltecat13aux_cfg_t::rts
pin_name_t rts
Definition: ltecat13aux.h:283
ltecat13aux_t::pwr
digital_out_t pwr
Definition: ltecat13aux.h:249
ltecat13aux_send_cmd_with_params
void ltecat13aux_send_cmd_with_params(ltecat13aux_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
LTE Cat.1 3 AUX send command function with parameter.
ltecat13aux_start_up
void ltecat13aux_start_up(ltecat13aux_t *ctx)
LTE Cat.1 3 AUX start up function.
ltecat13aux_cfg_t
LTE Cat.1 3 AUX Click configuration object.
Definition: ltecat13aux.h:274
ltecat13aux_cfg_t::data_bit
uart_data_bits_t data_bit
Definition: ltecat13aux.h:290
ltecat13aux_max9860_cfg
err_t ltecat13aux_max9860_cfg(ltecat13aux_t *ctx)
LTE Cat.1 3 AUX MAX9860 configuration function.
ltecat13aux_parse_gpgga
err_t ltecat13aux_parse_gpgga(char *rsp_buf, uint8_t gpgga_element, char *element_data)
LTE Cat.1 parse GPGGA function.
LTECAT13AUX_RX_DRV_BUFFER_SIZE
#define LTECAT13AUX_RX_DRV_BUFFER_SIZE
Definition: ltecat13aux.h:204
LTECAT13AUX_TX_DRV_BUFFER_SIZE
#define LTECAT13AUX_TX_DRV_BUFFER_SIZE
LTE Cat.1 3 AUX driver buffer size.
Definition: ltecat13aux.h:203
ltecat13aux_cfg_t::tx_pin
pin_name_t tx_pin
Definition: ltecat13aux.h:277
ltecat13aux_cfg_t::rx_pin
pin_name_t rx_pin
Definition: ltecat13aux.h:276
ltecat13aux_get_ri_pin
uint8_t ltecat13aux_get_ri_pin(ltecat13aux_t *ctx)
LTE Cat.1 3 AUX get RI pin function.
LTECAT13AUX_ERROR
@ LTECAT13AUX_ERROR
Definition: ltecat13aux.h:305
ltecat13aux_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: ltecat13aux.h:293
ltecat13aux_t::slave_address
uint8_t slave_address
Definition: ltecat13aux.h:261
ltecat13aux_t::rts
digital_out_t rts
Definition: ltecat13aux.h:250
ltecat13aux_generic_read
err_t ltecat13aux_generic_read(ltecat13aux_t *ctx, uint8_t *data_out, uint16_t len)
LTE Cat.1 3 AUX data reading function.
ltecat13aux_set_pwr_pin
void ltecat13aux_set_pwr_pin(ltecat13aux_t *ctx, uint8_t pin_state)
LTE Cat.1 3 AUX set PWR pin function.
ltecat13aux_cfg_t::parity_bit
uart_parity_t parity_bit
Definition: ltecat13aux.h:291
ltecat13aux_get_cts_pin
uint8_t ltecat13aux_get_cts_pin(ltecat13aux_t *ctx)
LTE Cat.1 3 AUX get cts pin function.
LTECAT13AUX_ERROR_CMD
@ LTECAT13AUX_ERROR_CMD
Definition: ltecat13aux.h:307
ltecat13aux_init
err_t ltecat13aux_init(ltecat13aux_t *ctx, ltecat13aux_cfg_t *cfg)
LTE Cat.1 3 AUX initialization function.
ltecat13aux_cfg_t::pwr
pin_name_t pwr
Definition: ltecat13aux.h:282
ltecat13aux_cfg_setup
void ltecat13aux_cfg_setup(ltecat13aux_cfg_t *cfg)
LTE Cat.1 3 AUX configuration object setup function.
ltecat13aux_set_sim_apn
void ltecat13aux_set_sim_apn(ltecat13aux_t *ctx, uint8_t *sim_apn)
LTE Cat.1 3 AUX set sim card APN.
LTECAT13AUX_OK
@ LTECAT13AUX_OK
Definition: ltecat13aux.h:304
ltecat13aux_cfg_t::baud_rate
uint32_t baud_rate
Definition: ltecat13aux.h:288
ltecat13aux_send_cmd_check
void ltecat13aux_send_cmd_check(ltecat13aux_t *ctx, uint8_t *at_cmd_buf)
LTE Cat.1 3 AUX check the sent command.
ltecat13aux_cfg_t::i2c_address
uint8_t i2c_address
Definition: ltecat13aux.h:294