lteiot15 2.2.0
Loading...
Searching...
No Matches
lteiot15.h File Reference

This file contains API for LTE IoT 15 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  lteiot15_t
 LTE IoT 15 Click context object. More...
struct  lteiot15_cfg_t
 LTE IoT 15 Click configuration object. More...

Macros

#define LTEIOT15_CMD_AT   "AT"
 LTE IoT 15 control commands.
#define LTEIOT15_CMD_GET_MODEL_ID   "AT+CGMM"
#define LTEIOT15_CMD_GET_SW_VERSION   "AT+CGMR"
#define LTEIOT15_CMD_GET_SERIAL_NUM   "AT+CGSN"
#define LTEIOT15_CMD_FACTORY_RESET   "AT&F"
#define LTEIOT15_CMD_SET_MODULE_FUNCTIONALITY   "AT+CFUN"
#define LTEIOT15_CMD_EPS_NETWORK_REGISTRATION   "AT+CEREG"
#define LTEIOT15_CMD_SIGNAL_QUALITY_REPORT   "AT+CSQ"
#define LTEIOT15_CMD_OPERATOR_SELECTION   "AT+COPS"
#define LTEIOT15_CMD_SEND_SMS   "AT+CMGS"
#define LTEIOT15_CMD_SELECT_SMS_FORMAT   "AT+CMGF"
#define LTEIOT15_CMD_DEFINE_PDP_CONTEXT   "AT+CGDCONT"
#define LTEIOT15_CMD_SHOW_PDP_ADDRESS   "AT+CGPADDR"
#define LTEIOT15_CMD_ACTIVATE_PDP_CONTEXT   "AT+CGACT"
#define LTEIOT15_CMD_PSD_CONFIG   "AT+UPSD"
#define LTEIOT15_CMD_PSD_ACTION   "AT+UPSDA"
#define LTEIOT15_CMD_CREATE_SOCKET   "AT+USOCR"
#define LTEIOT15_CMD_CLOSE_SOCKET   "AT+USOCL"
#define LTEIOT15_CMD_CONNECT_SOCKET   "AT+USOCO"
#define LTEIOT15_CMD_WRITE_SOCKET_DATA   "AT+USOWR"
#define LTEIOT15_CMD_READ_SOCKET_DATA   "AT+USORD"
#define LTEIOT15_CMD_GPIO_CONFIG   "AT+UGPIOC"
#define LTEIOT15_RSP_OK   "OK"
 LTE IoT 15 device response for AT commands.
#define LTEIOT15_RSP_ERROR   "ERROR"
#define LTEIOT15_URC_CREATE_SOCKET   "+USOCR: "
 LTE IoT 15 device unsolicited response code (URC) settings.
#define LTEIOT15_URC_RECEIVED_DATA   "+UUSORD: "
#define LTEIOT15_POWER_STATE_OFF   0
 LTE IoT 15 power state settings.
#define LTEIOT15_POWER_STATE_ON   1
#define LTEIOT15_POWER_STATE_RESET   2
#define LTEIOT15_TX_DRV_BUFFER_SIZE   300
 LTE IoT 15 driver buffer size.
#define LTEIOT15_RX_DRV_BUFFER_SIZE   300
#define LTEIOT15_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  lteiot15_return_value_t { LTEIOT15_OK = 0 , LTEIOT15_ERROR = -1 , LTEIOT15_ERROR_TIMEOUT = -2 , LTEIOT15_ERROR_CMD = -3 }
 LTE IoT 15 Click return value data. More...

Functions

void lteiot15_cfg_setup (lteiot15_cfg_t *cfg)
 LTE IoT 15 configuration object setup function.
err_t lteiot15_init (lteiot15_t *ctx, lteiot15_cfg_t *cfg)
 LTE IoT 15 initialization function.
err_t lteiot15_generic_write (lteiot15_t *ctx, uint8_t *data_in, uint16_t len)
 LTE IoT 15 data writing function.
err_t lteiot15_generic_read (lteiot15_t *ctx, uint8_t *data_out, uint16_t len)
 LTE IoT 15 data reading function.
void lteiot15_set_pwr_pin (lteiot15_t *ctx, uint8_t state)
 LTE IoT 15 set PWR pin function.
void lteiot15_set_rst_pin (lteiot15_t *ctx, uint8_t state)
 LTE IoT 15 set RST pin function.
void lteiot15_set_rts_pin (lteiot15_t *ctx, uint8_t state)
 LTE IoT 15 set RTS pin function.
uint8_t lteiot15_get_ring_pin (lteiot15_t *ctx)
 LTE IoT 15 get RING pin function.
uint8_t lteiot15_get_cts_pin (lteiot15_t *ctx)
 LTE IoT 15 get CTS pin function.
void lteiot15_set_power_state (lteiot15_t *ctx, uint8_t state)
 LTE IoT 15 set power state function.
void lteiot15_cmd_run (lteiot15_t *ctx, uint8_t *cmd)
 LTE IoT 15 cmd run function.
void lteiot15_cmd_set (lteiot15_t *ctx, uint8_t *cmd, uint8_t *value)
 LTE IoT 15 cmd set function.
void lteiot15_cmd_get (lteiot15_t *ctx, uint8_t *cmd)
 LTE IoT 15 cmd get function.
void lteiot15_cmd_help (lteiot15_t *ctx, uint8_t *cmd)
 LTE IoT 15 cmd help function.
void lteiot15_set_sim_apn (lteiot15_t *ctx, uint8_t *sim_apn)
 Set sim card APN.
void lteiot15_send_sms_text (lteiot15_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
 LTE IoT 15 send SMS in text mode.
err_t lteiot15_send_sms_pdu (lteiot15_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
 LTE IoT 15 send SMS in PDU mode.

Detailed Description

This file contains API for LTE IoT 15 Click Driver.

Enumeration Type Documentation

◆ lteiot15_return_value_t

LTE IoT 15 Click return value data.

Predefined enum values for driver return values.

Enumerator
LTEIOT15_OK 
LTEIOT15_ERROR 
LTEIOT15_ERROR_TIMEOUT 
LTEIOT15_ERROR_CMD