lteiot6.h File Reference

This file contains API for LTE IoT 6 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	lteiot6_t
	LTE IoT 6 Click context object. More...
struct	lteiot6_cfg_t
	LTE IoT 6 Click configuration object. More...

Macros
#define	LTEIOT6_CMD_AT   "AT"
	LTE IoT 6 description commands.
#define	LTEIOT6_CMD_ATI   "ATI"
#define	LTEIOT6_CMD_CGMR   "AT+CGMR"
#define	LTEIOT6_CMD_CFUN   "AT+CFUN"
#define	LTEIOT6_CMD_CREG   "AT+CREG"
#define	LTEIOT6_CMD_CEREG   "AT+CEREG"
#define	LTEIOT6_CMD_CGDCONT   "AT+CGDCONT"
#define	LTEIOT6_CMD_CIMI   "AT+CIMI"
#define	LTEIOT6_CMD_CGATT   "AT+CGATT"
#define	LTEIOT6_CMD_CSQ   "AT+CSQ"
#define	LTEIOT6_CMD_CESQ   "AT+CESQ"
#define	LTEIOT6_CMD_COPS   "AT+COPS"
#define	LTEIOT6_CMD_CMGF   "AT+CMGF"
#define	LTEIOT6_CMD_CMGS   "AT+CMGS"
#define	LTEIOT6_CMD_CSCA   "AT+CSCA"
#define	LTEIOT6_CMD_SQNLED   "AT+SQNLED"
#define	LTEIOT6_RSP_OK   "OK"
	LTE IoT 6 description setting.
#define	LTEIOT6_RSP_ERROR   "ERROR"
#define	LTEIOT6_RSP_SYSTART   "+SYSSTART"
#define	DRV_BUFFER_SIZE   400
	LTE IoT 6 driver buffer size.
#define	LTEIOT6_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	lteiot8_return_value_t {   LTEIOT6_OK = 0 , LTEIOT6_ERROR = -1 , LTEIOT6_ERROR_TIMEOUT = -2 , LTEIOT6_ERROR_CMD = -3 ,   LTEIOT6_ERROR_UNKNOWN = -4 }
	LTE IoT 6 Click return value data. More...

Functions
void	lteiot6_cfg_setup (lteiot6_cfg_t *cfg)
	LTE IoT 6 configuration object setup function.
err_t	lteiot6_init (lteiot6_t *ctx, lteiot6_cfg_t *cfg)
	LTE IoT 6 initialization function.
err_t	lteiot6_generic_write (lteiot6_t *ctx, char *data_buf, uint16_t len)
	LTE IoT 6 data writing function.
err_t	lteiot6_generic_read (lteiot6_t *ctx, char *data_buf, uint16_t max_len)
	LTE IoT 6 data reading function.
void	lteiot6_power_on (lteiot6_t *ctx)
	LTE IoT 6 power on.
void	lteiot6_reset (lteiot6_t *ctx)
	LTE IoT 6 power on.
void	lteiot6_set_pwr (lteiot6_t *ctx, uint8_t state)
	Sets state of the PWR pin.
void	lteiot6_set_rst (lteiot6_t *ctx, uint8_t state)
	Sets state of the RST pin.
void	lteiot6_set_rts (lteiot6_t *ctx, uint8_t state)
	Sets state of the RTS pin.
uint8_t	lteiot6_get_ri (lteiot6_t *ctx)
	RI Pin Get function.
uint8_t	lteiot6_get_cts (lteiot6_t *ctx)
	CTS Pin Get function.
void	lteiot6_send_cmd (lteiot6_t *ctx, char *cmd)
	Send command function.
void	lteiot6_send_cmd_with_parameter (lteiot6_t *ctx, char *at_cmd_buf, char *param_buf)
	Send command function with parameter.
void	lteiot6_send_cmd_check (lteiot6_t *ctx, char *at_cmd_buf)
	Check the sent command.
void	lteiot6_send_cmd_parameter_check (lteiot6_t *ctx, char *at_cmd_buf)
	Check the command parameters.
void	lteiot6_set_sim_apn (lteiot6_t *ctx, char *sim_apn)
	Set sim card APN.
void	lteiot6_send_text_message (lteiot6_t *ctx, char *phone_number, char *message_content)
	Send SMS message to number in text mode.
err_t	lteiot6_send_sms_pdu (lteiot6_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
	Send SMS message to number in pdu mode.

Detailed Description

This file contains API for LTE IoT 6 Click Driver.

Enumeration Type Documentation

lteiot8_return_value_t

enum lteiot8_return_value_t

LTE IoT 6 Click return value data.

Predefined enum values for driver return values.

Enumerator
LTEIOT6_OK
LTEIOT6_ERROR
LTEIOT6_ERROR_TIMEOUT
LTEIOT6_ERROR_CMD
LTEIOT6_ERROR_UNKNOWN