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

This file contains API for LTE Cat.4 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  ltecat4_t
 LTE Cat.4 Click context object. More...
 
struct  ltecat4_cfg_t
 LTE Cat.4 Click configuration object. More...
 

Macros

#define LTECAT4_MAX9860_REG_INTR_STATS   0x00
 LTE Cat.4 MAX9860 registers. More...
 
#define LTECAT4_MAX9860_REG_MIC_NG_AGC   0x01
 
#define LTECAT4_MAX9860_REG_INTR_EN   0x02
 
#define LTECAT4_MAX9860_REG_SYS_CLK   0x03
 
#define LTECAT4_MAX9860_REG_STEREO_CLK_MSB   0x04
 
#define LTECAT4_MAX9860_REG_STEREO_CLK_LSB   0x05
 
#define LTECAT4_MAX9860_REG_AUDIO_INTERFACE_1   0x06
 
#define LTECAT4_MAX9860_REG_AUDIO_INTERFACE_2   0x07
 
#define LTECAT4_MAX9860_REG_VOICE_FILTER   0x08
 
#define LTECAT4_MAX9860_REG_DAC_ATTENUATION   0x09
 
#define LTECAT4_MAX9860_REG_ADC_OUTPUT_LEVELS   0x0A
 
#define LTECAT4_MAX9860_REG_DAC_GAIN   0x0B
 
#define LTECAT4_MAX9860_REG_MIC_GAIN   0x0C
 
#define LTECAT4_MAX9860_REG_MIC_AGC   0x0E
 
#define LTECAT4_MAX9860_REG_NOISE_GATE   0x0F
 
#define LTECAT4_MAX9860_REG_SYS_SHUTDOWN   0x10
 
#define LTECAT4_PSCLK_24MHZ   0x20
 LTE Cat.4 MAX9860 commands. More...
 
#define LTECAT4_LRCLK_8MHZ_MSB   0x10
 
#define LTECAT4_LRCLK_8MHZ_LSB   0x62
 
#define LTECAT4_DBCI_FALLING_EDGE   0x20
 
#define LTECAT4_HIZ_ENABLE   0x08
 
#define LTECAT4_TDM_ENABLE   0x04
 
#define LTECAT4_ABCI_FALLING_EDGE   0x20
 
#define LTECAT4_ADLY_ENABLE   0x10
 
#define LTECAT4_STEREO_ENABLE   0x08
 
#define LTECAT4_AVFLT_DISABLE   0x00
 
#define LTECAT4_DVFLT_DISABLE   0x00
 
#define LTECAT4_DVA_GAIN_0   0x06
 
#define LTECAT4_ADC_GAIN_3   0x00
 
#define LTECAT4_DAC_GAIN_0   0x00
 
#define LTECAT4_DVST_GAIN_0   0x01
 
#define LTECAT4_MIC_GAIN_30   0x60
 
#define LTECAT4_PGAM_GAIN_20   0x00
 
#define LTECAT4_AGCSRC_ENABLE   0x80
 
#define LTECAT4_AGCHLD_50   0x01
 
#define LTECAT4_ANTH_DISABLE   0x00
 
#define LTECAT4_AGCTH_MINUS_3   0x00
 
#define LTECAT4_POWER_ON   0x80
 
#define LTECAT4_DAC_ENABLE   0x08
 
#define LTECAT4_ADCL_ADCR_ENABLE   0x03
 
#define LTECAT4_CMD_AT   "AT"
 LTE Cat.4 control commands. More...
 
#define LTECAT4_CMD_GET_MODEL_ID   "AT+CGMM"
 
#define LTECAT4_CMD_GET_SW_VERSION   "AT+CGMR"
 
#define LTECAT4_CMD_GET_SERIAL_NUM   "AT+CGSN"
 
#define LTECAT4_CMD_FACTORY_RESET   "AT&F"
 
#define LTECAT4_CMD_SET_UE_FUNCTIONALITY   "AT+CFUN"
 
