lteiot12 2.1.0.0
Data Structures | Macros | Enumerations | Functions
lteiot12.h File Reference

This file contains API for LTE IoT 12 Click Driver. More...

#include "mikrosdk_version.h"
#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  lteiot12_t
 LTE IoT 12 Click context object. More...
 
struct  lteiot12_cfg_t
 LTE IoT 12 Click configuration object. More...
 

Macros

#define LTEIOT12_CMD_AT   "AT"
 LTE IoT 12 control commands. More...
 
#define LTEIOT12_CMD_ATI   "ATI"
 
#define LTEIOT12_CMD_CGMR   "AT+CGMR"
 
#define LTEIOT12_CMD_CFUN   "AT+CFUN"
 
#define LTEIOT12_CMD_CREG   "AT+CREG"
 
#define LTEIOT12_CMD_CEREG   "AT+CEREG"
 
#define LTEIOT12_CMD_CGREG   "AT+CGREG"
 
#define LTEIOT12_CMD_CGDCONT   "AT+CGDCONT"
 
#define LTEIOT12_CMD_CMGF   "AT+CMGF"
 
#define LTEIOT12_CMD_CGDCONT   "AT+CGDCONT"
 
#define LTEIOT12_CMD_CIMI   "AT+CIMI"
 
#define LTEIOT12_CMD_CGATT   "AT+CGATT"
 
#define LTEIOT12_CMD_CSQ   "AT+CSQ"
 
#define LTEIOT12_CMD_CESQ   "AT+CESQ"
 
#define LTEIOT12_CMD_COPS   "AT+COPS"
 
#define LTEIOT12_CMD_CSCON   "AT+CSCON"
 
#define LTEIOT12_CMD_CMEE   "AT+CMEE"
 
#define LTEIOT12_CMD_CMGS   "AT+CMGS"
 
#define LTEIOT12_CMD_CGACT   "AT+CGACT"
 
#define LTEIOT12_CMD_CSCS   "AT+CSCS"
 
#define LTEIOT12_CMD_CMGF   "AT+CMGF"
 
#define LTEIOT12_CMD_CPSMS   "AT+CPSMS"
 
#define LTEIOT12_CMD_SM   "AT+SM"
 
#define LTEIOT12_CMD_QSCLK   "AT+QSCLK"
 
#define LTEIOT12_CMD_QIOPEN   "AT+QIOPEN"
 
#define LTEIOT12_CMD_QISEND   "AT+QISEND"
 
#define LTEIOT12_CMD_QIRD   "AT+QIRD"
 
#define LTEIOT12_CMD_QICLOSE   "AT+QICLOSE"
 
#define LTEIOT12_CMD_QCSCON   "AT+QCSCON"
 
#define LTEIOT12_CMD_QGPS   "AT+QGPS"
 
#define LTEIOT12_CMD_QGPSCFG   "AT+QGPSCFG"
 
#define LTEIOT12_CMD_QGPSGNMEA   "AT+QGPSGNMEA"
 
#define LTEIOT12_CMD_QGPSLOC   "AT+QGPSLOC"
 
#define LTEIOT12_RSP_OK   "OK"
 LTE IoT 12 response. More...
 
#define LTEIOT12_RSP_RDY   "RDY"
 
#define LTEIOT12_RSP_APPRDY   "APP RDY"
 
#define LTEIOT12_RSP_ERROR   "ERROR"
 
#define LTEIOT12_RSP_START   "$"
 
#define LTEIOT12_RSP_DELIMITER   ","
 
#define LTEIOT12_RSP_GPGGA   "GPGGA"
 
#define LTEIOT12_NMEA_GNGGA   1
 LTE IoT 12 NMEA command elements. More...
 
#define LTEIOT12_NMEA_GPGLL   3
 
#define LTEIOT12_NMEA_GNGGA_NUM_ELEMENT   15
 
#define LTEIOT12_NMEA_GPGLL_NUM_ELEMENT   5
 
#define LTEIOT12_GNGGA_TIME   1
 LTE IoT 12 GNGGA command elements. More...
 
#define LTEIOT12_GNGGA_LATITUDE   2
 
#define LTEIOT12_GNGGA_LATITUDE_SIDE   3
 
#define LTEIOT12_GNGGA_LONGITUDE   4
 
#define LTEIOT12_GNGGA_LONGITUDE_SIDE   5
 
