This file contains API for ESP8684 Click Driver. More...

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

Data Structures
struct	esp8684_t
	ESP8684 Click context object. More...

struct	esp8684_cfg_t
	ESP8684 Click configuration object. More...

Macros
#define	ESP8684_CMD_AT "AT"
	ESP8684 control commands.

#define	ESP8684_CMD_RST "AT+RST"

#define	ESP8684_CMD_GMR "AT+GMR"

#define	ESP8684_CMD_CWINIT "AT+CWINIT"

#define	ESP8684_CMD_CWMODE "AT+CWMODE"

#define	ESP8684_CMD_CWJAP "AT+CWJAP"

#define	ESP8684_CMD_CWLAP "AT+CWLAP"

#define	ESP8684_CMD_CWAP "AT+CWQAP"

#define	ESP8684_CMD_CWSAP "AT+CWSAP"

#define	ESP8684_CMD_CWLIF "AT+CWLIF"

#define	ESP8684_CMD_CIPSTATE "AT+CIPSTATE"

#define	ESP8684_CMD_CIPSTART "AT+CIPSTART"

#define	ESP8684_CMD_CIPMODE "AT+CIPMODE"

#define	ESP8684_CMD_CIPSEND "AT+CIPSEND"

#define	ESP8684_CMD_CIPCLOSE "AT+CIPCLOSE"

#define	ESP8684_CMD_CIFSR "AT+CIFSR"

#define	ESP8684_CMD_CIPMUX "AT+CIPMUX"

#define	ESP8684_CMD_CIPSERVER "AT+CIPSERVER"

#define	ESP8684_CMD_CIPSTO "AT+CIPSTO"

#define	ESP8684_CMD_CIPRECVMODE "AT+CIPRECVMODE"

#define	ESP8684_RSP_RECEIVE "+IPD"
	ESP8684 commands response.

#define	ESP8684_READY_FOR_SEND ">"

#define	ESP8684_RSP_OK "OK"

#define	ESP8684_RSP_SEND_OK "SEND OK"

#define	ESP8684_RSP_ERROR "ERROR"

#define	ESP8684_RSP_READY "ready"

#define	ESP8684_PIN_STATE_HIGH 0x01
	ESP8684 pin state.

#define	ESP8684_PIN_STATE_LOW 0x00

#define	ESP8684_TX_DRV_BUFFER_SIZE 100
	ESP8684 driver buffer size.

#define	ESP8684_RX_DRV_BUFFER_SIZE 300

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

Enumerations
enum	esp8684_return_value_t { ESP8684_OK = 0 , ESP8684_ERROR = -1 , ESP8684_OVERFLOW = -2 , ESP8684_TIMEOUT = -3 }
	ESP8684 Click return value data. More...

Functions
void	esp8684_cfg_setup (esp8684_cfg_t *cfg)
	ESP8684 configuration object setup function.

err_t	esp8684_init (esp8684_t ctx, esp8684_cfg_t cfg)
	ESP8684 initialization function.

void	esp8684_default_cfg (esp8684_t *ctx)
	ESP8684 default configuration function.

err_t	esp8684_generic_write (esp8684_t ctx, uint8_t data_in, uint16_t len)
	ESP8684 data writing function.

err_t	esp8684_generic_read (esp8684_t ctx, uint8_t data_out, uint16_t len)
	ESP8684 data reading function.

void	esp8684_set_rst_pin (esp8684_t *ctx, uint8_t pin_state)
	ESP8684 set rst pin state function.

void	esp8684_set_bt_pin (esp8684_t *ctx, uint8_t pin_state)
	ESP8684 set bt pin state function.

void	esp8684_set_rts_pin (esp8684_t *ctx, uint8_t pin_state)
	ESP8684 set rts pin state function.

uint8_t	esp8684_get_cts_pin (esp8684_t *ctx)
	ESP8684 get cts pin state function.

void	esp8684_send_cmd (esp8684_t ctx, uint8_t cmd, uint8_t *args)
	ESP8684 send command with arguments function.

void	esp8684_send_query_cmd (esp8684_t ctx, uint8_t cmd)
	ESP8684 send query command function.

void	esp8684_send_test_cmd (esp8684_t ctx, uint8_t cmd)
	ESP8684 test query command function.

void	esp8684_connect_to_network (esp8684_t ctx, uint8_t ssid, uint8_t *password)
	ESP8684 connect to network function.

void	esp8684_connect_for_trans (esp8684_t ctx, uint8_t type, uint8_t link_id, uint8_t remote_host, uint8_t *remote_port)
	ESP8684 connect to remote host function.

Detailed Description

This file contains API for ESP8684 Click Driver.

Enumeration Type Documentation

ESP8684 Click return value data.

Predefined enum values for driver return values.