lteiot5 2.0.0.0
lteiot5.h File Reference

This file contains API for LTE IoT 5 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  lteiot5_t
 LTE IoT 5 Click context object. More...
 
struct  lteiot5_cfg_t
 LTE IoT 5 Click configuration object. More...
 

Macros

#define LTEIOT5_CMD_AT   "AT"
 LTE IoT 5 description setting.
 
#define LTEIOT5_CMD_ATI   "ATI"
 
#define LTEIOT5_CMD_CGMR   "AT+CGMR"
 
#define LTEIOT5_CMD_CFUN   "AT+CFUN"
 
#define LTEIOT5_CMD_CREG   "AT+CREG"
 
#define LTEIOT5_CMD_CEREG   "AT+CEREG"
 
#define LTEIOT5_CMD_CGDCONT   "AT+CGDCONT"
 
#define LTEIOT5_CMD_CIMI   "AT+CIMI"
 
#define LTEIOT5_CMD_CGATT   "AT+CGATT"
 
#define LTEIOT5_CMD_CSQ   "AT+CSQ"
 
#define LTEIOT5_CMD_CESQ   "AT+CESQ"
 
#define LTEIOT5_CMD_COPS   "AT+COPS"
 
#define LTEIOT5_CMD_URAT   "AT+URAT"
 
#define LTEIOT5_CMD_UBANDMASK   "AT+UBANDMASK"
 
#define LTEIOT5_CMD_URATCONF   "AT+URATCONF"
 
#define LTEIOT5_CMD_UAUTHREQ   "AT+UAUTHREQ"
 
#define LTEIOT5_CMD_UUICC   "AT+UUICC"
 
#define LTEIOT5_CMD_UCGED   "AT+UCGED"
 
#define LTEIOT5_CMD_UCELLINFO   "AT+UCELLINFO"
 
#define LTEIOT5_CMD_UANTR   "AT+UANTR"
 
#define DRV_RX_BUFFER_SIZE   500
 LTE IoT 5 driver buffer size.
 
#define DRV_TX_BUFFER_SIZE   150
 
#define LTEIOT5_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Functions

void lteiot5_cfg_setup (lteiot5_cfg_t *cfg)
 LTE IoT 5 configuration object setup function.
 
err_t lteiot5_init (lteiot5_t *ctx, lteiot5_cfg_t *cfg)
 LTE IoT 5 initialization function.
 
err_t lteiot5_default_cfg (lteiot5_t *ctx)
 LTE IoT 5 default configuration function.
 
err_t lteiot5_generic_write (lteiot5_t *ctx, char *data_buf, uint16_t len)
 LTE IoT 5 data writing function.
 
err_t lteiot5_generic_read (lteiot5_t *ctx, char *data_buf, uint16_t max_len)
 LTE IoT 5 data reading function.
 
void lteiot5_power_on (lteiot5_t *ctx)
 LTE IoT 5 power on.
 
void lteiot5_reset (lteiot5_t *ctx)
 LTE IoT 5 power on.
 
void lteiot5_set_pwr (lteiot5_t *ctx, uint8_t state)
 Sets state of the PWR pin.
 
void lteiot5_set_rst (lteiot5_t *ctx, uint8_t state)
 Sets state of the RST pin.
 
void lteiot5_set_rts (lteiot5_t *ctx, uint8_t state)
 Sets state of the RTS pin.
 
uint8_t lteiot5_get_ri (lteiot5_t *ctx)
 RI Pin Get function.
 
uint8_t lteiot5_get_cts (lteiot5_t *ctx)
 CTS Pin Get function.
 
void lteiot5_send_cmd (lteiot5_t *ctx, char *cmd)
 Send command function.
 
void lteiot5_send_cmd_with_parameter (lteiot5_t *ctx, char *at_cmd_buf, char *param_buf)
 Send command function with parameter.
 
void lteiot5_send_cmd_check (lteiot5_t *ctx, char *at_cmd_buf)
 Check the sent command.
 
void lteiot5_send_cmd_parameter_check (lteiot5_t *ctx, char *at_cmd_buf)
 Check the command parameters.
 
void lteiot5_set_sim_apn (lteiot5_t *ctx, char *sim_apn)
 Set sim card APN.
 
void lteiot5_send_text_message (lteiot5_t *ctx, char *phone_number, char *message_context)
 LTE IoT 5 send text message.
 

Detailed Description

This file contains API for LTE IoT 5 Click Driver.