#define LTEIOT12_GNGGA_QUALITY_INDICATOR   6
 
#define LTEIOT12_GNGGA_NUMBER_OF_SATELLITES   7
 
#define LTEIOT12_GNGGA_H_DILUTION_OF_POS   8
 
#define LTEIOT12_GNGGA_ALTITUDE   9
 
#define LTEIOT12_GNGGA_ALTITUDE_UNIT   10
 
#define LTEIOT12_GNGGA_GEOIDAL_SEPARATION   11
 
#define LTEIOT12_GNGGA_GEOIDAL_SEPARATION_UNIT   12
 
#define LTEIOT12_GNGGA_TIME_SINCE_LAST_DGPS   13
 
#define LTEIOT12_GNGGA_DGPS_REFERENCE_STATION_ID   14
 
#define LTEIOT12_PIN_STATE_HIGH   0x01
 LTE IoT 12 pin state. More...
 
#define LTEIOT12_PIN_STATE_LOW   0x00
 
#define LTEIOT12_TX_DRV_BUFFER_SIZE   300
 LTE IoT 12 driver buffer size. More...
 
#define LTEIOT12_RX_DRV_BUFFER_SIZE   300
 
#define LTEIOT12_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  lteiot12_return_value_t { LTEIOT12_OK = 0 , LTEIOT12_ERROR = -1 , LTEIOT12_OWERFLOW = -2 , LTEIOT12_TIMEOUT = -3 }
 LTE IoT 12 Click return value data. More...
 

Functions

void lteiot12_cfg_setup (lteiot12_cfg_t *cfg)
 LTE IoT 12 configuration object setup function. More...
 
err_t lteiot12_init (lteiot12_t *ctx, lteiot12_cfg_t *cfg)
 LTE IoT 12 initialization function. More...
 
err_t lteiot12_generic_write (lteiot12_t *ctx, uint8_t *data_in, uint16_t len)
 LTE IoT 12 data writing function. More...
 
err_t lteiot12_generic_read (lteiot12_t *ctx, uint8_t *data_out, uint16_t len)
 LTE IoT 12 data reading function. More...
 
void lteiot12_set_pwr_pin (lteiot12_t *ctx, uint8_t pin_state)
 LTE IoT 12 set PWR pin function. More...
 
void lteiot12_set_rts_pin (lteiot12_t *ctx, uint8_t pin_state)
 LTE IoT 12 set RTS pin function. More...
 
uint8_t lteiot12_get_cts_pin (lteiot12_t *ctx)
 LTE IoT 12 get cts pin function. More...
 
void lteiot12_hw_reset (lteiot12_t *ctx)
 LTE IoT 12 hardware reset function. More...
 
void lteiot12_send_cmd (lteiot12_t *ctx, char *cmd)
 LTE IoT 12 send command function. More...
 
void lteiot12_send_cmd_with_params (lteiot12_t *ctx, char *at_cmd_buf, char *param_buf)
 LTE IoT 12 send command function with parameter. More...
 
void lteiot12_send_cmd_check (lteiot12_t *ctx, char *at_cmd_buf)
 LTE IoT 12 check the sent command. More...
 
void lteiot12_send_cmd_params_check (lteiot12_t *ctx, char *at_cmd_buf)
 LTE IoT 12 check the command parameters. More...
 
void lteiot12_set_sim_apn (lteiot12_t *ctx, char *sim_apn)
 LTE IoT 12 set sim card APN. More...
 
void lteiot12_send_sms_text_mode (lteiot12_t *ctx, char *phone_number, char *sms_text)
 LTE IoT 12 send SMS in text mode. More...
 
err_t lteiot12_send_sms_pdu (lteiot12_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
 LTE IoT 12 send SMS in PDU mode. More...
 
err_t lteiot12_parse_gngga (char *rsp_buf, uint8_t gngga_element, char *element_data)
 LTE IoT 12 parse GNGGA function. More...
 

Detailed Description

This file contains API for LTE IoT 12 Click Driver.

Enumeration Type Documentation

◆ lteiot12_return_value_t

LTE IoT 12 Click return value data.

Predefined enum values for driver return values.

Enumerator
LTEIOT12_OK 
LTEIOT12_ERROR 
LTEIOT12_OWERFLOW 
LTEIOT12_TIMEOUT