esp8684.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef ESP8684_H
#define ESP8684_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"
 
#define ESP8684_CMD_AT                              "AT"
#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"
#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
#define ESP8684_PIN_STATE_LOW                       0x00
 
 
#define ESP8684_TX_DRV_BUFFER_SIZE    100
#define ESP8684_RX_DRV_BUFFER_SIZE    300
 
 // esp8684_cmd
 
#define ESP8684_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.bt = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.rts = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.cts = MIKROBUS( mikrobus, MIKROBUS_INT );
 
 // esp8684_map
 // esp8684
 
typedef struct
{
    // Output pins
    digital_out_t bt;       
    digital_out_t rst;      
    digital_out_t rts;       
    // Input pins
    digital_in_t cts;       
    // Modules
    uart_t uart;            
    // Buffers
    uint8_t uart_rx_buffer[ ESP8684_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ ESP8684_TX_DRV_BUFFER_SIZE ];  
} esp8684_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                          
    pin_name_t tx_pin;                          
    // Additional gpio pins
    pin_name_t bt;                              
    pin_name_t rst;                             
    pin_name_t rts;                             
    pin_name_t cts;                             
    // Static variable
    uint32_t         baud_rate;                 
    bool             uart_blocking;             
    uart_data_bits_t data_bit;                  
    uart_parity_t    parity_bit;                
    uart_stop_bits_t stop_bit;                  
} esp8684_cfg_t;
 
typedef enum
{
    ESP8684_OK = 0,
    ESP8684_ERROR = -1,
    ESP8684_OVERFLOW = -2,
    ESP8684_TIMEOUT = -3
 
} esp8684_return_value_t;
 
void esp8684_cfg_setup ( esp8684_cfg_t *cfg );
 
err_t esp8684_init ( esp8684_t *ctx, esp8684_cfg_t *cfg );
 
void esp8684_default_cfg ( esp8684_t *ctx );
 
err_t esp8684_generic_write ( esp8684_t *ctx, uint8_t *data_in, uint16_t len );
 
err_t esp8684_generic_read ( esp8684_t *ctx, uint8_t *data_out, uint16_t len );
 
void esp8684_set_rst_pin ( esp8684_t *ctx, uint8_t pin_state );
 
void esp8684_set_bt_pin ( esp8684_t *ctx, uint8_t pin_state );
 
void esp8684_set_rts_pin ( esp8684_t *ctx, uint8_t pin_state );
 
uint8_t esp8684_get_cts_pin ( esp8684_t *ctx );
 
void esp8684_send_cmd ( esp8684_t *ctx, uint8_t *cmd, uint8_t *args );
 
void esp8684_send_query_cmd ( esp8684_t *ctx, uint8_t *cmd );
 
void esp8684_send_test_cmd ( esp8684_t *ctx, uint8_t *cmd );
 
void esp8684_connect_to_network ( esp8684_t* ctx, uint8_t *ssid, uint8_t *password );
 
void esp8684_connect_for_trans ( esp8684_t* ctx, uint8_t *type, uint8_t *link_id, uint8_t *remote_host, uint8_t *remote_port );
 
#ifdef __cplusplus
}
#endif
#endif // ESP8684_H
 
 // esp8684
 
// ------------------------------------------------------------------------ END