c3gaa  2.0.0.0
Data Structures | Macros | Enumerations | Functions
c3gaa.h File Reference

This file contains API for 3G-AA 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  c3gaa_t
 3G-AA Click context object. More...
 
struct  c3gaa_cfg_t
 3G-AA Click configuration object. More...
 

Macros

#define C3GAA_MODULE_POWER_ON   1
 3G-AA module power. More...
 
#define C3GAA_MODULE_POWER_OFF   0
 
#define C3GAA_CMD_AT   "AT"
 3G-AA description setting. More...
 
#define C3GAA_CMD_ATI   "ATI"
 
#define C3GAA_CMD_CGMR   "AT+CGMR"
 
#define C3GAA_CMD_CFUN   "AT+CFUN"
 
#define C3GAA_CMD_CREG   "AT+CREG"
 
#define C3GAA_CMD_CGREG   "AT+CGREG"
 
#define C3GAA_CMD_CGDCONT   "AT+CGDCONT"
 
#define C3GAA_CMD_CIMI   "AT+CIMI"
 
#define C3GAA_CMD_CMEE   "AT+CMEE"
 
#define C3GAA_CMD_CGATT   "AT+CGATT"
 
#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 DRV_RX_BUFFER_SIZE   256
 3G-AA driver buffer size. More...
 
#define DRV_TX_BUFFER_SIZE   256
 
#define C3GAA_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  c3gaa_return_value_t { C3GAA_OK = 0, C3GAA_ERROR = -1 }
 3G-AA Click return value data. More...
 

Functions

void c3gaa_cfg_setup (c3gaa_cfg_t *cfg)
 3G-AA configuration object setup function. More...
 
err_t c3gaa_init (c3gaa_t *ctx, c3gaa_cfg_t *cfg)
 3G-AA initialization function. More...
 
void c3gaa_module_power (c3gaa_t *ctx, uint8_t state)
 Power ON/OFF the module. More...
 
err_t c3gaa_generic_write (c3gaa_t *ctx, char *data_buf, uint16_t len)
 3G-AA data writing function. More...
 
err_t c3gaa_generic_read (c3gaa_t *ctx, char *data_buf, uint16_t max_len)
 3G-AA data reading function. More...
 
void c3gaa_set_rts_pin (c3gaa_t *ctx, uint8_t state)
 Sets state of the RTS pin. More...
 
void c3gaa_set_pwk_pin (c3gaa_t *ctx, uint8_t state)
 Sets state of the PWK pin. More...
 
uint8_t c3gaa_get_cts_pin (c3gaa_t *ctx)
 CTS Pin Get function. More...
 
uint8_t c3gaa_get_sta_pin (c3gaa_t *ctx)
 STA Pin Get function. More...
 
uint8_t c3gaa_get_ring_pin (c3gaa_t *ctx)
 RING Pin Get function. More...
 
void c3gaa_send_cmd (c3gaa_t *ctx, char *cmd)
 Send command function. More...
 
void c3gaa_send_cmd_with_parameter (c3gaa_t *ctx, char *at_cmd_buf, char *param_buf)
 Send command function with parameter. More...
 
void c3gaa_send_cmd_check (c3gaa_t *ctx, char *at_cmd_buf)
 Check the sent command. More...
 
void c3gaa_send_cmd_parameter_check (c3gaa_t *ctx, char *at_cmd_buf)
 Check the command parameters. More...
 
void c3gaa_set_sim_apn (c3gaa_t *ctx, char *sim_apn)
 Set sim card APN. More...
 
void c3gaa_send_sms_text (c3gaa_t *ctx, char *phone_number, char *sms_text)
 3G-AA send SMS in text mode. More...
 
err_t c3gaa_send_sms_pdu (c3gaa_t *ctx, char *service_center_number, char *phone_number, char *sms_text)
 3G-AA send SMS in PDU mode. More...
 

Detailed Description

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

Enumeration Type Documentation

◆ c3gaa_return_value_t

3G-AA Click return value data.

Predefined enum values for driver return values.

Enumerator
C3GAA_OK 
C3GAA_ERROR