lteiot8 2.0.0.0
lteiot8.h File Reference

This file contains API for LTE IoT 8 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  lteiot8_t
 LTE IoT 8 Click context object. More...
 
struct  lteiot8_cfg_t
 LTE IoT 8 Click configuration object. More...
 

Macros

#define LTEIOT8_CMD_AT   "AT"
 LTE IoT 9 description commands.
 
#define LTEIOT8_CMD_ATI   "ATI"
 
#define LTEIOT8_CMD_CGMR   "AT+CGMR"
 
#define LTEIOT8_CMD_CFUN   "AT+CFUN"
 
#define LTEIOT8_CMD_CREG   "AT+CREG"
 
#define LTEIOT8_CMD_CEREG   "AT+CEREG"
 
#define LTEIOT8_CMD_CGDCONT   "AT+CGDCONT"
 
#define LTEIOT8_CMD_CIMI   "AT+CIMI"
 
#define LTEIOT8_CMD_CGATT   "AT+CGATT"
 
#define LTEIOT8_CMD_CSQ   "AT+CSQ"
 
#define LTEIOT8_CMD_CESQ   "AT+CESQ"
 
#define LTEIOT8_CMD_COPS   "AT+COPS"
 
#define LTEIOT8_CMD_CMGF   "AT+CMGF"
 
#define LTEIOT8_CMD_CMGS   "AT+CMGS"
 
#define LTEIOT8_CMD_CSCA   "AT+CSCA"
 
#define LTEIOT8_CMD_SQNLED   "AT+SQNLED"
 
#define LTEIOT8_RSP_OK   "OK"
 LTE IoT 8 device response for AT commands.
 
#define LTEIOT8_RSP_ERROR   "ERROR"
 
#define LTEIOT8_RSP_SYSTART   "+SYSSTART"
 
#define DRV_TX_BUFFER_SIZE   200
 LTE IoT 8 driver buffer size.
 
#define DRV_RX_BUFFER_SIZE   500
 
#define LTEIOT8_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  lteiot8_return_value_t {
  LTEIOT8_OK = 0 , LTEIOT8_ERROR = -1 , LTEIOT8_ERROR_TIMEOUT = -2 , LTEIOT8_ERROR_CMD = -3 ,
  LTEIOT8_ERROR_UNKNOWN = -4
}
 LTE IoT 8 Click return value data. More...
 

Functions

void lteiot8_cfg_setup (lteiot8_cfg_t *cfg)
 LTE IoT 8 configuration object setup function.
 
err_t lteiot8_init (lteiot8_t *ctx, lteiot8_cfg_t *cfg)
 LTE IoT 8 initialization function.
 
err_t lteiot8_default_cfg (lteiot8_t *ctx)
 LTE IoT 8 default configuration function.
 
err_t lteiot8_generic_write (lteiot8_t *ctx, char *data_buf, uint16_t len)
 LTE IoT 8 data writing function.
 
err_t lteiot8_generic_read (lteiot8_t *ctx, char *data_buf, uint16_t max_len)
 LTE IoT 8 data reading function.
 
void lteiot8_send_cmd (lteiot8_t *ctx, char *cmd)
 Send command function.
 
void lteiot8_send_cmd_with_parameter (lteiot8_t *ctx, char *at_cmd_buf, char *param_buf)
 Send command with parameters.
 
void lteiot8_send_cmd_check (lteiot8_t *ctx, char *at_cmd_buf)
 Send command to check commands current value.
 
void lteiot8_send_cmd_syntax_check (lteiot8_t *ctx, char *at_cmd_buf)
 Send command to check commands available parameters.
 
void lteiot8_set_sim_apn (lteiot8_t *ctx, char *sim_apn)
 Set SIM APN.
 
void lteiot8_send_text_message (lteiot8_t *ctx, char *phone_number, char *message_content)
 Send SMS message to number in text mode.
 
err_t lteiot8_send_sms_pdu (lteiot8_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
 Send SMS message to number in pdu mode.
 

Detailed Description

This file contains API for LTE IoT 8 Click Driver.

Enumeration Type Documentation

◆ lteiot8_return_value_t

LTE IoT 8 Click return value data.

Predefined enum values for driver return values.

Enumerator
LTEIOT8_OK 
LTEIOT8_ERROR 
LTEIOT8_ERROR_TIMEOUT 
LTEIOT8_ERROR_CMD 
LTEIOT8_ERROR_UNKNOWN