lpwifi.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 LPWIFI_H
#define LPWIFI_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 LPWIFI_CMD_AT            "AT"
#define LPWIFI_CMD_ATZ           "ATZ"
#define LPWIFI_CMD_ATE           "ATE"
#define LPWIFI_CMD_ATF           "ATF"
 
#define LPWIFI_CMD_WFMODE        "AT+WFMODE"
#define LPWIFI_CMD_WFJAPA        "AT+WFJAPA"
 
#define LPWIFI_CMD_TRTS          "AT+TRTS"
#define LPWIFI_CMD_TRUSE         "AT+TRUSE"
 
#define LPWIFI_CMD_PWMINIT       "AT+PWMINIT"
#define LPWIFI_CMD_PWMSTART      "AT+PWMSTART"
#define LPWIFI_CMD_PWMSTOP       "AT+PWMSTOP"
 
#define LPWIFI_CMD_I2CINIT       "AT+I2CINIT"
#define LPWIFI_CMD_I2CREAD       "AT+I2CREAD"
#define LPWIFI_CMD_I2CWRITE      "AT+I2CWRITE"
 
 // lpwifi_reg
 
#define LPWIFI_MODE_STA          0
#define LPWIFI_MODE_SOFT_AP      1
 
#define DRV_BUFFER_SIZE          400
 
 // lpwifi_set
 
#define LPWIFI_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.wkp = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // lpwifi_map
 // lpwifi
 
typedef struct
{
    // Output pins
 
    digital_out_t wkp;                              
    digital_out_t cs;                               
    // Input pins
 
    digital_in_t  int_pin;                          
    // Modules
 
    uart_t uart;                                    
    // Buffers
 
    char uart_rx_buffer[ DRV_BUFFER_SIZE ];         
    char uart_tx_buffer[ DRV_BUFFER_SIZE ];         
} lpwifi_t;
 
typedef struct
{
    // Communication gpio pins
 
    pin_name_t rx_pin;                              
    pin_name_t tx_pin;                              
    // Additional gpio pins
 
    pin_name_t wkp;                                 
    pin_name_t int_pin;                             
    pin_name_t cs;                                  
    // 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;                     
} lpwifi_cfg_t;
 
typedef enum
{
    LPWIFI_OK = 0,
    LPWIFI_ERROR = -1
 
} lpwifi_return_value_t;
 
void lpwifi_cfg_setup ( lpwifi_cfg_t *cfg );
 
err_t lpwifi_init ( lpwifi_t *ctx, lpwifi_cfg_t *cfg );
 
void lpwifi_default_cfg ( lpwifi_t *ctx );
 
err_t lpwifi_generic_write ( lpwifi_t *ctx, char *data_buf, uint16_t len );
 
err_t lpwifi_generic_read ( lpwifi_t *ctx, char *data_buf, uint16_t max_len );
 
void lpwifi_factory_reset_device ( lpwifi_t *ctx );
 
void lpwifi_send_cmd ( lpwifi_t *ctx, char *cmd );
 
void lpwifi_send_cmd_with_parameter ( lpwifi_t *ctx, char *at_cmd_buf, char *param_buf );
 
void lpwifi_send_cmd_check ( lpwifi_t *ctx, char *at_cmd_buf );
 
void lpwifi_connect_to_ap ( lpwifi_t *ctx, char *ssid, char *password );
 
void lpwifi_set_wifi_mode ( lpwifi_t *ctx, uint8_t mode );
 
void lpwifi_create_tcp_server ( lpwifi_t *ctx, uint16_t port );
 
void lpwifi_create_udp_socket ( lpwifi_t *ctx, uint16_t port );
 
#ifdef __cplusplus
}
#endif
#endif // LPWIFI_H
 
 // lpwifi
 
// ------------------------------------------------------------------------ END