lteiot12 2.2.0
Loading...
Searching...
No Matches
lteiot12.h File Reference

This file contains API for LTE IoT 12 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  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.
#define LTEIOT12_CMD_GET_MODEL_ID   "AT+CGMM"
#define LTEIOT12_CMD_GET_SW_VERSION   "AT+CGMR"
#define LTEIOT12_CMD_GET_SERIAL_NUM   "AT+CGSN"
#define LTEIOT12_CMD_FACTORY_RESET   "AT&F"
#define LTEIOT12_CMD_SET_UE_FUNCTIONALITY   "AT+CFUN"
#define LTEIOT12_CMD_NETWORK_REGISTRATION   "AT+CREG"
#define LTEIOT12_CMD_SIGNAL_QUALITY_REPORT   "AT+CSQ"
#define LTEIOT12_CMD_OPERATOR_SELECTION   "AT+COPS"
#define LTEIOT12_CMD_SEND_SMS   "AT+CMGS"
#define LTEIOT12_CMD_SELECT_SMS_FORMAT   "AT+CMGF"
#define LTEIOT12_CMD_DEFINE_PDP_CONTEXT   "AT+CGDCONT"
#define LTEIOT12_CMD_SHOW_PDP_ADDRESS   "AT+CGPADDR"
#define LTEIOT12_CMD_PSM_SETTING   "AT+CPSMS"
#define LTEIOT12_CMD_ACTIVATE_PDP_CONTEXT   "AT+QIACT"
#define LTEIOT12_CMD_OPEN_SOCKET   "AT+QIOPEN"
#define LTEIOT12_CMD_CLOSE_SOCKET   "AT+QICLOSE"
#define LTEIOT12_CMD_SEND_DATA   "AT+QISEND"
#define LTEIOT12_CMD_RECEIVE_DATA   "AT+QIRD"
#define LTEIOT12_CMD_EXTENDED_CONFIG   "AT+QCFG"
#define LTEIOT12_CMD_TURN_ON_GNSS   "AT+QGPS"
#define LTEIOT12_CMD_ACQUIRE_NMEA_SENTENCES   "AT+QGPSGNMEA"
#define LTEIOT12_RSP_OK   "OK"
 LTE IoT 12 device response for AT commands.
#define LTEIOT12_RSP_ERROR   "ERROR"
#define LTEIOT12_URC_RECEIVED_DATA   "+QIURC:"
 LTE IoT 12 device unsolicited response code (URC) settings.
#define LTEIOT12_URC_OPEN_SOCKET   "+QIOPEN:"
#define LTEIOT12_RSP_START   "$"
 LTE IoT 12 response buffer commands.
#define LTEIOT12_RSP_DELIMITER   ","
#define LTEIOT12_RSP_END   "\r\n"
#define LTEIOT12_RSP_GGA   "GGA"
#define LTEIOT12_POWER_STATE_OFF   0
 LTE IoT 12 power state settings.
#define LTEIOT12_POWER_STATE_ON   1
#define LTEIOT12_GGA_ELEMENT_SIZE   15
 LTE IoT 12 GGA command elements.
#define LTEIOT12_GGA_TIME   1
#define LTEIOT12_GGA_LATITUDE   2
#define LTEIOT12_GGA_LATITUDE_SIDE   3
#define LTEIOT12_GGA_LONGITUDE   4
#define LTEIOT12_GGA_LONGITUDE_SIDE   5
#define LTEIOT12_GGA_QUALITY_INDICATOR   6
#define LTEIOT12_GGA_NUMBER_OF_SATELLITES   7
#define LTEIOT12_GGA_H_DILUTION_OF_POS   8
#define LTEIOT12_GGA_ALTITUDE   9
#define LTEIOT12_GGA_ALTITUDE_UNIT   10
#define LTEIOT12_GGA_GEOIDAL_SEPARATION   11
#define LTEIOT12_GGA_GEOIDAL_SEPARATION_UNIT   12
#define LTEIOT12_GGA_TIME_SINCE_LAST_DGPS   13
#define LTEIOT12_GGA_DGPS_REFERENCE_STATION_ID   14
#define LTEIOT12_TX_DRV_BUFFER_SIZE   256
 LTE IoT 12 driver buffer size.
#define LTEIOT12_RX_DRV_BUFFER_SIZE   256
#define LTEIOT12_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  lteiot12_return_value_t {
  LTEIOT12_OK = 0 , LTEIOT12_ERROR = -1 , LTEIOT12_ERROR_TIMEOUT = -2 , LTEIOT12_ERROR_CMD = -3 ,
  LTEIOT12_ERROR_UNKNOWN = -4
}
 LTE IoT 12 Click return value data. More...

Functions

void lteiot12_cfg_setup (lteiot12_cfg_t *cfg)
 LTE IoT 12 configuration object setup function.
err_t lteiot12_init (lteiot12_t *ctx, lteiot12_cfg_t *cfg)
 LTE IoT 12 initialization function.
err_t lteiot12_generic_write (lteiot12_t *ctx, uint8_t *data_in, uint16_t len)
 LTE IoT 12 data writing function.
err_t lteiot12_generic_read (lteiot12_t *ctx, uint8_t *data_out, uint16_t len)
 LTE IoT 12 data reading function.
void lteiot12_set_pwr_pin (lteiot12_t *ctx, uint8_t state)
 LTE IoT 12 set PWR pin function.
void lteiot12_set_rts_pin (lteiot12_t *ctx, uint8_t state)
 LTE IoT 12 set RTS pin function.
uint8_t lteiot12_get_sta_pin (lteiot12_t *ctx)
 LTE IoT 12 get STA pin function.
uint8_t lteiot12_get_ring_pin (lteiot12_t *ctx)
 LTE IoT 12 get RING pin function.
uint8_t lteiot12_get_cts_pin (lteiot12_t *ctx)
 LTE IoT 12 get CTS pin function.
void lteiot12_set_power_state (lteiot12_t *ctx, uint8_t state)
 LTE IoT 12 set power state function.
void lteiot12_cmd_run (lteiot12_t *ctx, uint8_t *cmd)
 LTE IoT 12 cmd run function.
void lteiot12_cmd_set (lteiot12_t *ctx, uint8_t *cmd, uint8_t *value)
 LTE IoT 12 cmd set function.
void lteiot12_cmd_get (lteiot12_t *ctx, uint8_t *cmd)
 LTE IoT 12 cmd get function.
void lteiot12_cmd_help (lteiot12_t *ctx, uint8_t *cmd)
 LTE IoT 12 cmd help function.
void lteiot12_set_sim_apn (lteiot12_t *ctx, uint8_t *sim_apn)
 LTE IoT 12 set SIM card APN function.
void lteiot12_send_sms_text (lteiot12_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
 LTE IoT 12 send SMS in text mode function.
err_t lteiot12_send_sms_pdu (lteiot12_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
 LTE IoT 12 send SMS in PDU mode function.
err_t lteiot12_parse_gga (uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
 LTE IoT 12 parse GGA function.

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_ERROR_TIMEOUT 
LTEIOT12_ERROR_CMD 
LTEIOT12_ERROR_UNKNOWN