lteiot9 2.0.0.0
lteiot9.h File Reference

This file contains API for LTE IoT 9 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  lteiot9_t
 LTE IoT 9 Click context object. More...
 
struct  lteiot9_cfg_t
 LTE IoT 9 Click configuration object. More...
 

Macros

#define LTEIOT9_CMD_AT   "AT"
 LTE IoT 9 description commands.
 
#define LTEIOT9_CMD_ATI   "ATI"
 
#define LTEIOT9_CMD_CGMR   "AT+CGMR"
 
#define LTEIOT9_CMD_CFUN   "AT+CFUN"
 
#define LTEIOT9_CMD_CREG   "AT+CREG"
 
#define LTEIOT9_CMD_CEREG   "AT+CEREG"
 
#define LTEIOT9_CMD_CGDCONT   "AT+CGDCONT"
 
#define LTEIOT9_CMD_CIMI   "AT+CIMI"
 
#define LTEIOT9_CMD_CGATT   "AT+CGATT"
 
#define LTEIOT9_CMD_CSQ   "AT+CSQ"
 
#define LTEIOT9_CMD_CESQ   "AT+CESQ"
 
#define LTEIOT9_CMD_COPS   "AT+COPS"
 
#define LTEIOT9_CMD_URAT   "AT+URAT"
 
#define LTEIOT9_CMD_UBANDMASK   "AT+UBANDMASK"
 
#define LTEIOT9_CMD_URATCONF   "AT+URATCONF"
 
#define LTEIOT9_CMD_UAUTHREQ   "AT+UAUTHREQ"
 
#define LTEIOT9_CMD_UUICC   "AT+UUICC"
 
#define LTEIOT9_CMD_UCGED   "AT+UCGED"
 
#define LTEIOT9_CMD_UCELLINFO   "AT+UCELLINFO"
 
#define LTEIOT9_CMD_UANTR   "AT+UANTR"
 
#define LTEIOT9_CMD_CMGF   "AT+CMGF"
 
#define LTEIOT9_GNSS_GPGGA   "GPGGA"
 LTE IoT 9 GNNS helping.
 
#define LTEIOT9_GNSS_START   '$'
 
#define LTEIOT9_GNSS_SEPARATOR   ','
 
#define LTEIOT9_GPGGA_LATITUDE   2
 LTE IoT 9 GPGGA value elements.
 
#define LTEIOT9_GPGGA_LONGITUDE   4
 
#define LTEIOT9_GPGGA_ALTITUDE   9
 
#define LTEIOT9_SYSSTART   "^SYSSTART"
 LTE IoT 9 start response.
 
#define LTEIOT9_RSP_OK   "OK"
 LTE IoT 9 device response for AT commands.
 
#define LTEIOT9_RSP_ERROR   "ERROR"
 
#define DRV_TX_BUFFER_SIZE   200
 LTE IoT 9 driver buffer size.
 
#define DRV_RX_BUFFER_SIZE   500
 
#define LTEIOT9_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  lteiot9_return_value_t { LTEIOT9_OK = 0 , LTEIOT9_ERROR = -1 , LTEIOT9_ERROR_OVERFLOW = -2 , LTEIOT9_ERROR_TIMEOUT = -3 }
 LTE IoT 9 Click return value data. More...
 

Functions

void lteiot9_cfg_setup (lteiot9_cfg_t *cfg)
 LTE IoT 9 configuration object setup function.
 
err_t lteiot9_init (lteiot9_t *ctx, lteiot9_cfg_t *cfg)
 LTE IoT 9 initialization function.
 
err_t lteiot9_default_cfg (lteiot9_t *ctx)
 LTE IoT 9 default configuration function.
 
err_t lteiot9_generic_write (lteiot9_t *ctx, char *data_buf, uint16_t len)
 LTE IoT 9 data writing function.
 
err_t lteiot9_generic_read (lteiot9_t *ctx, char *data_buf, uint16_t max_len)
 LTE IoT 9 data reading function.
 
void lteiot9_set_pin_on (lteiot9_t *ctx, uint8_t state)
 Set ON pin state.
 
void lteiot9_send_cmd (lteiot9_t *ctx, char *cmd)
 Send command function.
 
void lteiot9_send_cmd_with_parameter (lteiot9_t *ctx, char *at_cmd_buf, char *param_buf)
 Send command function with parameter.
 
void lteiot9_send_cmd_check (lteiot9_t *ctx, char *at_cmd_buf)
 Check the sent command.
 
void lteiot9_send_cmd_parameter_check (lteiot9_t *ctx, char *at_cmd_buf)
 Check the command parameters.
 
void lteiot9_set_sim_apn (lteiot9_t *ctx, char *sim_apn)
 Set sim card APN.
 
void lteiot9_send_text_message (lteiot9_t *ctx, char *phone_number, char *message_context)
 LTE IoT 9 send text message.
 

Detailed Description

This file contains API for LTE IoT 9 Click Driver.

Enumeration Type Documentation

◆ lteiot9_return_value_t

LTE IoT 9 Click return value data.

Predefined enum values for driver return values.

Enumerator
LTEIOT9_OK 
LTEIOT9_ERROR 
LTEIOT9_ERROR_OVERFLOW 
LTEIOT9_ERROR_TIMEOUT