ltecat43.h File Reference

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

Macros
#define	LTECAT43_CMD_AT   "AT"
	LTE Cat.4 3 control commands.
#define	LTECAT43_CMD_ATI   "ATI"
#define	LTECAT43_CMD_CGMR   "AT+CGMR"
#define	LTECAT43_CMD_CFUN   "AT+CFUN"
#define	LTECAT43_CMD_CREG   "AT+CREG"
#define	LTECAT43_CMD_CGREG   "AT+CGREG"
#define	LTECAT43_CMD_CGDCONT   "AT+CGDCONT"
#define	LTECAT43_CMD_CIMI   "AT+CIMI"
#define	LTECAT43_CMD_CMEE   "AT+CMEE"
#define	LTECAT43_CMD_CGATT   "AT+CGATT"
#define	LTECAT43_CMD_CSQ   "AT+CSQ"
#define	LTECAT43_CMD_COPS   "AT+COPS"
#define	LTECAT43_CMD_CMGS   "AT+CMGS"
#define	LTECAT43_CMD_CMGF   "AT+CMGF"
#define	LTECAT43_CMD_CGACT   "AT+CGACT"
#define	LTECAT43_CMD_USOCR   "AT+USOCR"
#define	LTECAT43_CMD_USOCO   "AT+USOCO"
#define	LTECAT43_CMD_USOWR   "AT+USOWR"
#define	LTECAT43_CMD_USOST   "AT+USOST"
#define	LTECAT43_CMD_USORD   "AT+USORD"
#define	LTECAT43_CMD_USORF   "AT+USORF"
#define	LTECAT43_CMD_USOCL   "AT+USOCL"
#define	LTECAT43_CMD_UGPS   "AT+UGPS"
#define	LTECAT43_CMD_UGGGA   "AT+UGGGA"
#define	LTECAT43_RSP_OK   "OK"
	LTE Cat.4 3 device response for AT commands.
#define	LTECAT43_RSP_ERROR   "ERROR"
#define	LTECAT43_POWER_STATE_OFF   0
	LTE Cat.4 3 power state settings.
#define	LTECAT43_POWER_STATE_ON   1
#define	LTECAT43_TX_DRV_BUFFER_SIZE   256
	LTE Cat.4 3 driver buffer size.
#define	LTECAT43_RX_DRV_BUFFER_SIZE   256
#define	LTECAT43_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	ltecat43_return_value_t {   LTECAT43_OK = 0 , LTECAT43_ERROR = -1 , LTECAT43_ERROR_TIMEOUT = -2 , LTECAT43_ERROR_CMD = -3 ,   LTECAT43_ERROR_UNKNOWN = -4 }
	LTE Cat.4 3 Click return value data. More...

Functions
void	ltecat43_cfg_setup (ltecat43_cfg_t *cfg)
	LTE Cat.4 3 configuration object setup function.
err_t	ltecat43_init (ltecat43_t *ctx, ltecat43_cfg_t *cfg)
	LTE Cat.4 3 initialization function.
err_t	ltecat43_generic_write (ltecat43_t *ctx, uint8_t *data_in, uint16_t len)
	LTE Cat.4 3 data writing function.
err_t	ltecat43_generic_read (ltecat43_t *ctx, uint8_t *data_out, uint16_t len)
	LTE Cat.4 3 data reading function.
void	ltecat43_set_pwr_pin (ltecat43_t *ctx, uint8_t state)
	LTE Cat.4 3 set PWR pin function.
void	ltecat43_set_sts_pin (ltecat43_t *ctx, uint8_t state)
	LTE Cat.4 3 set STS pin function.
void	ltecat43_set_rts_pin (ltecat43_t *ctx, uint8_t state)
	LTE Cat.4 3 set RTS pin function.
uint8_t	ltecat43_get_ri_pin (ltecat43_t *ctx)
	LTE Cat.4 3 get RI pin function.
uint8_t	ltecat43_get_cts_pin (ltecat43_t *ctx)
	LTE Cat.4 3 get CTS pin function.
void	ltecat43_set_power_state (ltecat43_t *ctx, uint8_t state)
	LTE Cat.4 3 set power state function.
void	ltecat43_send_cmd (ltecat43_t *ctx, uint8_t *cmd)
	Send command function.
void	ltecat43_send_cmd_par (ltecat43_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
	Send command function with parameter.
void	ltecat43_send_cmd_check (ltecat43_t *ctx, uint8_t *at_cmd_buf)
	Check the sent command.
void	ltecat43_set_sim_apn (ltecat43_t *ctx, uint8_t *sim_apn)
	Set sim card APN.
void	ltecat43_send_sms_text (ltecat43_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
	LTE Cat.4 3 send SMS in text mode.
err_t	ltecat43_send_sms_pdu (ltecat43_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
	LTE Cat.4 3 send SMS in PDU mode.

Detailed Description

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

Enumeration Type Documentation

ltecat43_return_value_t

enum ltecat43_return_value_t

LTE Cat.4 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
LTECAT43_OK
LTECAT43_ERROR
LTECAT43_ERROR_TIMEOUT
LTECAT43_ERROR_CMD
LTECAT43_ERROR_UNKNOWN