This file contains API for G2C 3G Click Driver. More...

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

Data Structures
struct	g2c3g_t
	G2C 3G Click context object. More...

struct	g2c3g_cfg_t
	G2C 3G Click configuration object. More...

Macros
#define	G2C3G_CMD_AT "AT"
	G2C 3G control commands.

#define	G2C3G_CMD_GMR "AT+GMR"

#define	G2C3G_CMD_ATE1 "ATE1"

#define	G2C3G_CMD_ATE0 "ATE0"

#define	G2C3G_CMD_GMSTA "AT+GMSTA"

#define	G2C3G_CMD_RST "AT+RST"

#define	G2C3G_CMD_CRST "AT+CRST"

#define	G2C3G_CMD_CEN "AT+CEN"

#define	G2C3G_CMD_GPEN "AT+GPEN"

#define	G2C3G_CMD_W "AT+W"

#define	G2C3G_CMD_R "AT+R"

#define	G2C3G_CMD_NWCR "AT+NWCR"

#define	G2C3G_CMD_NWC "AT+NWC"

#define	G2C3G_CMD_BRCR "AT+BRCR"

#define	G2C3G_CMD_BRC "AT+BRC"

#define	G2C3G_CMD_LRSP "AT+LRSP"

#define	G2C3G_CMD_DSET "AT+DSET"

#define	G2C3G_CMD_PUB "AT+PUB"

#define	G2C3G_RSP_OK "OK"
	G2C 3G device response for AT commands.

#define	G2C3G_RSP_ERROR "ERROR"

#define	G2C3G_RSP_DEVICE_READY "DEVICE READY"

#define	G2C3G_RSP_ERR "+ERR"

#define	G2C3G_RSP_ACT "+ACT"

#define	G2C3G_RSP_G2C3G "+G2C3G"

#define	G2C3G_RSP_G2C3G_RSP "+G2C3G_RSP"

#define	G2C3G_TX_DRV_BUFFER_SIZE 300
	G2C 3G driver buffer size.

#define	G2C3G_RX_DRV_BUFFER_SIZE 300

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

Enumerations
enum	g2c3g_return_value_t { G2C3G_OK = 0 , G2C3G_ERROR = -1 , G2C3G_ERROR_TIMEOUT = -2 , G2C3G_ERROR_CMD = -3 , G2C3G_ERROR_UNKNOWN = -4 }
	G2C 3G Click return value data. More...

Functions
void	g2c3g_cfg_setup (g2c3g_cfg_t *cfg)
	G2C 3G configuration object setup function.

err_t	g2c3g_init (g2c3g_t ctx, g2c3g_cfg_t cfg)
	G2C 3G initialization function.

err_t	g2c3g_generic_write (g2c3g_t ctx, uint8_t data_in, uint16_t len)
	G2C 3G data writing function.

err_t	g2c3g_generic_read (g2c3g_t ctx, uint8_t data_out, uint16_t len)
	G2C 3G data reading function.

void	g2c3g_set_cts_pin (g2c3g_t *ctx, uint8_t state)
	G2C 3G set cts pin function.

void	g2c3g_set_rst_pin (g2c3g_t *ctx, uint8_t state)
	G2C 3G set rst pin function.

uint8_t	g2c3g_get_gp0_pin (g2c3g_t *ctx)
	G2C 3G get gp0 pin function.

uint8_t	g2c3g_get_gp1_pin (g2c3g_t *ctx)
	G2C 3G get gp1 pin function.

uint8_t	g2c3g_get_rts_pin (g2c3g_t *ctx)
	G2C 3G get rts pin function.

void	g2c3g_reset_device (g2c3g_t *ctx)
	G2C 3G reset device function.

void	g2c3g_send_cmd (g2c3g_t ctx, uint8_t cmd)
	G2C 3G send command function.

void	g2c3g_send_cmd_with_par (g2c3g_t ctx, uint8_t at_cmd_buf, uint8_t *param_buf)
	G2C 3G send command function with parameter.

void	g2c3g_send_cmd_check (g2c3g_t ctx, uint8_t at_cmd_buf)
	G2C 3G check the sent command.

void	g2c3g_send_cmd_par_check (g2c3g_t ctx, uint8_t at_cmd_buf)
	G2C 3G check the command parameters.

void	g2c3g_set_net_creds (g2c3g_t ctx, uint8_t sim_apn, uint8_t username, uint8_t password)
	G2C 3G set network credentials.

void	g2c3g_set_broker_creds (g2c3g_t ctx, uint8_t dev_key, uint8_t *password)
	G2C 3G set broker credentials.

Detailed Description

This file contains API for G2C 3G Click Driver.

Enumeration Type Documentation

G2C 3G Click return value data.

Predefined enum values for driver return values.