anynet3gaa 2.0.0.0
anynet3gaa.h File Reference

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

Macros

#define ANYNET3GAA_CMD_AT   "AT"
 AnyNet 3G-AA control commands.
 
#define ANYNET3GAA_CMD_QCCID   "AT+QCCID"
 
#define ANYNET3GAA_CMD_GSN   "AT+GSN"
 
#define ANYNET3GAA_CMD_AWSVER   "AT+AWSVER"
 
#define ANYNET3GAA_CMD_AWSRESET   "AT+AWSRESET"
 
#define ANYNET3GAA_CMD_AWSSTATE   "AT+AWSSTATE"
 
#define ANYNET3GAA_CMD_AWSBUTTON   "AT+AWSBUTTON"
 
#define ANYNET3GAA_CMD_AWSPUBOPEN   "AT+AWSPUBOPEN"
 
#define ANYNET3GAA_CMD_AWSPUBLISH   "AT+AWSPUBLISH"
 
#define ANYNET3GAA_CMD_AWSSUBOPEN   "AT+AWSSUBOPEN"
 
#define ANYNET3GAA_CMD_AWSPUBCLOSE   "AT+AWSPUBCLOSE"
 
#define ANYNET3GAA_RSP_OK   "OK"
 AnyNet 3G-AA device response for AT commands.
 
#define ANYNET3GAA_RSP_ERROR   "ERROR"
 
#define ANYNET3GAA_RSP_READY_FOR_SEND   ">"
 
#define ANYNET3GAA_RSP_SEND_OK   "SEND OK"
 
#define ANYNET3GAA_RSP_SEND_FAIL   "SEND FAIL"
 
#define ANYNET3GAA_RX_DRV_BUFFER_SIZE   256
 AnyNet 3G-AA driver buffer size.
 
#define ANYNET3GAA_TX_DRV_BUFFER_SIZE   256
 
#define ANYNET3GAA_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  anynet3gaa_return_value_t {
  ANYNET3GAA_OK = 0 , ANYNET3GAA_ERROR = -1 , ANYNET3GAA_ERROR_TIMEOUT = -2 , ANYNET3GAA_ERROR_CMD = -3 ,
  ANYNET3GAA_ERROR_SEND = -4 , ANYNET3GAA_ERROR_UNKNOWN = -5
}
 AnyNet 3G-AA Click return value data. More...
 

Functions

void anynet3gaa_cfg_setup (anynet3gaa_cfg_t *cfg)
 AnyNet 3G-AA configuration object setup function.
 
err_t anynet3gaa_init (anynet3gaa_t *ctx, anynet3gaa_cfg_t *cfg)
 AnyNet 3G-AA initialization function.
 
err_t anynet3gaa_generic_write (anynet3gaa_t *ctx, uint8_t *data_in, uint16_t len)
 AnyNet 3G-AA data writing function.
 
err_t anynet3gaa_generic_read (anynet3gaa_t *ctx, uint8_t *data_out, uint16_t len)
 AnyNet 3G-AA data reading function.
 
void anynet3gaa_set_slp_pin (anynet3gaa_t *ctx, uint8_t state)
 AnyNet 3G-AA set slp pin function.
 
void anynet3gaa_set_dtr_pin (anynet3gaa_t *ctx, uint8_t state)
 AnyNet 3G-AA set dtr pin function.
 
void anynet3gaa_set_iot_pin (anynet3gaa_t *ctx, uint8_t state)
 AnyNet 3G-AA set iot pin function.
 
uint8_t anynet3gaa_get_dsr_pin (anynet3gaa_t *ctx)
 AnyNet 3G-AA get dsr pin function.
 
void anynet3gaa_send_cmd (anynet3gaa_t *ctx, uint8_t *cmd)
 Send command function.
 
void anynet3gaa_send_cmd_with_par (anynet3gaa_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
 Send command function with parameter.
 
void anynet3gaa_send_cmd_check (anynet3gaa_t *ctx, uint8_t *at_cmd_buf)
 Check the sent command.
 
void anynet3gaa_send_cmd_par_check (anynet3gaa_t *ctx, uint8_t *at_cmd_buf)
 Check the command parameters.
 

Detailed Description

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

Enumeration Type Documentation

◆ anynet3gaa_return_value_t

AnyNet 3G-AA Click return value data.

Predefined enum values for driver return values.

Enumerator
ANYNET3GAA_OK 
ANYNET3GAA_ERROR 
ANYNET3GAA_ERROR_TIMEOUT 
ANYNET3GAA_ERROR_CMD 
ANYNET3GAA_ERROR_SEND 
ANYNET3GAA_ERROR_UNKNOWN