ltecat1us 2.0.0.0
ltecat1us.h File Reference

This file contains API for LTE Cat.1-US 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  ltecat1us_t
 LTE Cat.1-US Click context object. More...
 
struct  ltecat1us_cfg_t
 LTE Cat.1-US Click configuration object. More...
 

Macros

#define LTECAT1US_CMD_AT   "AT"
 LTE Cat.1-US description setting.
 
#define LTECAT1US_CMD_ATI   "ATI"
 
#define LTECAT1US_CMD_CGMR   "AT+CGMR"
 
#define LTECAT1US_CMD_CFUN   "AT+CFUN"
 
#define LTECAT1US_CMD_CREG   "AT+CREG"
 
#define LTECAT1US_CMD_CEREG   "AT+CEREG"
 
#define LTECAT1US_CMD_CGDCONT   "AT+CGDCONT"
 
#define LTECAT1US_CMD_CIMI   "AT+CIMI"
 
#define LTECAT1US_CMD_CGATT   "AT+CGATT"
 
#define LTECAT1US_CMD_CSQ   "AT+CSQ"
 
#define LTECAT1US_CMD_CESQ   "AT+CESQ"
 
#define LTECAT1US_CMD_COPS   "AT+COPS"
 
#define DRV_RX_BUFFER_SIZE   500
 LTE Cat.1-US driver buffer size.
 
#define DRV_TX_BUFFER_SIZE   100
 
#define LTECAT1US_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  ltecat1us_return_value_t { LTECAT1US_OK = 0 , LTECAT1US_ERROR = -1 }
 LTE Cat.1-US Click return value data. More...
 

Functions

void ltecat1us_cfg_setup (ltecat1us_cfg_t *cfg)
 LTE Cat.1-US configuration object setup function.
 
err_t ltecat1us_init (ltecat1us_t *ctx, ltecat1us_cfg_t *cfg)
 LTE Cat.1-US initialization function.
 
void ltecat1us_generic_write (ltecat1us_t *ctx, char *data_buf, uint16_t len)
 LTE Cat.1-US data writing function.
 
err_t ltecat1us_generic_read (ltecat1us_t *ctx, char *data_buf, uint16_t max_len)
 LTE Cat.1-US data reading function.
 
void ltecat1us_power_on (ltecat1us_t *ctx)
 LTE Cat.1-US module power on.
 
void ltecat1us_set_rst (ltecat1us_t *ctx, uint8_t state)
 Sets state of the RST pin.
 
void ltecat1us_set_rts (ltecat1us_t *ctx, uint8_t state)
 Sets state of the RTS pin.
 
uint8_t ltecat1us_get_cts (ltecat1us_t *ctx)
 CTS Pin Get function.
 
void ltecat1us_send_cmd (ltecat1us_t *ctx, char *cmd)
 Send command function.
 
void ltecat1us_send_cmd_with_parameter (ltecat1us_t *ctx, char *at_cmd_buf, char *param_buf)
 Send command function with parameter.
 
void ltecat1us_send_cmd_check (ltecat1us_t *ctx, char *at_cmd_buf)
 Check the sent command.
 
void ltecat1us_send_cmd_parameter_check (ltecat1us_t *ctx, char *at_cmd_buf)
 Check the command parameters.
 
void ltecat1us_set_sim_apn (ltecat1us_t *ctx, char *sim_apn)
 Set sim card APN.
 
void ltecat1us_send_text_message (ltecat1us_t *ctx, char *phone_number, char *message_context)
 LTE Cat.1-US send text message.
 

Detailed Description

This file contains API for LTE Cat.1-US Click Driver.

Enumeration Type Documentation

◆ ltecat1us_return_value_t

LTE Cat.1-US Click return value data.

Predefined enum values for driver return values.

Enumerator
LTECAT1US_OK 
LTECAT1US_ERROR