#define LTECAT4_CMD_NETWORK_REGISTRATION   "AT+CREG"
 
#define LTECAT4_CMD_SIGNAL_QUALITY_REPORT   "AT+CSQ"
 
#define LTECAT4_CMD_OPERATOR_SELECTION   "AT+COPS"
 
#define LTECAT4_CMD_SEND_SMS   "AT+CMGS"
 
#define LTECAT4_CMD_SELECT_SMS_FORMAT   "AT+CMGF"
 
#define LTECAT4_CMD_DEFINE_PDP_CONTEXT   "AT+CGDCONT"
 
#define LTECAT4_CMD_SHOW_PDP_ADDRESS   "AT+CGPADDR"
 
#define LTECAT4_CMD_ACTIVATE_PDP_CONTEXT   "AT+QIACT"
 
#define LTECAT4_CMD_OPEN_SOCKET   "AT+QIOPEN"
 
#define LTECAT4_CMD_CLOSE_SOCKET   "AT+QICLOSE"
 
#define LTECAT4_CMD_SEND_DATA   "AT+QISEND"
 
#define LTECAT4_CMD_RECEIVE_DATA   "AT+QIRD"
 
#define LTECAT4_CMD_TURN_ON_GNSS   "AT+QGPS"
 
#define LTECAT4_CMD_ACQUIRE_NMEA_SENTENCES   "AT+QGPSGNMEA"
 
#define LTECAT4_CMD_SET_MIC_GAIN   "AT+QMIC"
 
#define LTECAT4_CMD_CONFIG_AUDIO_INTERFACE   "AT+QDAI"
 
#define LTECAT4_CMD_DIAL_NUMBER   "ATD"
 
#define LTECAT4_CMD_TERMINATE_CALL   "ATH"
 
#define LTECAT4_CMD_ANSWER_CALL   "ATA"
 
#define LTECAT4_CMD_LIST_CALLS   "AT+CLCC"
 
#define LTECAT4_CMD_CONFIG_URC_INDICATION   "AT+QURCCFG"
 
#define LTECAT4_RSP_START   "$"
 LTE Cat.4 response buffer commands. More...
 
#define LTECAT4_RSP_DELIMITER   ","
 
#define LTECAT4_RSP_END   "\r\n"
 
#define LTECAT4_RSP_GGA   "GGA"
 
#define LTECAT4_RSP_OK   "OK"
 LTE Cat.4 device response for AT commands. More...
 
#define LTECAT4_RSP_ERROR   "ERROR"
 
#define LTECAT4_URC_RECEIVED_DATA   "+QIURC:"
 LTE Cat.4 device unsolicited response code (URC) settings. More...
 
#define LTECAT4_URC_RING   "RING"
 
#define LTECAT4_URC_NO_CARRIER   "NO CARRIER"
 
#define LTECAT4_POWER_STATE_OFF   0
 LTE Cat.4 power state settings. More...
 
#define LTECAT4_POWER_STATE_ON   1
 
#define LTECAT4_GGA_ELEMENT_SIZE   15
 LTE Cat.4 GGA command elements. More...
 
#define LTECAT4_GGA_TIME   1
 
#define LTECAT4_GGA_LATITUDE   2
 
#define LTECAT4_GGA_LATITUDE_SIDE   3
 
#define LTECAT4_GGA_LONGITUDE   4
 
#define LTECAT4_GGA_LONGITUDE_SIDE   5
 
#define LTECAT4_GGA_QUALITY_INDICATOR   6
 
#define LTECAT4_GGA_NUMBER_OF_SATELLITES   7
 
#define LTECAT4_GGA_H_DILUTION_OF_POS   8
 
#define LTECAT4_GGA_ALTITUDE   9
 
#define LTECAT4_GGA_ALTITUDE_UNIT   10
 
#define LTECAT4_GGA_GEOIDAL_SEPARATION   11
 
#define LTECAT4_GGA_GEOIDAL_SEPARATION_UNIT   12
 
#define LTECAT4_GGA_TIME_SINCE_LAST_DGPS   13
 
