anynet3gea 2.0.0.0
anynet3gea.h File Reference

This file contains API for AnyNet 3G-EA 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  anynet3gea_t
 AnyNet 3G-EA Click context object. More...
 
struct  anynet3gea_cfg_t
 AnyNet 3G-EA Click configuration object. More...
 

Macros

#define ANYNET3GEA_CMD_AT   "AT"
 AnyNet 3G-EA control commands.
 
#define ANYNET3GEA_CMD_QCCID   "AT+QCCID"
 
#define ANYNET3GEA_CMD_GSN   "AT+GSN"
 
#define ANYNET3GEA_CMD_AWSVER   "AT+AWSVER"
 
#define ANYNET3GEA_CMD_AWSRESET   "AT+AWSRESET"
 
#define ANYNET3GEA_CMD_AWSSTATE   "AT+AWSSTATE"
 
#define ANYNET3GEA_CMD_AWSBUTTON   "AT+AWSBUTTON"
 
#define ANYNET3GEA_CMD_AWSPUBOPEN   "AT+AWSPUBOPEN"
 
#define ANYNET3GEA_CMD_AWSPUBLISH   "AT+AWSPUBLISH"
 
#define ANYNET3GEA_CMD_AWSSUBOPEN   "AT+AWSSUBOPEN"
 
#define ANYNET3GEA_CMD_AWSPUBCLOSE   "AT+AWSPUBCLOSE"
 
#define ANYNET3GEA_RSP_OK   "OK"
 AnyNet 3G-EA device response for AT commands.
 
#define ANYNET3GEA_RSP_ERROR   "ERROR"
 
#define ANYNET3GEA_RSP_READY_FOR_SEND   ">"
 
#define ANYNET3GEA_RSP_SEND_OK   "SEND OK"
 
#define ANYNET3GEA_RSP_SEND_FAIL   "SEND FAIL"
 
#define ANYNET3GEA_RX_DRV_BUFFER_SIZE   256
 AnyNet 3G-EA driver buffer size.
 
#define ANYNET3GEA_TX_DRV_BUFFER_SIZE   256
 
#define ANYNET3GEA_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  anynet3gea_return_value_t {
  ANYNET3GEA_OK = 0 , ANYNET3GEA_ERROR = -1 , ANYNET3GEA_ERROR_TIMEOUT = -2 , ANYNET3GEA_ERROR_CMD = -3 ,
  ANYNET3GEA_ERROR_SEND = -4 , ANYNET3GEA_ERROR_UNKNOWN = -5
}
 AnyNet 3G-EA Click return value data. More...
 

Functions

void anynet3gea_cfg_setup (anynet3gea_cfg_t *cfg)
 AnyNet 3G-EA configuration object setup function.
 
err_t anynet3gea_init (anynet3gea_t *ctx, anynet3gea_cfg_t *cfg)
 AnyNet 3G-EA initialization function.
 
err_t anynet3gea_generic_write (anynet3gea_t *ctx, uint8_t *data_in, uint16_t len)
 AnyNet 3G-EA data writing function.
 
err_t anynet3gea_generic_read (anynet3gea_t *ctx, uint8_t *data_out, uint16_t len)
 AnyNet 3G-EA data reading function.
 
void anynet3gea_set_slp_pin (anynet3gea_t *ctx, uint8_t state)
 AnyNet 3G-EA set slp pin function.
 
void anynet3gea_set_dtr_pin (anynet3gea_t *ctx, uint8_t state)
 AnyNet 3G-EA set dtr pin function.
 
void anynet3gea_set_iot_pin (anynet3gea_t *ctx, uint8_t state)
 AnyNet 3G-EA set iot pin function.
 
uint8_t anynet3gea_get_dsr_pin (anynet3gea_t *ctx)
 AnyNet 3G-EA get dsr pin function.
 
void anynet3gea_send_cmd (anynet3gea_t *ctx, uint8_t *cmd)
 Send command function.
 
void anynet3gea_send_cmd_with_par (anynet3gea_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
 Send command function with parameter.
 
void anynet3gea_send_cmd_check (anynet3gea_t *ctx, uint8_t *at_cmd_buf)
 Check the sent command.
 
void anynet3gea_send_cmd_par_check (anynet3gea_t *ctx, uint8_t *at_cmd_buf)
 Check the command parameters.
 

Detailed Description

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

Enumeration Type Documentation

◆ anynet3gea_return_value_t

AnyNet 3G-EA Click return value data.

Predefined enum values for driver return values.

Enumerator
ANYNET3GEA_OK 
ANYNET3GEA_ERROR 
ANYNET3GEA_ERROR_TIMEOUT 
ANYNET3GEA_ERROR_CMD 
ANYNET3GEA_ERROR_SEND 
ANYNET3GEA_ERROR_UNKNOWN