lteiot10 2.2.1
Loading...
Searching...
No Matches
lteiot10.h File Reference

This file contains API for LTE IoT 10 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  lteiot10_t
 LTE IoT 10 Click context object. More...
struct  lteiot10_cfg_t
 LTE IoT 10 Click configuration object. More...

Macros

#define LTEIOT10_CMD_AT   "AT"
 LTE IoT 10 control commands.
#define LTEIOT10_CMD_GET_MODEL_ID   "AT+CGMM"
#define LTEIOT10_CMD_GET_SW_VERSION   "AT+CGMR"
#define LTEIOT10_CMD_GET_SERIAL_NUM   "AT+CGSN"
#define LTEIOT10_CMD_FACTORY_RESET   "AT&F"
#define LTEIOT10_CMD_HARD_RESET   "AT^RESET"
#define LTEIOT10_CMD_DISABLE_ECHO   "ATE0"
#define LTEIOT10_CMD_ENABLE_ECHO   "ATE1"
#define LTEIOT10_CMD_SET_PHONE_FUNCTIONALITY   "AT+CFUN"
#define LTEIOT10_CMD_NETWORK_REGISTRATION   "AT+CEREG"
#define LTEIOT10_CMD_SIGNAL_QUALITY_REPORT   "AT+CSQ"
#define LTEIOT10_CMD_OPERATOR_SELECTION   "AT+COPS"
#define LTEIOT10_CMD_SEND_SMS   "AT+CMGS"
#define LTEIOT10_CMD_SELECT_SMS_FORMAT   "AT+CMGF"
#define LTEIOT10_CMD_DEFINE_PDP_CONTEXT   "AT+CGDCONT"
#define LTEIOT10_CMD_ACTIVATE_PDP_CONTEXT   "AT+CGACT"
#define LTEIOT10_CMD_SHOW_PDP_ADDRESS   "AT+CGPADDR"
#define LTEIOT10_CMD_OPEN_TCP_UDP_CONNECTION   "AT+SQNSD"
#define LTEIOT10_CMD_SEND_DATA_VIA_CONNECTION   "AT+SQNSSEND"
#define LTEIOT10_CMD_RECEIVE_DATA_VIA_CONNECTION   "AT+SQNSRECV"
#define LTEIOT10_CMD_CLOSE_TCP_UDP_CONNECTION   "AT+SQNSH"
#define LTEIOT10_RSP_OK   "OK"
 LTE IoT 10 device response for AT commands.
#define LTEIOT10_RSP_ERROR   "ERROR"
#define LTEIOT10_URC_READY   "+SYSSTART"
 LTE IoT 10 device unsolicited response code (URC) settings.
#define LTEIOT10_URC_RECEIVED_DATA   "+SQNSRING:"
#define LTEIOT10_URC_CONNECTION_OPEN   "+SQNSD:"
#define LTEIOT10_URC_CONNECTION_CLOSED   "+SQNSH:"
#define LTEIOT10_TX_DRV_BUFFER_SIZE   256
 LTE IoT 10 driver buffer size.
#define LTEIOT10_RX_DRV_BUFFER_SIZE   256
#define LTEIOT10_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  lteiot10_return_value_t { LTEIOT10_OK = 0 , LTEIOT10_ERROR = -1 , LTEIOT10_ERROR_TIMEOUT = -2 , LTEIOT10_ERROR_CMD = -3 }
 LTE IoT 10 Click return value data. More...

Functions

void lteiot10_cfg_setup (lteiot10_cfg_t *cfg)
 LTE IoT 10 configuration object setup function.
err_t lteiot10_init (lteiot10_t *ctx, lteiot10_cfg_t *cfg)
 LTE IoT 10 initialization function.
err_t lteiot10_generic_write (lteiot10_t *ctx, uint8_t *data_in, uint16_t len)
 LTE IoT 10 data writing function.
err_t lteiot10_generic_read (lteiot10_t *ctx, uint8_t *data_out, uint16_t len)
 LTE IoT 10 data reading function.
void lteiot10_set_wkp_pin (lteiot10_t *ctx, uint8_t state)
 LTE IoT 10 set WKP pin function.
void lteiot10_set_rst_pin (lteiot10_t *ctx, uint8_t state)
 LTE IoT 10 set RST pin function.
void lteiot10_set_rts_pin (lteiot10_t *ctx, uint8_t state)
 LTE IoT 10 set RTS pin function.
uint8_t lteiot10_get_ring_pin (lteiot10_t *ctx)
 LTE IoT 10 get RING pin function.
uint8_t lteiot10_get_cts_pin (lteiot10_t *ctx)
 LTE IoT 10 get CTS pin function.
void lteiot10_reset_device (lteiot10_t *ctx)
 LTE IoT 10 reset device function.
void lteiot10_cmd_run (lteiot10_t *ctx, uint8_t *cmd)
 LTE IoT 10 cmd run function.
void lteiot10_cmd_set (lteiot10_t *ctx, uint8_t *cmd, uint8_t *value)
 LTE IoT 10 cmd set function.
void lteiot10_cmd_get (lteiot10_t *ctx, uint8_t *cmd)
 LTE IoT 10 cmd get function.
void lteiot10_cmd_help (lteiot10_t *ctx, uint8_t *cmd)
 LTE IoT 10 cmd help function.
void lteiot10_set_sim_apn (lteiot10_t *ctx, uint8_t *sim_apn)
 Set sim card APN.
void lteiot10_send_sms_text (lteiot10_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
 LTE IoT 10 send SMS in text mode.
err_t lteiot10_send_sms_pdu (lteiot10_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
 LTE IoT 10 send SMS in PDU mode.

Detailed Description

This file contains API for LTE IoT 10 Click Driver.

Enumeration Type Documentation

◆ lteiot10_return_value_t

LTE IoT 10 Click return value data.

Predefined enum values for driver return values.

Enumerator
LTEIOT10_OK 
LTEIOT10_ERROR 
LTEIOT10_ERROR_TIMEOUT 
LTEIOT10_ERROR_CMD