aiwb212f.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 AIWB212F_H
#define AIWB212F_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 AIWB212F_CMD_AT                             "AT"
#define AIWB212F_CMD_AT_HELP                        "AT+HELP"
#define AIWB212F_CMD_AT_SW_RESET                    "AT+RST"
#define AIWB212F_CMD_AT_GMR                         "AT+GMR"
#define AIWB212F_CMD_AT_SLEEP                       "AT+SLEEP"
#define AIWB212F_CMD_AT_SYSIOMAP                    "AT+SYSIOMAP"
#define AIWB212F_CMD_AT_SYSGPIOWRITE                "AT+SYSGPIOWRITE"
#define AIWB212F_CMD_AT_SYSGPIOREAD                 "AT+SYSGPIOREAD"
#define AIWB212F_CMD_AT_PWMCFG                      "AT+PWMCFG"
#define AIWB212F_CMD_AT_PWMCFGS                     "AT+PWMCFGS"
#define AIWB212F_CMD_AT_PWMSTOP                     "AT+PWMSTOP"
#define AIWB212F_CMD_AT_PWMDUTYSET                  "AT+PWMDUTYSET"
#define AIWB212F_CMD_AT_PWMDUTYSETS                 "AT+PWMDUTYSETS"
#define AIWB212F_CMD_AT_WMODE                       "AT+WMODE"
#define AIWB212F_CMD_AT_WSCAN                       "AT+WSCAN"
#define AIWB212F_CMD_AT_WSDHCP                      "AT+WSDHCP"
#define AIWB212F_CMD_AT_WJAP                        "AT+WJAP"
#define AIWB212F_CMD_AT_WAUTOCONN                   "AT+WAUTOCONN"
#define AIWB212F_CMD_AT_WAPDHCP                     "AT+WAPDHCP"
#define AIWB212F_CMD_AT_WAP                         "AT+WAP"
#define AIWB212F_CMD_AT_PING                        "AT+PING"
#define AIWB212F_CMD_AT_CIPSTAMAC_DEF               "AT+CIPSTAMAC_DEF"
#define AIWB212F_CMD_AT_WCOUNTRY                    "AT+WCOUNTRY"
#define AIWB212F_CMD_AT_WCONFIG                     "AT+WCONFIG"
#define AIWB212F_CMD_AT_SOCKET                      "AT+SOCKET"
#define AIWB212F_CMD_AT_SOCKETSEND                  "AT+SOCKETSEND"
#define AIWB212F_CMD_AT_SOCKETSENDLINE              "AT+SOCKETSENDLINE"
#define AIWB212F_CMD_AT_SOCKETREAD                  "AT+SOCKETREAD"
#define AIWB212F_CMD_AT_SOCKETDEL                   "AT+SOCKETDEL"
#define AIWB212F_CMD_AT_SOCKETRECVCFG               "AT+SOCKETRECVCFG"
#define AIWB212F_CMD_AT_SOCKETTT                    "AT+SOCKETTT"
#define AIWB212F_CMD_AT_MQTT                        "AT+MQTT"
#define AIWB212F_CMD_AT_MQTTPUB                     "AT+MQTTPUB"
#define AIWB212F_CMD_AT_MQTTPUBRAW                  "AT+MQTTPUBRAW"
#define AIWB212F_CMD_AT_MQTTSUB                     "AT+MQTTSUB"
#define AIWB212F_CMD_AT_BLEMAC                      "AT+BLEMAC"
#define AIWB212F_CMD_AT_BLEMODE                     "AT+BLEMODE"
#define AIWB212F_CMD_AT_BLERFPWR                    "AT+BLERFPWR"
#define AIWB212F_CMD_AT_BLENAME                     "AT+BLENAME"
 
#define AIWB212F_RSP_OK                             "OK"
#define AIWB212F_RSP_ERROR                          "ERROR"
#define AIWB212F_RSP_READY                          "ready"
 
#define AIWB212F_TX_DRV_BUFFER_SIZE                 100
#define AIWB212F_RX_DRV_BUFFER_SIZE                 300
 
 // aiwb212f_cmd
 
#define AIWB212F_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_RST )
 
 // aiwb212f_map
 // aiwb212f
 
typedef struct
{
    // Output pins
    digital_out_t en;                                       
    // Modules
    uart_t uart;                                            
    // Buffers
    uint8_t uart_rx_buffer[ AIWB212F_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ AIWB212F_TX_DRV_BUFFER_SIZE ];  
} aiwb212f_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;                          
    pin_name_t tx_pin;                          
    // Additional gpio pins
    pin_name_t en;                              
    // 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;                  
} aiwb212f_cfg_t;
 
typedef enum
{
    AIWB212F_OK = 0,
    AIWB212F_ERROR = -1,
    AIWB212F_ERROR_TIMEOUT = -2,
    AIWB212F_ERROR_CMD = -3,
    AIWB212F_ERROR_UNKNOWN = -4
 
} aiwb212f_return_value_t;
 
void aiwb212f_cfg_setup ( aiwb212f_cfg_t *cfg );
 
err_t aiwb212f_init ( aiwb212f_t *ctx, aiwb212f_cfg_t *cfg );
 
err_t aiwb212f_default_cfg ( aiwb212f_t *ctx );
 
err_t aiwb212f_generic_write ( aiwb212f_t *ctx, uint8_t *data_in, uint16_t len );
 
err_t aiwb212f_generic_read ( aiwb212f_t *ctx, uint8_t *data_out, uint16_t len );
 
void aiwb212f_hw_reset ( aiwb212f_t *ctx );
 
void aiwb212f_send_cmd ( aiwb212f_t *ctx, uint8_t *at_cmd_buf );
 
void aiwb212f_send_cmd_with_par ( aiwb212f_t *ctx, uint8_t *at_cmd_buf, uint8_t *param_buf );
 
void aiwb212f_send_cmd_check ( aiwb212f_t *ctx, uint8_t *at_cmd_buf );
 
void aiwb212f_set_gpio ( aiwb212f_t *ctx, uint8_t *pin, uint8_t *state );
 
#ifdef __cplusplus
}
#endif
#endif // AIWB212F_H
 
 // aiwb212f
 
// ------------------------------------------------------------------------ END