#define LTECAT4_GGA_DGPS_REFERENCE_STATION_ID   14
 
#define LTECAT4_TX_DRV_BUFFER_SIZE   256
 LTE Cat.4 driver buffer size. More...
 
#define LTECAT4_RX_DRV_BUFFER_SIZE   256
 
#define LTECAT4_DEVICE_ADDRESS   0x10
 LTE Cat.4 device address setting. More...
 
#define LTECAT4_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  ltecat4_return_value_t {
  LTECAT4_OK = 0, LTECAT4_ERROR = -1, LTECAT4_ERROR_TIMEOUT = -2, LTECAT4_ERROR_CMD = -3,
  LTECAT4_ERROR_UNKNOWN = -4
}
 LTE Cat.4 Click return value data. More...
 

Functions

void ltecat4_cfg_setup (ltecat4_cfg_t *cfg)
 LTE Cat.4 configuration object setup function. More...
 
err_t ltecat4_init (ltecat4_t *ctx, ltecat4_cfg_t *cfg)
 LTE Cat.4 initialization function. More...
 
err_t ltecat4_write_register (ltecat4_t *ctx, uint8_t reg, uint8_t data_in)
 LTE Cat.4 MAX9860 writing function. More...
 
err_t ltecat4_read_register (ltecat4_t *ctx, uint8_t reg, uint8_t *data_out)
 LTE Cat.4 MAX9860 reading function. More...
 
err_t ltecat4_config_codec (ltecat4_t *ctx)
 LTE Cat.4 config codec function. More...
 
err_t ltecat4_generic_write (ltecat4_t *ctx, uint8_t *data_in, uint16_t len)
 LTE Cat.4 data writing function. More...
 
err_t ltecat4_generic_read (ltecat4_t *ctx, uint8_t *data_out, uint16_t len)
 LTE Cat.4 data reading function. More...
 
void ltecat4_set_pwr_pin (ltecat4_t *ctx, uint8_t state)
 LTE Cat.4 set PWR pin function. More...
 
void ltecat4_set_rts_pin (ltecat4_t *ctx, uint8_t state)
 LTE Cat.4 set RTS pin function. More...
 
uint8_t ltecat4_get_ring_pin (ltecat4_t *ctx)
 LTE Cat.4 get RING pin function. More...
 
uint8_t ltecat4_get_cts_pin (ltecat4_t *ctx)
 LTE Cat.4 get CTS pin function. More...
 
void ltecat4_set_power_state (ltecat4_t *ctx, uint8_t state)
 LTE Cat.4 set power state function. More...
 
void ltecat4_send_cmd (ltecat4_t *ctx, uint8_t *cmd)
 Send command function. More...
 
void ltecat4_send_cmd_par (ltecat4_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
 Send command function with parameter. More...
 
void ltecat4_send_cmd_check (ltecat4_t *ctx, uint8_t *at_cmd_buf)
 Check the sent command. More...
 
void ltecat4_set_sim_apn (ltecat4_t *ctx, uint8_t *sim_apn)
 Set sim card APN. More...
 
void ltecat4_send_sms_text (ltecat4_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
 LTE Cat.4 send SMS in text mode. More...
 
err_t ltecat4_send_sms_pdu (ltecat4_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
 LTE Cat.4 send SMS in PDU mode. More...
 
void ltecat4_dial_number (ltecat4_t *ctx, uint8_t *phone_number)
 LTE Cat.4 dial number. More...
 
err_t ltecat4_parse_gga (uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
 LTE Cat.4 parse GGA function. More...
 

Detailed Description

This file contains API for LTE Cat.4 Click Driver.

Enumeration Type Documentation

◆ ltecat4_return_value_t

LTE Cat.4 Click return value data.

Predefined enum values for driver return values.

Enumerator
LTECAT4_OK 
LTECAT4_ERROR 
LTECAT4_ERROR_TIMEOUT 
LTECAT4_ERROR_CMD 
LTECAT4_ERROR_UNKNOWN