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

This file contains API for AnyNet 2G Click Driver. More...

#include "mikrosdk_version.h"
#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  anynet2g_t
 AnyNet 2G Click context object. More...
 
struct  anynet2g_cfg_t
 AnyNet 2G Click configuration object. More...
 

Macros

#define ANYNET2G_CMD_AT   "AT"
 AnyNet 2G control commands. More...
 
#define ANYNET2G_CMD_QCCID   "AT+QCCID"
 
#define ANYNET2G_CMD_GSN   "AT+GSN"
 
#define ANYNET2G_CMD_AWSVER   "AT+AWSVER"
 
#define ANYNET2G_CMD_AWSRESET   "AT+AWSRESET"
 
#define ANYNET2G_CMD_AWSSTATE   "AT+AWSSTATE"
 
#define ANYNET2G_CMD_AWSBUTTON   "AT+AWSBUTTON"
 
#define ANYNET2G_CMD_AWSPUBOPEN   "AT+AWSPUBOPEN"
 
#define ANYNET2G_CMD_AWSPUBLISH   "AT+AWSPUBLISH"
 
#define ANYNET2G_CMD_AWSSUBOPEN   "AT+AWSSUBOPEN"
 
#define ANYNET2G_CMD_AWSPUBCLOSE   "AT+AWSPUBCLOSE"
 
#define ANYNET2G_RSP_OK   "OK"
 AnyNet 2G device response for AT commands. More...
 
#define ANYNET2G_RSP_ERROR   "ERROR"
 
#define ANYNET2G_RSP_READY_FOR_SEND   ">"
 
#define ANYNET2G_RSP_SEND_OK   "SEND OK"
 
#define ANYNET2G_RSP_SEND_FAIL   "SEND FAIL"
 
#define ANYNET2G_RX_DRV_BUFFER_SIZE   256
 AnyNet 2G driver buffer size. More...
 
#define ANYNET2G_TX_DRV_BUFFER_SIZE   256
 
#define ANYNET2G_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  anynet2g_return_value_t {
  ANYNET2G_OK = 0, ANYNET2G_ERROR = -1, ANYNET2G_ERROR_TIMEOUT = -2, ANYNET2G_ERROR_CMD = -3,
  ANYNET2G_ERROR_SEND = -4, ANYNET2G_ERROR_UNKNOWN = -5
}
 AnyNet 2G Click return value data. More...
 

Functions

void anynet2g_cfg_setup (anynet2g_cfg_t *cfg)
 AnyNet 2G configuration object setup function. More...
 
err_t anynet2g_init (anynet2g_t *ctx, anynet2g_cfg_t *cfg)
 AnyNet 2G initialization function. More...
 
err_t anynet2g_generic_write (anynet2g_t *ctx, uint8_t *data_in, uint16_t len)
 AnyNet 2G data writing function. More...
 
err_t anynet2g_generic_read (anynet2g_t *ctx, uint8_t *data_out, uint16_t len)
 AnyNet 2G data reading function. More...
 
void anynet2g_set_slp_pin (anynet2g_t *ctx, uint8_t state)
 AnyNet 2G set slp pin function. More...
 
void anynet2g_set_dtr_pin (anynet2g_t *ctx, uint8_t state)
 AnyNet 2G set dtr pin function. More...
 
void anynet2g_set_iot_pin (anynet2g_t *ctx, uint8_t state)
 AnyNet 2G set iot pin function. More...
 
uint8_t anynet2g_get_dsr_pin (anynet2g_t *ctx)
 AnyNet 2G get dsr pin function. More...
 
void anynet2g_send_cmd (anynet2g_t *ctx, uint8_t *cmd)
 Send command function. More...
 
void anynet2g_send_cmd_with_par (anynet2g_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf)
 Send command function with parameter. More...
 
void anynet2g_send_cmd_check (anynet2g_t *ctx, uint8_t *at_cmd_buf)
 Check the sent command. More...
 
void anynet2g_send_cmd_par_check (anynet2g_t *ctx, uint8_t *at_cmd_buf)
 Check the command parameters. More...
 

Detailed Description

This file contains API for AnyNet 2G Click Driver.

Enumeration Type Documentation

◆ anynet2g_return_value_t

AnyNet 2G Click return value data.

Predefined enum values for driver return values.

Enumerator
ANYNET2G_OK 
ANYNET2G_ERROR 
ANYNET2G_ERROR_TIMEOUT 
ANYNET2G_ERROR_CMD 
ANYNET2G_ERROR_SEND 
ANYNET2G_ERROR_UNKNOWN