This file contains API for 3G-AA Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Data Structures
struct	c3gaa_t
	3G-AA Click context object. More...

struct	c3gaa_cfg_t
	3G-AA Click configuration object. More...

Macros
#define	C3GAA_CMD_AT "AT"
	3G-AA control commands.

#define	C3GAA_CMD_ATI "ATI"

#define	C3GAA_CMD_CFUN "AT+CFUN"

#define	C3GAA_CMD_CREG "AT+CREG"

#define	C3GAA_CMD_CGDCONT "AT+CGDCONT"

#define	C3GAA_CMD_CSQ "AT+CSQ"

#define	C3GAA_CMD_COPS "AT+COPS"

#define	C3GAA_CMD_CMGS "AT+CMGS"

#define	C3GAA_CMD_CMGF "AT+CMGF"

#define	C3GAA_CMD_QIACT "AT+QIACT"

#define	C3GAA_CMD_QIOPEN "AT+QIOPEN"

#define	C3GAA_CMD_QICLOSE "AT+QICLOSE"

#define	C3GAA_CMD_QISEND "AT+QISEND"

#define	C3GAA_CMD_QIRD "AT+QIRD"

#define	C3GAA_RSP_OK "OK"
	3G-AA device response for AT commands.

#define	C3GAA_RSP_ERROR "ERROR"

#define	C3GAA_RX_DRV_BUFFER_SIZE 256
	3G-AA driver buffer size.

#define	C3GAA_TX_DRV_BUFFER_SIZE 256

#define	C3GAA_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	c3gaa_return_value_t { C3GAA_OK = 0 , C3GAA_ERROR = -1 , C3GAA_ERROR_TIMEOUT = -2 , C3GAA_ERROR_CMD = -3 , C3GAA_ERROR_UNKNOWN = -4 }
	3G-AA Click return value data. More...

Functions
void	c3gaa_cfg_setup (c3gaa_cfg_t *cfg)
	3G-AA configuration object setup function.

err_t	c3gaa_init (c3gaa_t ctx, c3gaa_cfg_t cfg)
	3G-AA initialization function.

err_t	c3gaa_generic_write (c3gaa_t ctx, uint8_t data_in, uint16_t len)
	3G-AA data writing function.

err_t	c3gaa_generic_read (c3gaa_t ctx, uint8_t data_out, uint16_t len)
	3G-AA data reading function.

void	c3gaa_set_rts_pin (c3gaa_t *ctx, uint8_t state)
	3G-AA set rts pin function.

void	c3gaa_set_pwk_pin (c3gaa_t *ctx, uint8_t state)
	3G-AA set pwk pin function.

uint8_t	c3gaa_get_cts_pin (c3gaa_t *ctx)
	3G-AA get cts pin function.

uint8_t	c3gaa_get_sta_pin (c3gaa_t *ctx)
	3G-AA get sta pin function.

uint8_t	c3gaa_get_ring_pin (c3gaa_t *ctx)
	3G-AA get ring pin function.

void	c3gaa_send_cmd (c3gaa_t ctx, uint8_t cmd)
	Send command function.

void	c3gaa_send_cmd_with_par (c3gaa_t ctx, uint8_t at_cmd_buf, uint8_t *param_buf)
	Send command function with parameter.

void	c3gaa_send_cmd_check (c3gaa_t ctx, uint8_t at_cmd_buf)
	Check the sent command.

void	c3gaa_send_cmd_par_check (c3gaa_t ctx, uint8_t at_cmd_buf)
	Check the command parameters.

void	c3gaa_set_sim_apn (c3gaa_t ctx, uint8_t sim_apn)
	Set sim card APN.

void	c3gaa_send_sms_text (c3gaa_t ctx, uint8_t phone_number, uint8_t *sms_text)
	3G-AA send SMS in text mode.

err_t	c3gaa_send_sms_pdu (c3gaa_t ctx, uint8_t service_center_number, uint8_t phone_number, uint8_t sms_text)
	3G-AA send SMS in PDU mode.

Detailed Description

This file contains API for 3G-AA Click Driver.

Enumeration Type Documentation

3G-AA Click return value data.

Predefined enum values for driver return values.