lteiot3.h File Reference

This file contains API for LTE IoT 3 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	lteiot3_t
	LTE IoT 3 Click context object. More...
struct	lteiot3_cfg_t
	LTE IoT 3 Click configuration object. More...

Macros
#define	LTEIOT3_CMD_AT   "AT"
	LTE IoT 3 control commands.
#define	LTEIOT3_CMD_ATI   "ATI"
#define	LTEIOT3_CMD_CFUN   "AT+CFUN"
#define	LTEIOT3_CMD_CREG   "AT+CREG"
#define	LTEIOT3_CMD_CGDCONT   "AT+CGDCONT"
#define	LTEIOT3_CMD_CESQ   "AT+CESQ"
#define	LTEIOT3_CMD_COPS   "AT+COPS"
#define	LTEIOT3_CMD_CMGS   "AT+CMGS"
#define	LTEIOT3_CMD_CMGF   "AT+CMGF"
#define	LTEIOT3_CMD_CGPADDR   "AT+CGPADDR"
#define	LTEIOT3_CMD_SICA   "AT^SICA"
#define	LTEIOT3_CMD_SISS   "AT^SISS"
#define	LTEIOT3_CMD_SISO   "AT^SISO"
#define	LTEIOT3_CMD_SISW   "AT^SISW"
#define	LTEIOT3_CMD_SISR   "AT^SISR"
#define	LTEIOT3_CMD_SISC   "AT^SISC"
#define	LTEIOT3_CMD_SGPSC   "AT^SGPSC"
#define	LTEIOT3_RSP_OK   "OK"
	LTE IoT 3 device response for AT commands.
#define	LTEIOT3_RSP_ERROR   "ERROR"
#define	LTEIOT3_RSP_SYSSTART   "^SYSSTART"
#define	LTEIOT3_POWER_STATE_SWITCH   0
	LTE IoT 3 power state settings.
#define	LTEIOT3_POWER_STATE_ON   1
#define	LTEIOT3_POWER_STATE_REBOOT   2
#define	LTEIOT3_RSP_START   "$"
	LTE IoT 3 response buffer commands.
#define	LTEIOT3_RSP_DELIMITER   ","
#define	LTEIOT3_RSP_END   "\r\n"
#define	LTEIOT3_RSP_GGA   "GGA"
#define	LTEIOT3_GGA_ELEMENT_SIZE   15
	LTE IoT 3 GGA command elements.
#define	LTEIOT3_GGA_TIME   1
#define	LTEIOT3_GGA_LATITUDE   2
#define	LTEIOT3_GGA_LATITUDE_SIDE   3
#define	LTEIOT3_GGA_LONGITUDE   4
#define	LTEIOT3_GGA_LONGITUDE_SIDE   5
#define	LTEIOT3_GGA_QUALITY_INDICATOR   6
#define	LTEIOT3_GGA_NUMBER_OF_SATELLITES   7
#define	LTEIOT3_GGA_H_DILUTION_OF_POS   8
#define	LTEIOT3_GGA_ALTITUDE   9
#define	LTEIOT3_GGA_ALTITUDE_UNIT   10
#define	LTEIOT3_GGA_GEOIDAL_SEPARATION   11
#define	LTEIOT3_GGA_GEOIDAL_SEPARATION_UNIT   12
#define	LTEIOT3_GGA_TIME_SINCE_LAST_DGPS   13
#define	LTEIOT3_GGA_DGPS_REFERENCE_STATION_ID   14
#define	LTEIOT3_RX_DRV_BUFFER_SIZE   256
	LTE IoT 3 driver buffer size.
#define	LTEIOT3_TX_DRV_BUFFER_SIZE   256
#define	LTEIOT3_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	lteiot3_return_value_t {   LTEIOT3_OK = 0 , LTEIOT3_ERROR = -1 , LTEIOT3_ERROR_TIMEOUT = -2 , LTEIOT3_ERROR_CMD = -3 ,   LTEIOT3_ERROR_UNKNOWN = -4 }
	LTE IoT 3 Click return value data. More...

Functions
void	lteiot3_cfg_setup (lteiot3_cfg_t *cfg)
	LTE IoT 3 configuration object setup function.
err_t	lteiot3_init (lteiot3_t *ctx, lteiot3_cfg_t *cfg)
	LTE IoT 3 initialization function.
err_t	lteiot3_generic_write (lteiot3_t *ctx, uint8_t *data_in, uint16_t len)
	LTE IoT 3 data writing function.
err_t	lteiot3_generic_read (lteiot3_t *ctx, uint8_t *data_out, uint16_t len)
	LTE IoT 3 data reading function.
void	lteiot3_set_on_pin (lteiot3_t *ctx, uint8_t state)
	LTE IoT 3 set on pin function.
void	lteiot3_set_rts_pin (lteiot3_t *ctx, uint8_t state)
	LTE IoT 3 set rts pin function.
void	lteiot3_set_cs_pin (lteiot3_t *ctx, uint8_t state)
	LTE IoT 3 set cs pin function.
uint8_t	lteiot3_get_smi_pin (lteiot3_t *ctx)
	LTE IoT 3 get smi pin function.
uint8_t	lteiot3_get_cts_pin (lteiot3_t *ctx)
	LTE IoT 3 get cts pin function.
void	lteiot3_send_cmd (lteiot3_t *ctx, uint8_t *cmd)
	Send command function.
void	lteiot3_send_cmd_with_parameter (lteiot3_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
	Send command function with parameter.
void	lteiot3_send_cmd_check (lteiot3_t *ctx, uint8_t *at_cmd_buf)
	Check the sent command.
void	lteiot3_send_cmd_parameter_check (lteiot3_t *ctx, uint8_t *at_cmd_buf)
	Check the command parameters.
void	lteiot3_set_sim_apn (lteiot3_t *ctx, uint8_t *sim_apn)
	Set sim card APN.
void	lteiot3_send_sms_text (lteiot3_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
	LTE IoT 3 send SMS in text mode.
err_t	lteiot3_send_sms_pdu (lteiot3_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
	LTE IoT 3 send SMS in PDU mode.
err_t	lteiot3_parse_gga (uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data)
	LTE IoT 3 parse GGA function.

Detailed Description

This file contains API for LTE IoT 3 Click Driver.

Enumeration Type Documentation

lteiot3_return_value_t

enum lteiot3_return_value_t

LTE IoT 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
LTEIOT3_OK
LTEIOT3_ERROR
LTEIOT3_ERROR_TIMEOUT
LTEIOT3_ERROR_CMD
LTEIOT3_ERROR_UNKNOWN