wifi11.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 WIFI11_H
#define WIFI11_H
 
#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"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define WIFI11_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
  cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
  cfg.en      = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.gp1     = MIKROBUS( mikrobus, MIKROBUS_INT ); \
  cfg.cs      = MIKROBUS( mikrobus, MIKROBUS_CS )
#define WIFI11_RETVAL  uint8_t
 
#define WIFI11_OK           0x00
#define WIFI11_INIT_ERROR   0xFF
#define WIFI11_CMD_AT          "AT"             // Test AT command ready
#define WIFI11_CMD_ATS         "ATS?"           // List all AT command
#define WIFI11_CMD_ATSR        "ATSR"           // Restart module
#define WIFI11_CMD_ATSV        "ATSV"           // Query version info
#define WIFI11_CMD_ATSP        "ATSP"           // Set power saving mode
#define WIFI11_CMD_ATSE        "ATSE"           // Set AT command echo mode
#define WIFI11_CMD_ATSY        "ATSY"           // Factory Reset
#define WIFI11_CMD_ATSU        "ATSU"           // UART configuration
#define WIFI11_CMD_ATSW        "ATSW"           // Start Webserver
#define WIFI11_CMD_ATSO        "ATSO"           // OTA upgrade
#define WIFI11_CMD_ATSC        "ATSC"           // Choose Activated Image
#define WIFI11_CMD_ATSG        "ATSG"           // GPIO control
#define WIFI11_CMD_ATPW        "ATPW"           // Set WiFi mode
#define WIFI11_CMD_ATPN        "ATPN"           // Connect to AP (STA mode)
#define WIFI11_CMD_ATWD        "ATWD"           // Disconnect from AP
#define WIFI11_CMD_ATWS        "ATWS"           // Scan AP
#define WIFI11_CMD_ATPA        "ATPA"           // Set AP mode
#define WIFI11_CMD_ATW         "ATW?"           // Wifi information
#define WIFI11_CMD_ATPH        "ATPH"           // Set DHCP mode
#define WIFI11_CMD_ATPE        "ATPE"           // Set static IP for STA
#define WIFI11_CMD_ATPF        "ATPF"           // Set static IP for AP, and DHCP rule
#define WIFI11_CMD_ATPG        "ATPG"           // Set Auto connect
#define WIFI11_CMD_ATPM        "ATPM"           // Set MAC address
#define WIFI11_CMD_ATWQ        "ATWQ"           // Start simple config
#define WIFI11_CMD_ATP0        "ATP0"           // Get LWIP errno
#define WIFI11_CMD_ATPS        "ATPS"           // Create TCP/UDP Server
#define WIFI11_CMD_ATPC        "ATPC"           // Create TCP/UDP Client
#define WIFI11_CMD_ATPD        "ATPD"           // Close TCP or UDP connection
#define WIFI11_CMD_ATPT        "ATPT"           // Send data
#define WIFI11_CMD_ATPR        "ATPR"           // Receive data
#define WIFI11_CMD_ATPK        "ATPK"           // Set auto receive data mode
#define WIFI11_CMD_ATPI        "ATPI"           // Check network connection status
#define WIFI11_CMD_ATPP        "ATPP"           // PING Command
#define WIFI11_CMD_ATPU        "ATPU"           // Set transparent transmission mode
#define WIFI11_CMD_ATPL        "ATPL"           // Save translink and enable autolink
#define WIFI11_TCP_MODE         0
#define WIFI11_UDP_MODE         1
#define DRV_RX_BUFFER_SIZE 500
#define DRV_TX_BUFFER_SIZE 500
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t en;
    digital_out_t cs;
    digital_out_t gp1;
    
    // Modules 
 
    uart_t uart;
 
    char uart_rx_buffer[ DRV_RX_BUFFER_SIZE ];
    char uart_tx_buffer[ DRV_TX_BUFFER_SIZE ];
 
} wifi11_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t rx_pin;
    pin_name_t tx_pin;
    
    // Additional gpio pins 
 
    pin_name_t en;
    pin_name_t cs;
    pin_name_t gp1;
 
    // static variable 
 
    uint32_t          baud_rate;     // Clock speed.
    bool              uart_blocking;
    uart_data_bits_t  data_bit;      // Data bits.
    uart_parity_t     parity_bit;    // Parity bit.  
    uart_stop_bits_t  stop_bit;      // Stop bits.   
 
} wifi11_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void wifi11_cfg_setup ( wifi11_cfg_t *cfg );
 
WIFI11_RETVAL wifi11_init ( wifi11_t *ctx, wifi11_cfg_t *cfg );
 
void wifi11_generic_write ( wifi11_t *ctx, char *data_buf, uint16_t len );
 
int32_t wifi11_generic_read ( wifi11_t *ctx, char *data_buf, uint16_t max_len );
 
void wifi11_reset_device ( wifi11_t *ctx );
 
void wifi11_send_cmd ( wifi11_t *ctx, char *cmd );
 
void wifi11_send_cmd_with_parameter ( wifi11_t *ctx, char *at_cmd_buf, char *param_buf );
 
void wifi11_connect_to_ap ( wifi11_t *ctx, char *ssid, char *password );
 
void wifi11_create_tcp_udp_server ( wifi11_t *ctx, uint8_t mode, uint16_t port );
 
#ifdef __cplusplus
}
#endif
#endif  // _WIFI11_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END