ltecat13aux  2.1.0.0
Data Structures | Macros | Enumerations | Functions
ltecat13aux.h File Reference

This file contains API for LTE Cat.1 3 AUX Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures

struct  ltecat13aux_t
 LTE Cat.1 3 AUX Click context object. More...
 
struct  ltecat13aux_cfg_t
 LTE Cat.1 3 AUX Click configuration object. More...
 

Macros

#define LTECAT13AUX_MAX9860_REG_INTR_STATS   0x00
 LTE Cat.1 3 AUX MAX9860 registers. More...
 
#define LTECAT13AUX_MAX9860_REG_MIC_NG_AGC   0x01
 
#define LTECAT13AUX_MAX9860_REG_INTR_EN   0x02
 
#define LTECAT13AUX_MAX9860_REG_SYS_CLK   0x03
 
#define LTECAT13AUX_MAX9860_REG_STEREO_CLK_MSB   0x04
 
#define LTECAT13AUX_MAX9860_REG_STEREO_CLK_LSB   0x05
 
#define LTECAT13AUX_MAX9860_REG_AUDIO_INTERFACE_1   0x06
 
#define LTECAT13AUX_MAX9860_REG_AUDIO_INTERFACE_2   0x07
 
#define LTECAT13AUX_MAX9860_REG_VOICE_FILTER   0x08
 
#define LTECAT13AUX_MAX9860_REG_DAC_ATTENUATION   0x09
 
#define LTECAT13AUX_MAX9860_REG_ADC_OUTPUT_LEVELS   0x0A
 
#define LTECAT13AUX_MAX9860_REG_DAC_GAIN   0x0B
 
#define LTECAT13AUX_MAX9860_REG_MIC_GAIN   0x0C
 
#define LTECAT13AUX_MAX9860_REG_MIC_AGC   0x0E
 
#define LTECAT13AUX_MAX9860_REG_NOISE_GATE   0x0F
 
#define LTECAT13AUX_MAX9860_REG_SYS_SHUTDOWN   0x10
 
#define LTECAT13AUX_CMD_AT   "AT"
 LTE Cat.1 3 AUX control commands. More...
 
#define LTECAT13AUX_CMD_ATI   "ATI"
 
#define LTECAT13AUX_CMD_CFUN   "AT+CFUN"
 
#define LTECAT13AUX_CMD_CREG   "AT+CREG"
 
#define LTECAT13AUX_CMD_CGDCONT   "AT+CGDCONT"
 
#define LTECAT13AUX_CMD_CSQ   "AT+CSQ"
 
#define LTECAT13AUX_CMD_COPS   "AT+COPS"
 
#define LTECAT13AUX_CMD_CMGS   "AT+CMGS"
 
#define LTECAT13AUX_CMD_CMGF   "AT+CMGF"
 
#define LTECAT13AUX_CMD_CGPADDR   "AT+CGPADDR"
 
#define LTECAT13AUX_CMD_QIACT   "AT+QIACT"
 
#define LTECAT13AUX_CMD_CHUP   "AT+CHUP"
 
#define LTECAT13AUX_CMD_QIRD   "AT+QIRD"
 
#define LTECAT13AUX_CMD_QIGETERROR   "AT+QIGETERROR"
 
#define LTECAT13AUX_CMD_QICSGP   "AT+QICSGP"
 
#define LTECAT13AUX_CMD_QIOPEN   "AT+QIOPEN"
 
#define LTECAT13AUX_CMD_QISEND   "AT+QISEND"
 
#define LTECAT13AUX_CMD_QICLOSE   "AT+QICLOSE"
 
#define LTECAT13AUX_CMD_CLCC   "AT+CLCC"
 
#define LTECAT13AUX_CMD_QGPSGNMEA   "AT+QGPSGNMEA"
 
#define LTECAT13AUX_CMD_CSCS   "AT+CSCS"
 
#define LTECAT13AUX_CMD_QGPS   "AT+QGPS"
 
#define LTECAT13AUX_CMD_ATD   "ATD"
 
#define LTECAT13AUX_PSCLK_24MHZ   0x20
 LTE Cat.1 3 AUX MAX9860 commands. More...
 
