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

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

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

Go to the source code of this file.

Data Structures

struct  ltecat16_t
 LTE Cat.1 6 Click context object. More...
 
struct  ltecat16_cfg_t
 LTE Cat.1 6 Click configuration object. More...
 

Macros

#define LTECAT16_CMD_AT   "AT"
 LTE Cat.1 6 control commands. More...
 
#define LTECAT16_CMD_GET_MODEL_ID   "AT+CGMM"
 
#define LTECAT16_CMD_GET_SW_VERSION   "AT+CGMR"
 
#define LTECAT16_CMD_GET_SERIAL_NUM   "AT+CGSN"
 
#define LTECAT16_CMD_FACTORY_RESET   "AT&F"
 
#define LTECAT16_CMD_SET_PHONE_FUNCTIONALITY   "AT+CFUN"
 
#define LTECAT16_CMD_NETWORK_REGISTRATION   "AT+CREG"
 
#define LTECAT16_CMD_SIGNAL_QUALITY_REPORT   "AT+CSQ"
 
#define LTECAT16_CMD_OPERATOR_SELECTION   "AT+COPS"
 
#define LTECAT16_CMD_SEND_SMS   "AT+CMGS"
 
#define LTECAT16_CMD_SELECT_SMS_FORMAT   "AT+CMGF"
 
#define LTECAT16_CMD_DEFINE_PDP_CONTEXT   "AT+CGDCONT"
 
#define LTECAT16_CMD_ACTIVATE_PDP_CONTEXT   "AT+CGACT"
 
#define LTECAT16_CMD_SHOW_PDP_ADDRESS   "AT+CGPADDR"
 
#define LTECAT16_CMD_START_TCPIP_SERVICE   "AT+NETOPEN"
 
#define LTECAT16_CMD_OPEN_TCP_UDP_CONNECTION   "AT+CIPOPEN"
 
#define LTECAT16_CMD_SEND_DATA_VIA_CONNECTION   "AT+CIPSEND"
 
#define LTECAT16_CMD_RECEIVE_DATA_VIA_CONNECTION   "AT+CIPRXGET"
 
#define LTECAT16_CMD_CLOSE_TCP_UDP_CONNECTION   "AT+CIPCLOSE"
 
#define LTECAT16_RSP_OK   "OK"
 LTE Cat.1 6 device response for AT commands. More...
 
#define LTECAT16_RSP_ERROR   "ERROR"
 
#define LTECAT16_URC_RECEIVED_DATA   "+CIPRXGET:"
 LTE Cat.1 6 device unsolicited response code (URC) settings. More...
 
#define LTECAT16_POWER_STATE_OFF   0
 LTE Cat.1 6 power state settings. More...
 
#define LTECAT16_POWER_STATE_ON   1
 
#define LTECAT16_TX_DRV_BUFFER_SIZE   256
 LTE Cat.1 6 driver buffer size. More...
 
#define LTECAT16_RX_DRV_BUFFER_SIZE   256
 
#define LTECAT16_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  ltecat16_return_value_t {
  LTECAT16_OK = 0, LTECAT16_ERROR = -1, LTECAT16_ERROR_TIMEOUT = -2, LTECAT16_ERROR_CMD = -3,
  LTECAT16_ERROR_UNKNOWN = -4
}
 LTE Cat.1 6 Click return value data. More...
 

Functions

void ltecat16_cfg_setup (ltecat16_cfg_t *cfg)
 LTE Cat.1 6 configuration object setup function. More...
 
err_t ltecat16_init (ltecat16_t *ctx, ltecat16_cfg_t *cfg)
 LTE Cat.1 6 initialization function. More...
 
err_t ltecat16_generic_write (ltecat16_t *ctx, uint8_t *data_in, uint16_t len)
 LTE Cat.1 6 data writing function. More...
 
err_t ltecat16_generic_read (ltecat16_t *ctx, uint8_t *data_out, uint16_t len)
 LTE Cat.1 6 data reading function. More...
 
void ltecat16_set_pwr_pin (ltecat16_t *ctx, uint8_t state)
 LTE Cat.1 6 set PWR pin function. More...
 
void ltecat16_set_rts_pin (ltecat16_t *ctx, uint8_t state)
 LTE Cat.1 6 set RTS pin function. More...
 
uint8_t ltecat16_get_ring_pin (ltecat16_t *ctx)
 LTE Cat.1 6 get RING pin function. More...
 
uint8_t ltecat16_get_cts_pin (ltecat16_t *ctx)
 LTE Cat.1 6 get CTS pin function. More...
 
void ltecat16_set_power_state (ltecat16_t *ctx, uint8_t state)
 LTE Cat.1 6 set power state function. More...
 
void ltecat16_send_cmd (ltecat16_t *ctx, uint8_t *cmd)
 Send command function. More...
 
void ltecat16_send_cmd_par (ltecat16_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
 Send command function with parameter. More...
 
void ltecat16_send_cmd_check (ltecat16_t *ctx, uint8_t *at_cmd_buf)
 Check the sent command. More...
 
void ltecat16_set_sim_apn (ltecat16_t *ctx, uint8_t *sim_apn)
 Set sim card APN. More...
 
void ltecat16_send_sms_text (ltecat16_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
 LTE Cat.1 6 send SMS in text mode. More...
 
err_t ltecat16_send_sms_pdu (ltecat16_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
 LTE Cat.1 6 send SMS in PDU mode. More...
 

Detailed Description

This file contains API for LTE Cat.1 6 Click Driver.

Enumeration Type Documentation

◆ ltecat16_return_value_t

LTE Cat.1 6 Click return value data.

Predefined enum values for driver return values.

Enumerator
LTECAT16_OK 
LTECAT16_ERROR 
LTECAT16_ERROR_TIMEOUT 
LTECAT16_ERROR_CMD 
LTECAT16_ERROR_UNKNOWN