aws_wifi.h

Go to the documentation of this file.

/*
 * FreeRTOS
 * Copyright (C) 2017 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * 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.
 *
 * http://aws.amazon.com/freertos
 * http://www.FreeRTOS.org
 */


#ifndef _AWS_WIFI_H_
#define _AWS_WIFI_H_

#include <stdint.h>

/* FreeRTOS include for BaseType_t. */
#include "portmacro.h"

/* Wi-Fi configuration includes. */
#include "aws_wifi_config.h"

typedef enum
{
    eWiFiSuccess = 0,      
    eWiFiFailure = 1,      
    eWiFiTimeout = 2,      
    eWiFiNotSupported = 3, 
} WIFIReturnCode_t;

typedef enum
{
    eWiFiSecurityOpen = 0, 
    eWiFiSecurityWEP,      
    eWiFiSecurityWPA,      
    eWiFiSecurityWPA2,     
    eWiFiSecurityNotSupported   
} WIFISecurity_t;

typedef enum
{
    eWiFiModeStation = 0, 
    eWiFiModeAP,          
    eWiFiModeP2P,         
    eWiFiModeNotSupported 
} WIFIDeviceMode_t;

typedef enum
{
    eWiFiPMNormal = 0,  
    eWiFiPMLowPower,    
    eWiFiPMAlwaysOn,    
    eWiFiPMNotSupported 
} WIFIPMMode_t;

typedef struct
{
    const char * pcSSID;      
    uint8_t ucSSIDLength;     
    const char * pcPassword;  
    uint8_t ucPasswordLength; 
    WIFISecurity_t xSecurity; 
    int8_t cChannel;          
} WIFINetworkParams_t;

typedef struct
{
    char cSSID[ wificonfigMAX_SSID_LEN + 1 ];   
    uint8_t ucBSSID[ wificonfigMAX_BSSID_LEN ]; 
    WIFISecurity_t xSecurity;                   
    int8_t cRSSI;                               
    int8_t cChannel;                            
    uint8_t ucHidden;                           
} WIFIScanResult_t;

typedef struct
{
    char cSSID[ wificonfigMAX_SSID_LEN + 1 ];           
    uint8_t ucSSIDLength;                               
    uint8_t ucBSSID[ wificonfigMAX_BSSID_LEN ];         
    char cPassword[ wificonfigMAX_PASSPHRASE_LEN + 1 ]; 
    uint8_t ucPasswordLength;                           
    WIFISecurity_t xSecurity;                           
} WIFINetworkProfile_t;

WIFIReturnCode_t WIFI_On( void );

WIFIReturnCode_t WIFI_Off( void );

WIFIReturnCode_t WIFI_ConnectAP( const WIFINetworkParams_t * const pxNetworkParams );

WIFIReturnCode_t WIFI_Disconnect( void );

WIFIReturnCode_t WIFI_Reset( void );

WIFIReturnCode_t WIFI_SetMode( WIFIDeviceMode_t xDeviceMode );

WIFIReturnCode_t WIFI_GetMode( WIFIDeviceMode_t * pxDeviceMode );

WIFIReturnCode_t WIFI_NetworkAdd( const WIFINetworkProfile_t * const pxNetworkProfile,
                                  uint16_t * pusIndex );


WIFIReturnCode_t WIFI_NetworkGet( WIFINetworkProfile_t * pxNetworkProfile,
                                  uint16_t usIndex );

WIFIReturnCode_t WIFI_NetworkDelete( uint16_t usIndex );

WIFIReturnCode_t WIFI_Ping( uint8_t * pucIPAddr,
                            uint16_t usCount,
                            uint32_t ulIntervalMS );

WIFIReturnCode_t WIFI_GetIP( uint8_t * pucIPAddr );

WIFIReturnCode_t WIFI_GetMAC( uint8_t * pucMac );

WIFIReturnCode_t WIFI_GetHostIP( char * pcHost,
                                 uint8_t * pucIPAddr );

WIFIReturnCode_t WIFI_Scan( WIFIScanResult_t * pxBuffer,
                            uint8_t ucNumNetworks );

WIFIReturnCode_t WIFI_StartAP( void );

WIFIReturnCode_t WIFI_StopAP( void );

WIFIReturnCode_t WIFI_ConfigureAP( const WIFINetworkParams_t * const pxNetworkParams );

WIFIReturnCode_t WIFI_SetPMMode( WIFIPMMode_t xPMModeType,
                                 const void * pvOptionValue );

WIFIReturnCode_t WIFI_GetPMMode( WIFIPMMode_t * pxPMModeType,
                                 void * pvOptionValue );


BaseType_t WIFI_IsConnected( void );

#endif /* _AWS_WIFI_H_ */