#define LTECAT13AUX_LRCLK_8MHZ_MSB   0x10
 
#define LTECAT13AUX_LRCLK_8MHZ_LSB   0x62
 
#define LTECAT13AUX_DBCI_FALLING_EDGE   0x20
 
#define LTECAT13AUX_HIZ_ENABLE   0x08
 
#define LTECAT13AUX_TDM_ENABLE   0x04
 
#define LTECAT13AUX_ABCI_FALLING_EDGE   0x20
 
#define LTECAT13AUX_ADLY_ENABLE   0x10
 
#define LTECAT13AUX_STEREO_ENABLE   0x08
 
#define LTECAT13AUX_AVFLT_DISABLE   0x00
 
#define LTECAT13AUX_DVFLT_DISABLE   0x00
 
#define LTECAT13AUX_DVA_GAIN_0   0x06
 
#define LTECAT13AUX_ADC_GAIN_3   0x00
 
#define LTECAT13AUX_DAC_GAIN_0   0x00
 
#define LTECAT13AUX_DVST_GAIN_0   0x01
 
#define LTECAT13AUX_MIC_GAIN_0   0x20
 
#define LTECAT13AUX_PGAM_GAIN_0   0x14
 
#define LTECAT13AUX_AGCSRC_ENABLE   0x80
 
#define LTECAT13AUX_ANTH_DISABLE   0x00
 
#define LTECAT13AUX_AGCTH_MINUS_3   0x00
 
#define LTECAT13AUX_POWER_ON   0x80
 
#define LTECAT13AUX_DAC_ENABLE   0x08
 
#define LTECAT13AUX_ADCL_ADCR_ENABLE   0x03
 
#define LTECAT13AUX_PIN_STATE_HIGH   0x01
 LTE Cat.1 3 AUX pin state. More...
 
#define LTECAT13AUX_PIN_STATE_LOW   0x00
 
#define LTECAT13AUX_RSP_START   "$"
 LTE Cat.1 3 AUX response buffer commands. More...
 
#define LTECAT13AUX_RSP_DELIMITER   ","
 
#define LTECAT13AUX_RSP_GPGGA   "$GPGGA"
 
#define LTECAT13AUX_GPGGA_ELEMENT_SIZE   15
 LTE Cat.1 3 AUX GPGGA command elements. More...
 
#define LTECAT13AUX_GPGGA_TIME   1
 
#define LTECAT13AUX_GPGGA_LATITUDE   2
 
#define LTECAT13AUX_GPGGA_LATITUDE_SIDE   3
 
#define LTECAT13AUX_GPGGA_LONGITUDE   4
 
#define LTECAT13AUX_GPGGA_LONGITUDE_SIDE   5
 
#define LTECAT13AUX_GPGGA_QUALITY_INDICATOR   6
 
#define LTECAT13AUX_GPGGA_NUMBER_OF_SATELLITES   7
 
#define LTECAT13AUX_GPGGA_H_DILUTION_OF_POS   8
 
#define LTECAT13AUX_GPGGA_ALTITUDE   9
 
#define LTECAT13AUX_GPGGA_ALTITUDE_UNIT   10
 
#define LTECAT13AUX_GPGGA_GEOIDAL_SEPARATION   11
 
#define LTECAT13AUX_GPGGA_GEOIDAL_SEPARATION_UNIT   12
 
#define LTECAT13AUX_GPGGA_TIME_SINCE_LAST_DGPS   13
 
#define LTECAT13AUX_GPGGA_DGPS_REFERENCE_STATION_ID   14
 
#define LTECAT13AUX_RSP_OK   "OK"
 LTE Cat.1 3 AUX device response for AT commands. More...
 
#define LTECAT13AUX_RSP_ERROR   "ERROR"
 
#define LTECAT13AUX_RSP_RDY   "RDY"
 
#define LTECAT13AUX_RSP_SEND_OK   "SEND OK"
 
#define LTECAT13AUX_PIN_STATE_HIGH   0x01
 LTE Cat.1 3 AUX pin state. More...
 
#define LTECAT13AUX_PIN_STATE_LOW   0x00
 
#define LTECAT13AUX_TX_DRV_BUFFER_SIZE   200
 LTE Cat.1 3 AUX driver buffer size. More...
 
