c4glteapj.h File Reference

This file contains API for 4G LTE-APJ 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	c4glteapj_t
	4G LTE-APJ Click context object. More...
struct	c4glteapj_cfg_t
	4G LTE-APJ Click configuration object. More...

Macros
#define	C4GLTEAPJ_CMD_AT   "AT"
	4G LTE-APJ description setting.
#define	C4GLTEAPJ_CMD_ATI   "ATI"
#define	C4GLTEAPJ_CMD_CGMR   "AT+CGMR"
#define	C4GLTEAPJ_CMD_CFUN   "AT+CFUN"
#define	C4GLTEAPJ_CMD_CREG   "AT+CREG"
#define	C4GLTEAPJ_CMD_CGREG   "AT+CGREG"
#define	C4GLTEAPJ_CMD_CGDCONT   "AT+CGDCONT"
#define	C4GLTEAPJ_CMD_CIMI   "AT+CIMI"
#define	C4GLTEAPJ_CMD_CMEE   "AT+CMEE"
#define	C4GLTEAPJ_CMD_CGATT   "AT+CGATT"
#define	C4GLTEAPJ_CMD_CSQ   "AT+CSQ"
#define	C4GLTEAPJ_CMD_COPS   "AT+COPS"
#define	C4GLTEAPJ_CMD_CMGS   "AT+CMGS"
#define	C4GLTEAPJ_CMD_CMGF   "AT+CMGF"
#define	DRV_RX_BUFFER_SIZE   256
	4G LTE-APJ driver buffer size.
#define	DRV_TX_BUFFER_SIZE   256
#define	C4GLTEAPJ_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	c4glteapj_return_value_t { C4GLTEAPJ_OK = 0 , C4GLTEAPJ_ERROR = -1 }
	4G LTE-APJ Click return value data. More...

Functions
void	c4glteapj_cfg_setup (c4glteapj_cfg_t *cfg)
	4G LTE-APJ configuration object setup function.
err_t	c4glteapj_init (c4glteapj_t *ctx, c4glteapj_cfg_t *cfg)
	4G LTE-APJ initialization function.
void	c4glteapj_module_power_on (c4glteapj_t *ctx)
	Power ON the module function.
err_t	c4glteapj_generic_write (c4glteapj_t *ctx, char *data_buf, uint16_t len)
	4G LTE-APJ data writing function.
err_t	c4glteapj_generic_read (c4glteapj_t *ctx, char *data_buf, uint16_t max_len)
	4G LTE-APJ data reading function.
void	c4glteapj_set_rts_pin (c4glteapj_t *ctx, uint8_t state)
	Sets state of the RTS pin.
void	c4glteapj_set_pwk_pin (c4glteapj_t *ctx, uint8_t state)
	Sets state of the PWK pin.
uint8_t	c4glteapj_get_cts_pin (c4glteapj_t *ctx)
	CTS Pin Get function.
uint8_t	c4glteapj_get_sta_pin (c4glteapj_t *ctx)
	STA Pin Get function.
uint8_t	c4glteapj_get_ring_pin (c4glteapj_t *ctx)
	RING Pin Get function.
void	c4glteapj_send_cmd (c4glteapj_t *ctx, char *cmd)
	Send command function.
void	c4glteapj_send_cmd_with_parameter (c4glteapj_t *ctx, char *at_cmd_buf, char *param_buf)
	Send command function with parameter.
void	c4glteapj_send_cmd_check (c4glteapj_t *ctx, char *at_cmd_buf)
	Check the sent command.
void	c4glteapj_set_sim_apn (c4glteapj_t *ctx, char *sim_apn)
	Set sim card APN.
void	c4glteapj_send_sms_text (c4glteapj_t *ctx, char *phone_number, char *sms_text)
	4G LTE-APJ send SMS in text mode.
err_t	c4glteapj_send_sms_pdu (c4glteapj_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
	4G LTE-APJ send SMS in PDU mode.

Detailed Description

This file contains API for 4G LTE-APJ Click Driver.

Enumeration Type Documentation

c4glteapj_return_value_t

enum c4glteapj_return_value_t

4G LTE-APJ Click return value data.

Predefined enum values for driver return values.

Enumerator
C4GLTEAPJ_OK
C4GLTEAPJ_ERROR