#define LTECAT13AUX_RX_DRV_BUFFER_SIZE   300
 
#define LTECAT13AUX_ADDRESS   0x10
 LTE Cat.1 3 AUX device address setting. More...
 
#define LTECAT13AUX_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  ltecat13aux_return_value_t {
  LTECAT13AUX_OK = 0, LTECAT13AUX_ERROR = -1, LTECAT13AUX_ERROR_TIMEOUT = -2, LTECAT13AUX_ERROR_CMD = -3,
  LTECAT13AUX_ERROR_UNKNOWN = -4
}
 LTE Cat.1 3 AUX Click return value data. More...
 

Functions

void ltecat13aux_cfg_setup (ltecat13aux_cfg_t *cfg)
 LTE Cat.1 3 AUX configuration object setup function. More...
 
err_t ltecat13aux_init (ltecat13aux_t *ctx, ltecat13aux_cfg_t *cfg)
 LTE Cat.1 3 AUX initialization function. More...
 
err_t ltecat13aux_generic_write (ltecat13aux_t *ctx, uint8_t *data_in, uint16_t len)
 LTE Cat.1 3 AUX data writing function. More...
 
err_t ltecat13aux_generic_read (ltecat13aux_t *ctx, uint8_t *data_out, uint16_t len)
 LTE Cat.1 3 AUX data reading function. More...
 
void ltecat13aux_start_up (ltecat13aux_t *ctx)
 LTE Cat.1 3 AUX start up function. More...
 
void ltecat13aux_set_pwr_pin (ltecat13aux_t *ctx, uint8_t pin_state)
 LTE Cat.1 3 AUX set PWR pin function. More...
 
void ltecat13aux_set_rts_pin (ltecat13aux_t *ctx, uint8_t pin_state)
 LTE Cat.1 3 AUX set RST pin function. More...
 
uint8_t ltecat13aux_get_ri_pin (ltecat13aux_t *ctx)
 LTE Cat.1 3 AUX get RI pin function. More...
 
uint8_t ltecat13aux_get_cts_pin (ltecat13aux_t *ctx)
 LTE Cat.1 3 AUX get cts pin function. More...
 
err_t ltecat13aux_write_register (ltecat13aux_t *ctx, uint8_t reg, uint8_t data_in)
 LTE Cat.1 3 AUX MAX9860 writing function. More...
 
err_t ltecat13aux_read_register (ltecat13aux_t *ctx, uint8_t reg, uint8_t *data_out)
 LTE Cat.1 3 AUX MAX9860 reading function. More...
 
err_t ltecat13aux_max9860_cfg (ltecat13aux_t *ctx)
 LTE Cat.1 3 AUX MAX9860 configuration function. More...
 
void ltecat13aux_send_cmd (ltecat13aux_t *ctx, uint8_t *cmd)
 LTE Cat.1 3 AUX send command function. More...
 
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. More...
 
void ltecat13aux_send_cmd_check (ltecat13aux_t *ctx, uint8_t *at_cmd_buf)
 LTE Cat.1 3 AUX check the sent command. More...
 
void ltecat13aux_send_cmd_param_check (ltecat13aux_t *ctx, uint8_t *at_cmd_buf)
 LTE Cat.1 3 AUX check the command parameters. More...
 
void ltecat13aux_set_sim_apn (ltecat13aux_t *ctx, uint8_t *sim_apn)
 LTE Cat.1 3 AUX set sim card APN. More...
 
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. More...
 
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. More...
 
err_t ltecat13aux_parse_gpgga (char *rsp_buf, uint8_t gpgga_element, char *element_data)
 LTE Cat.1 parse GPGGA function. More...
 

Detailed Description

This file contains API for LTE Cat.1 3 AUX Click Driver.

Enumeration Type Documentation

◆ ltecat13aux_return_value_t

LTE Cat.1 3 AUX Click return value data.

Predefined enum values for driver return values.

Enumerator
LTECAT13AUX_OK 
LTECAT13AUX_ERROR 
LTECAT13AUX_ERROR_TIMEOUT 
LTECAT13AUX_ERROR_CMD 
LTECAT13AUX_ERROR_UNKNOWN